----------------------------------------------------------------------
README file for the libxslt extensions
----------------------------------------------------------------------
$Id: README.LIBXSLT 7877 2008-03-08 04:07:52Z xmldoc $
These are XSLT extensions written in Python for use with the DocBook XML
stylesheets and the libxslt library[1].
Currently, the only available extension is a function for adjusting column
widths in tables. For more information, see the section describing the
equivalent Java extension in "DocBook XSL: The Complete Guide"[2].
----------------------------------------------------------------------
Preparations
----------------------------------------------------------------------
In addition to libxml2 and libxslt, the following software needs to
be installed before you start using the extensions:
1. Python[3].
2. Python bindings for libxml2/libxslt. Most distributions of
libxml2/libxslt for Unix/Linux include these bindings.
A native Windows port is provided by Stphane Bidoul[4].
----------------------------------------------------------------------
Installation of the extensions
----------------------------------------------------------------------
No special installation step is needed.
----------------------------------------------------------------------
How to use the extensions
----------------------------------------------------------------------
Instead of using xsltproc, you run a Python program (xslt.py). The
command has this general form:
python xslt.py xmlfile xslfile [outputfile] [param1=val1 [param2=val]...]
Modify paths, filenames, and parameters as needed. Make sure to set
the "use.extensions" and "tablecolumns.extension" parameters to 1.
----------------------------------------------------------------------
Manifest
----------------------------------------------------------------------
README.LIBXSLT This file
xslt.py Executable script file
docbook.py Module that implements extensions
----------------------------------------------------------------------
[1] http://xmlsoft.org/XSLT
[2] http://www.sagehill.net/docbookxsl/ColumnWidths.html
[3] http://www.python.org/download
[4] http://users.skynet.be/sbi/libxml-python
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 13895 | Paul Allen | Copying using p4convert-docbook | ||
| //guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/extensions/README.LIBXSLT | |||||
| #1 | 12728 | eedwards |
Upgrade ANT doc build infrastructure to assemble PDFs: - remove non-namespaced DocBook source and add namespaced DocBook source. - add Apache FOP 1.1 - copy fonts, images, XSL into _build, establishing new asset structure. The original structure remains until all guides using it can be upgraded, and several other issues can be resolved. - updated build.xml to allow for per-target build properties. - upgraded the P4SAG to use the new infrastructure. - tweaked admonition presentation in PDFs to remove admonition graphics, and resemble closely the presentation used in the new HTML layout, including the same colors. With these changes, building PDFs involves using a shell, navigating into the guide's directory (just P4SAG for now), and executing "ant pdf". Issues still to be resolved: - PDF generation encounters several warnings about missing fonts (bold versions of Symbol and ZapfDingbats), and a couple of locations where the page content exceeds the defined content area. - Due to issues within Apache FOP, PDF generation emits a substantial amount of output that is not easily suppressed without losing important warning information. - Apache FOP's interface to ANT does not expose a way to set the font base directory. The current configuration does work under Mac OSX, but further testing on Windows will need to be done to determine if the relative paths defined continue to work. The workaround is for Windows users to customize the fop-config.xml to provide absolute system paths to the required fonts. - HTML generation needs further browser testing, and exhibits broken navigation on iOS browsers within the TOC sidebar. - A number of PDF and HTML presentation tweaks still need to be made, for example: sidebars, gui* DocBook tags, whitespace, section separation, etc. |
||