| Prev | Chapter 13. Documentation Standards | Next |
|---|
-======= -
->>>>>>> 1.50 +
By Claus Rasmussen, with additions by Roberto Mello, Vinod Kurup, and the OpenACS Community
OpenACS documentation development is subject to the constraints of the software project development and release -<<<<<<< docbook-primer.html - methods and cycles (???). -======= methods and cycles (Using CVS with OpenACS). ->>>>>>> 1.50 Essentially, all phases of work may be active to accommodate the asynchronous nature of multiple subprojects evolving by the efforts of a global base of participants with culturally @@ -587,11 +578,7 @@ DTD. The remaining discussion is about publishing using Docbook.
-<<<<<<< docbook-primer.html - -======= - ->>>>>>> 1.50 + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:
@@ -653,15 +640,9 @@ list of elements and use more exotic features in your documents. The list is made up of SGML-elements but basically -<<<<<<< docbook-primer.html - the same elements are valid in the XML DTD as long as you remember to: - -
-======= the same elements are valid in the XML DTD as long as you remember to: - +
->>>>>>> 1.50 Always close your tags with corresponding end-tags and to not use other tag minimization
@@ -709,11 +690,7 @@ The documentation for each package will make up a little "book" that is structured like this - examples are emphasized: -<<<<<<< docbook-primer.html - -======= - ->>>>>>> 1.50 +
book : Docs for one package - templating
@@ -736,43 +713,23 @@
and we will provide a set of templates for documenting an entire package. For now you can take a look at the
sources of these DocBook documents
to get an idea of how they are tied together.
-<<<<<<< docbook-primer.html
-
- - Given that your job starts at the sect1-level, all your documents should open with a - <sect1>-tag and end - with the corresponding </sect1>. -
- - You need to feed every <sect1> two attributes. The first attribute, - id, is standard and can be used with all elements. It comes in very - handy when interlinking between documents (more about this when talking about links in Section , “Links”). - The value of id has to be unique - throughout the book you're making since the id's in your - sect1's will turn into filenames when the book is parsed into HTML. -
- - The other attribute is xreflabel. The value of this is the text that will appear - as the link when referring to this sect1. -=======
-
+
Given that your job starts at the sect1-level, all your documents should open with a
<sect1>-tag and end
with the corresponding </sect1>.
-
+
You need to feed every <sect1> two attributes. The first attribute,
id, is standard and can be used with all elements. It comes in very
handy when interlinking between documents (more about this when talking about links in Links).
The value of id has to be unique
throughout the book you're making since the id's in your
sect1's will turn into filenames when the book is parsed into HTML.
-
+
The other attribute is xreflabel. The value of this is the text that will appear
as the link when referring to this sect1.
->>>>>>> 1.50
Right after the opening tag you put the title of the document - this is usually the same as
xreflabel-attribute. E.g. the top level of the document you're
@@ -785,26 +742,16 @@
</sect1>
-<<<<<<< docbook-primer.html
-
-=======
-
->>>>>>> 1.50
+
Inside this container your document will be split up into
<sect2>'s,
each with the same requirements - id and xreflabel
attributes, and a <title>-tag inside. Actually, the xreflabel is never required in sections, but it makes linking to that section a lot easier.
When it comes to naming your -<<<<<<< docbook-primer.html - sect2's and below, prefix them with some abbreviation of the id in the sect1 such as requirements-overview. -
-
-=======
sect2's and below, prefix them with some abbreviation of the id in the sect1 such as requirements-overview.
-
->>>>>>> 1.50
+
For displaying a snippet of code, a filename or anything else you just want to appear as a part of
a sentence, we use
<computeroutput>
@@ -818,28 +765,16 @@
<programlisting> is used. Just wrap your code block in it; mono-spacing, indents and all that stuff is taken care of
automatically.
For expressing user interaction via a terminal window, we wrap -<<<<<<< docbook-primer.html - the <screen> - tag around text that has been wrapped by combinations of <computeroutput> - and <userinput> -
-
-=======
the <screen>
tag around text that has been wrapped by combinations of <computeroutput>
and <userinput>
- ->>>>>>> 1.50 + Linking falls into two different categories: inside the book you're making and outside:
By having unique id's you can cross-reference any part of your book
with a simple tag, regardless of where that part is.
-<<<<<<< docbook-primer.html
-
Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
-======= -Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
->>>>>>> 1.50 +Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
- Find information about creating a package in <xref linkend="packages-making-a-package"></xref>.And the output is:
@@ -862,13 +797,8 @@ Note that since I haven't provided anxreflabelfor the subsection,packages-looks, the parser will try its best to explain where the link takes you. -<<<<<<< docbook-primer.html -
- ->>>>>>> 1.50 + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different @@ -889,11 +819,7 @@ for you.
-<<<<<<< docbook-primer.html
-
-=======
-
->>>>>>> 1.50
+
To insert a graphic we use the elements
<mediaobject>,
<imageobject>,
@@ -918,13 +844,8 @@
Put your graphics in a separate directory ("images") and link to them only with relative paths. -<<<<<<< docbook-primer.html -
- ->>>>>>> 1.50 + Here's how you make the DocBook equivalent of the three usual HTML-lists:
Making an unordered list is pretty much like doing the same thing in HTML - if you close your <li>, that is. The only differences are that each list item has to be wrapped in something more, such as
@@ -968,13 +889,8 @@
</varlistentry>
</variablelist>
-<<<<<<< docbook-primer.html
-
-
->>>>>>> 1.50
+
DocBook supports several types of tables, but in most cases, the
<informaltable>
is enough:
@@ -1010,13 +926,8 @@
If you want cells to span more than one row or column, it gets a bit more complicated - check out
<table>
for an example.
-<<<<<<< docbook-primer.html
-
-
->>>>>>> 1.50
+
Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one -
<emphasis>.
@@ -1070,13 +981,8 @@ to PSGML Mode. nXML Mode can validate a file as it is edited.
David Lutterkort -<<<<<<< docbook-primer.html - wrote an intro to the PSGML Mode in Emacs -
-======= wrote an intro to the PSGML Mode in Emacs
->>>>>>> 1.50 James Clark's free Java parser XP. Note that this does not validate XML, only parses it. @@ -1097,8 +1003,4 @@ script with directions (now via archive.org) that gets you most of the way. -<<<<<<< docbook-primer.html