doc/xslt/extensions/README.LIBXSLT

   1 ----------------------------------------------------------------------
   2               README file for the libxslt extensions
   3 ----------------------------------------------------------------------
   4 $Id: README.LIBXSLT 7877 2008-03-08 04:07:52Z xmldoc $
   5
   6 These are XSLT extensions written in Python for use with the DocBook XML
   7 stylesheets and the libxslt library[1].
   8
   9 Currently, the only available extension is a function for adjusting column
  10 widths in tables. For more information, see the section describing the
  11 equivalent Java extension in "DocBook XSL: The Complete Guide"[2].
  12
  13 ----------------------------------------------------------------------
  14 Preparations
  15 ----------------------------------------------------------------------
  16 In addition to libxml2 and libxslt, the following software needs to
  17 be installed before you start using the extensions:
  18
  19 1. Python[3].
  20
  21 2. Python bindings for libxml2/libxslt. Most distributions of
  22    libxml2/libxslt for Unix/Linux include these bindings.
  23    A native Windows port is provided by Stéphane Bidoul[4].
  24
  25 ----------------------------------------------------------------------
  26 Installation of the extensions
  27 ----------------------------------------------------------------------
  28 No special installation step is needed.
  29
  30 ----------------------------------------------------------------------
  31 How to use the extensions
  32 ----------------------------------------------------------------------
  33 Instead of using xsltproc, you run a Python program (xslt.py). The
  34 command has this general form:
  35
  36 python xslt.py xmlfile xslfile [outputfile] [param1=val1 [param2=val]...]
  37
  38 Modify paths, filenames, and parameters as needed. Make sure to set
  39 the "use.extensions" and "tablecolumns.extension" parameters to 1.
  40
  41 ----------------------------------------------------------------------
  42 Manifest
  43 ----------------------------------------------------------------------
  44 README.LIBXSLT   This file
  45 xslt.py          Executable script file
  46 docbook.py       Module that implements extensions
  47
  48 ----------------------------------------------------------------------
  49 [1] http://xmlsoft.org/XSLT
  50 [2] http://www.sagehill.net/docbookxsl/ColumnWidths.html
  51 [3] http://www.python.org/download
  52 [4] http://users.skynet.be/sbi/libxml-python