cvs commit: ALFS/docs/syntax_doc README

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Sat May 29 12:25:58 PDT 2004


jwrober     04/05/29 13:25:58

  Modified:    docs/syntax_doc README
  Log:
  * Update README to make current
  
  Revision  Changes    Path
  1.2       +36 -20    ALFS/docs/syntax_doc/README
  
  Index: README
  ===================================================================
  RCS file: /home/cvsroot/ALFS/docs/syntax_doc/README,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- README	31 Mar 2004 03:36:15 -0000	1.1
  +++ README	29 May 2004 19:25:58 -0000	1.2
  @@ -1,33 +1,47 @@
   README for the ALFS syntax_doc module
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  +0. Introduction
  +~~~~~~~~~~~~~~~
  +
  +This is a quick readme file on setting up the tools necessary to parse the
  +ALFS DTD Syntax Doc XML source into other formats (e.g. HTML or TXT).  If
  +you do not want to do that, then you do not need to read this file.  The
  +XML source is generally available for viewing and download on the LFS
  +website at http://linuxfromscratch.org/alfs.
   
   1. Requirements
   ~~~~~~~~~~~~~~~
   
  -* DocBook XML DTD-4.2
  -
  -* DocBook XSL Stylesheets-1.65.1 or better
  +* libxml2-2.6.10 or better
  +	-- http://www.linuxfromscratch.org/blfs/view/cvs/general/libxml2.html
   
  -* libxml2-2.6.8 or better
  +* libxslt-1.1.6 or better
  +	-- http://www.linuxfromscratch.org/blfs/view/cvs/general/libxslt.html
   
  -* libxslt-1.1.5 or better
  +* DocBook XML DTD-4.3
  +	-- http://www.linuxfromscratch.org/blfs/view/cvs/pst/xml.html
   
  -* lynx-2.8.4 or better
  +* DocBook XSL Stylesheets-1.65.1 or better 
  +	-- http://www.linuxfromscratch.org/blfs/view/cvs/pst/docbook-xsl.html
   
  +* lynx-2.8.5 or better
  +	-- http://www.linuxfromscratch.org/blfs/view/cvs/basicnet/lynx.html
   
   2. Setting up the DTD
   ~~~~~~~~~~~~~~~~~~~~~
   
  -Follow the steps in the BLFS book for all the packages.  It is pretty
  -simple.
  +Follow the steps in the BLFS book for all the packages listed above in the
  +requirements section.  It is pretty simple.  The biggest thing is making
  +sure that your /etc/xml/catalog and /etc/xml/docbook files are setup
  +correctly.
   
   *** Note that the directory that the HTML files are output to
  -can be altered by changing the OUTDIR variable at the top of the Makefile,
  -ensuring that when you do so, you're new value has a trailing "/".  Also
  -note that the directory that DocBook XSL is installed in can be altered by
  -changing the XSLROOTDIR variable at the top of the Makefile.  This one is
  -important as a sed later on won't work if you have this set wrong. ***
  -
  +can be altered by changing the OUTDIR variable at the top of the Makefile
  +or by passing a new variable via the command line, ensuring that when you
  +do so, you're new value has a trailing "/".  Also note that the directory
  +that DocBook XSL is installed in can be altered by changing the XSLROOTDIR
  +variable at the top of the Makefile.  This one is important as a sed later
  +on won't work if you have this set wrong. ***
   
   3. Processing the sources
   ~~~~~~~~~~~~~~~~~~~~~~~~~
  @@ -46,11 +60,13 @@
   stylesheets.  HTML visual representation is provided by alfs.css also in
   the stylesheets/ directory.
   
  -For the non-chunked HTML output, we do a lot of the same processing like
  -the chunked version, except we use alfs-nochunks.xsl which like
  -alfs-chunked.xsl is a customisation layer to onechunk.xsl provided by
  -docbook-xsl.  The commnad for this one is `make nochunks-html`.
  +For the non-chunked HTML output, run `make nochunks-html`.  We do a lot of
  +the same processing like the chunked version, except we use
  +alfs-nochunks.xsl which like alfs-chunked.xsl is a customisation layer to
  +onechunk.xsl provided by docbook-xsl.  The commnad for this one is `make
  +nochunks-html`.
  +
  +For the flat text output, run `make flat-text`.  We run the nochunks-html
  +target first and then pass the result through lynx. 
   
  -For the flat text output, we run the nochunks-html target first and then
  -pass the result through lynx. 
   
  
  
  



More information about the alfs-log mailing list