X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=doc%2FDOCDOC;h=465f1f371be6f4405a68c87c160da45474377566;hb=c3cd5fea80b8034b16311936f910848fa4a7e87d;hp=034f1710869034142947f47ca375f6992affe951;hpb=0898da1d2bf772db65a98bfc424ef52aa150fb38;p=sbcl.git diff --git a/doc/DOCDOC b/doc/DOCDOC index 034f171..465f1f3 100644 --- a/doc/DOCDOC +++ b/doc/DOCDOC @@ -4,13 +4,13 @@ Overview ======== SBCL's documentation is written in XML DocBook which is a semantically -marked document not meant for reading. Rather, a DocBook file is meant -to be transformed into presentation formats such as HTML, PDF, and -plain text. To perform such translation, you'll need tools beyond what -is included in the SBCL distribution: +marked document not meant for humans to read directly. Rather, a +DocBook file is meant to be transformed into presentation formats such +as HTML, PDF, and plain text. To perform such translation, you'll need +tools beyond what is included in the SBCL distribution: 1) To verify the correctness of the XML documentation, you'll need the -DocBook DTD files and an XML verification tools. +DocBook DTD files and an XML verification tool. 2) To transform the main XML DocBook file (user-manual.xml), you need an XSL Transformer and the Docbook XSL Stylesheets. The stylesheets @@ -23,12 +23,12 @@ Catalog Files ============= Catalog files are used to map URLs used in the SBCL Docbook and -stylesheet files into local file names. By using catalog, processing +stylesheet files into local file names. By using a catalog, processing is faster and a network connection is not necessary. Catalog files are specific to an operating system since they embed file locations. The SBCL Makefile attempts to determine the correct catalog for your system. If SBCL does not supply a catalog for your system, processing -the DocBook files will require a network connections. +the DocBook files will require a network connection. Default Processing ================== @@ -68,3 +68,11 @@ Tools for Fink The easiest way to do this is with the command: fink install libxslt docbook-dtd docbook-xsl libxml2-bin + +Tools Web Home +-------------- +xsltproc http://xmlsoft.org/XSLT/ +DocBook DTD http://www.docbook.org/xml/ +DocBook XSL http://sourceforge.net/projects/docbook +xmllint http://xmlsoft.org/ +FOP http://xml.apache.org/fop/