author | Edward Pilatowicz <edward.pilatowicz@oracle.com> |
Mon, 16 Sep 2013 21:26:31 -0700 | |
changeset 2945 | 24196b483cc6 |
parent 1923 | 8d42b7caa49d |
permissions | -rw-r--r-- |
1923
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
1 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
2 |
Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
3 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
4 |
README.guide |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
5 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
6 |
0. Format |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
7 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
8 |
We're writing the Developer Guide in reStructured Text. Once we're |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
9 |
happy with the content, we'll output XML and convert that to |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
10 |
DocBook-XML to hand over to Documentation for final production. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
11 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
12 |
Heading in rST are based on over- and underlining. Heading levels |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
13 |
are a document-specific convention; our levels are as follows: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
14 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
15 |
==== ---- |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
16 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
17 |
==== , ---- , ==== , ---- , ~~~~, ````, ^^^^ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
18 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
19 |
Inconsistencies with this ordering will lead to document build |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
20 |
failure. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
21 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
22 |
1. Files |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
23 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
24 |
guide-main.rst is the Developer Guide's outline. It contains the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
25 |
main document directives; it may also contain shorter sections, |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
26 |
prior to being broken out into separate files. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
27 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
28 |
Each file should begin with its appropriate heading for the Guide as |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
29 |
a whole. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
30 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
31 |
1.1. Titles |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
32 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
33 |
Titles are always mixed case. Particular levels may be set in |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
34 |
capitals or small capitals by style sheet. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
35 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
36 |
2. Rest of the directory |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
37 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
38 |
Files not starting with guide- are legacy documents from earlier in |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
39 |
the project. If you are rewriting one of these to fit into the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
40 |
Guide, please rename them; if you don't feel you're the owner, |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
41 |
extract the content, and add an "XXX Copied to guide-....rst" in the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
42 |
original file. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
43 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
44 |
3. Tools |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
45 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
46 |
You can obtain docutils by using easy_install via |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
47 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
48 |
$ pfexec easy_install docutils |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
49 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
50 |
With a straight docutils installation, you can build the "html" |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
51 |
target out of the Makefile. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
52 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
53 |
To build the PDF version, you will need a pdflatex-capable TeX |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
54 |
installation, such as TeX Live, which is available for download at |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
55 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
56 |
http://www.tug.org/texlive/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
57 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
58 |
The Makefile and docutils expect that the TeX executables are |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
59 |
available via the path. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
60 |