- is a publishing standard based on XML + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:
It is open-source.
A growing community surrounds DocBook (has mailing lists)
A number of free and commercial tools are available for editing and publishing DocBook @@ -449,7 +449,7 @@ of elements and use more exotic features in your documents. The list is made up of SGML-elements but basically the same elements are valid in the XML DTD as long as -you remember to: +you remember to:
Always close your tags with corresponding end-tags and to not use other tag @@ -483,15 +483,15 @@ not writing something that someone else is already writing. Also, if you desire to use the OpenACS CVS repository, please e-mail the gatekeeper in charge of documentation.
You can look at some templates for documents (in Docbook XML) in -the sources for acs-core-docs, especially the +the sources for acs-core-docs, especially the Detailed Design Documentation Template and the System/Application Requirements Template.
The documentation for each package will make up a little "book" that is structured like this - examples are -emphasized: +emphasized:
book : Docs for one package - templating
|
@@ -511,16 +511,16 @@
tied together in a top-level document that contains all the
information above the line. This will be explained in more detail
in a later document, 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
+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.
- Given that your job starts at the
+ 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
+ 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
@@ -529,7 +529,7 @@
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
+ The other attribute is xreflabel. The value of this is the text
that will appear as the link when referring to this sect1.
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 reading right now looks like this:
@@ -540,7 +540,7 @@ </sect1>
- Inside this container your document will
+ 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
@@ -550,7 +550,7 @@
- For displaying a snippet of code, a
+ 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> and <code> tags. These
replace the HTML-tag <code> tag,
@@ -564,15 +564,15 @@
- Linking falls into two different + 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.
-Check out how I link to a subsection of +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>. @@ -596,7 +596,7 @@
- If you're hyper-linking out of the
+ If you're hyper-linking out of the
documentation, it works almost the same way as HTML - the tag is
just a little different (<ulink>):
<ulink url="http://www.oracle.com/">Oracle Corporation</ulink> @@ -615,7 +615,7 @@ Note: The graphics guidelines are not written in stone. Use another valid approach if it works better for you.- To insert a graphic we use the elements + To insert a graphic we use the elements
<mediaobject>,<imageobject>,<imagedata>, @@ -640,7 +640,7 @@
- Here's how you make the DocBook + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- DocBook supports several types of tables,
+ DocBook supports several types of tables,
but in most cases, the <informaltable> is enough:
<informaltable frame="all"> <tgroup cols="3"> @@ -739,7 +739,7 @@
- Our documentation uses two flavors of
+ Our documentation uses two flavors of
emphasis - italics and bold type. DocBook uses one - <emphasis>.
The <emphasis> tag
defaults to italics when parsed. If you're looking for
emphasizing with bold type, use <emphasis
@@ -772,7 +772,7 @@
each <chapter>, <sect1> or <appendix> tag, use
the following command:
bash$xsltproc /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/html/chunk.xsl filename.xml-
You could also look at the acs-core-docs Makefile for examples of how these +
You could also look at the acs-core-docs Makefile for examples of how these documents are generated.