Index: openacs-4/packages/acs-core-docs/www/docbook-primer.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.adp,v diff -u -r1.6.2.13 -r1.6.2.14 --- openacs-4/packages/acs-core-docs/www/docbook-primer.adp 2 Sep 2024 09:40:21 -0000 1.6.2.13 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.adp 3 Sep 2024 08:43:02 -0000 1.6.2.14 @@ -413,7 +413,7 @@ tools will be marked up to conform to the DocBook XML DTD. The remaining discussion is about publishing using Docbook.
- is a + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:
- Given that
+ 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
+ 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”). 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
+ 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 - @@ -545,7 +545,7 @@ </sect1>
- Inside
+ 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
@@ -555,7 +555,7 @@
- For
+ 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,
@@ -569,7 +569,7 @@
- Linking + 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 +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>. @@ -602,7 +602,7 @@
- If
+ 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>
....will create a hyper-link to Oracle in the HTML-version of @@ -620,7 +620,7 @@ Note: The graphics guidelines are not written in stone. Use another valid approach if it works better for you.
- To insert
+ To insert
a graphic we use the elements <mediaobject>
,
<imageobject>
,
<imagedata>
,
@@ -645,7 +645,7 @@
- Here's + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- DocBook
+ DocBook
supports several types of tables, but in most cases, the <informaltable>
is enough:
<informaltable frame="all"> <tgroup cols="3"> @@ -745,7 +745,7 @@
- Our
+ 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