Index: openacs-4/packages/acs-core-docs/www/docbook-primer.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.html,v diff -u -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 2 Feb 2002 03:47:32 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 3 Mar 2002 01:27:08 -0000 1.4 @@ -31,7 +31,7 @@
ArsDigita created a good documentation ground for us to build upon. Some sections of the documentation however, lack details @@ -74,7 +74,7 @@ In order to separate content and presentation, all OpenACS documentation will be marked up to conform to the DocBook XML DTD - + This enables us to publish in a variety of formats and relieves each contributor of the burden of presentation, freeing him to focus on content and sharing knowledge. @@ -97,7 +97,7 @@ list 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: - +
@@ -173,7 +173,7 @@ The documentation for each package will make up a little "book" that is structured like this - examples are emphasized: - +
@@ -205,13 +205,13 @@- + 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 the section called “Links”). @@ -220,7 +220,7 @@ 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.
@@ -238,7 +238,7 @@ </sect1>
- + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel @@ -253,7 +253,7 @@
- + For displaying a snippet of code, a filename or anything else you just want to appear as a part of a sentence, we will use the tag <computeroutput>. @@ -269,7 +269,7 @@
- + Linking falls into two different categories: inside the book you're making and outside:
-Check out how I link to a subsection of the Developer's Guide:
+Check out how I link to a subsection of the Developer's Guide:Put this in your XML: @@ -331,7 +331,7 @@
- + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different @@ -365,7 +365,7 @@
- + To insert a graphic we use the elements <mediaobject>, <imageobject>, @@ -398,7 +398,7 @@
- + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -534,7 +534,7 @@
- + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one - <emphasis>.
@@ -663,7 +663,7 @@