Revision: 32821
http://brlcad.svn.sourceforge.net/brlcad/?rev=32821&view=rev
Author: starseeker
Date: 2008-10-02 22:21:40 +0000 (Thu, 02 Oct 2008)
Log Message:
-----------
update notes on docbook
Modified Paths:
--------------
brlcad/trunk/doc/docbook/README
Modified: brlcad/trunk/doc/docbook/README
===================================================================
--- brlcad/trunk/doc/docbook/README 2008-10-02 19:05:34 UTC (rev 32820)
+++ brlcad/trunk/doc/docbook/README 2008-10-02 22:21:40 UTC (rev 32821)
@@ -1,11 +1,41 @@
-This directory contains (as of June 2008) an experimental conversion
-to docbook of Volume II of the BRL-CAD tutorial series, as well as
-the docbook for the OED tutorial.
+This directory contains (as of Sept. 2008) the current docbook work on
+Volume II and Volume II of the BRL-CAD Tutorial Series, as well as the oed
+and tire articles. It also holds the current test examples of the new
+docbook based manual page conversions.
The default dtd and xsl stylesheets for docbook 4.5 are present
in the resources directory, and it is these copies that are
referenced in the docbook files.
+The current structure is as follows:
+
+articles/
+ Individual articles on specific topics - oed and tire live here,
+ as well as the articles that made up the appendices of VolIII.
+
+books/
+ Either compilations of smaller documents into large works, or
+ individual self contained works. Most of Volume III is in a
+ single file in this subtree.
+
+lessons/
+ Individual documents intended to teach some aspect of BRL-CAD
+ to new users/students. At this time it contains the individual
+ lessons that made up Volume II.
+
+resources/
+ The DocBook 4.5 dtd and xsl files are contained within the
+ "standard" subdirectory. Custom files will be organized under
+ this directory in the future.
+
+system/
+ Documentation similar to traditional Unix "man" pages - focused
+ documentation on specific parts of BRL-CAD.
+
+English documents (the only language documentation is written in within
+svn as of Sept. 2008) are in en subdirectories. Other languages, when
+implemented, will use standard two character sub directories.
+
These documents make extensive use of the XInclude modular documentation
specification, and as a consequence the contents of any one particular
"document" may be scattered over many other documents. This design
@@ -26,7 +56,3 @@
should let Apache know to use UTF-8 encoding for these pages.
-* xsltproc command examples:
-
- XML_CATALOG_FILES="../../catalog.xml" xsltproc -nonet -xinclude -o VolumeII.html chunk.xsl VolumeII.xml
- XML_CATALOG_FILES="../../catalog.xml" xsltproc -nonet -xinclude -o creating_a_goblet.html docbook.xsl creating_a_goblet.xml
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.