By Claus Rasmussen, with additions by Roberto Mello, Vinod -Kurup, and the OpenACS Community
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS documentation should meet the following requirements. No significance has been given to the order presented, topic breadth @@ -132,7 +132,7 @@ be in 1 area, using a common layout of perhaps summary, introduction and discussion requiring increasing expertise, complexity or specificity.
-Consistency in link descriptions -When link urls refer to whole +
Consistency in link descriptions -When link URLs refer to whole documents, make the link (anchor wrapped title) that points to a document with the same title and/or heading of the document.
Consider OpenACS documentation as a set of books (an encyclopedic set organized like an atlas) that contains volumes @@ -167,7 +167,7 @@
By the OpenACS Community. This section is a collection of +End-users
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS end-user documentation should meet the following requirements. No significance has been given to the order @@ -264,7 +264,7 @@
By the OpenACS Community. This section is a collection of +and Administrators
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS administrators' documentation should meet the following requirements. No significance has been given to the order @@ -307,7 +307,7 @@
By the OpenACS Community. This section is a collection of +Requirements
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS installation documentation should meet the following requirements. No significance has been given to the order @@ -331,7 +331,7 @@
By the OpenACS Community. This section is a collection of +Documentation Requirements
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS developer tutorial documentation should meet the following requirements. No significance has been given to the order @@ -358,7 +358,7 @@
By the OpenACS Community. This section is a collection of +Requirements
By the OpenACS community. This section is a collection of documentation requirements that have been expressed in the OpenACS forums to 4th July 2003.
OpenACS developer documentation should meet the following requirements. No significance has been given to the order @@ -409,7 +409,7 @@ tools will be marked up to conform to the DocBook XML DTD. The remaining discussion is about publishing using Docbook.
- 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.
The DocBook community mailing lists @@ -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:
- 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
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 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:
@@ -538,7 +538,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
@@ -548,7 +548,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,
@@ -562,15 +562,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>. @@ -594,7 +594,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>
....will create a hyper-link to Oracle in the HTML-version of @@ -612,7 +612,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>,
@@ -637,7 +637,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"> @@ -736,7 +736,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