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 -N -r1.55 -r1.56 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 29 Mar 2018 17:28:50 -0000 1.55 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 25 Apr 2018 08:38:27 -0000 1.56 @@ -674,7 +674,7 @@ Docbook.
- + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:
@@ -743,7 +743,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: - +
-
+
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”).
@@ -879,7 +879,7 @@
-
+
The other attribute is xreflabel
. The value of this is the text that will appear
as the link when referring to this sect1
.
-
+
Inside this container your document will be split up into
<sect2>
's,
each with the same requirements - id
and xreflabel
@@ -920,7 +920,7 @@
-
+
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>
@@ -948,7 +948,7 @@
- + Linking falls into two different categories: inside the book you're making and outside:
@@ -958,7 +958,7 @@ with a simple tag, regardless of where that part is. -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:
@@ -1015,7 +1015,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 @@ -1051,7 +1051,7 @@
-
+
To insert a graphic we use the elements
<mediaobject>
,
<imageobject>
,
@@ -1088,7 +1088,7 @@
- + Here's how you make the DocBook equivalent of the three usual HTML-lists:
@@ -1155,7 +1155,7 @@
-
+
DocBook supports several types of tables, but in most cases, the
<informaltable>
is enough:
@@ -1211,7 +1211,7 @@
-
+
Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one -
<emphasis>
.