From: Mauritz Jeanson <mj@johanneberg.com>
Date: Thu, 21 Feb 2008 17:25:57 +0000 (+0000)
Subject: Added preliminary README information for libxslt extensions.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7e9a8a70fb78e7de834c715d0217bc212cc05baf;p=docbook-dsssl

Added preliminary README information for libxslt extensions.
The adjustColumnWidths() function works well for me (tested on
Windows XP with Python 2.5).
---

diff --git a/xsl-xsltproc/python/README b/xsl-xsltproc/python/README
index a7cd35678..9255551dd 100644
--- a/xsl-xsltproc/python/README
+++ b/xsl-xsltproc/python/README
@@ -1,3 +1,51 @@
-THIS IS A WORK IN PROGRESS
+----------------------------------------------------------------------
+              README file for the libxslt extensions
+----------------------------------------------------------------------
+$Id$
 
-IN PARTICULAR: IT DOES NOT WORK NOW!
+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 Stéphane Bidoul[4].
+
+----------------------------------------------------------------------
+Installation of the extensions
+----------------------------------------------------------------------
+Place xslt.py and docbook.py in a directory of your choice.
+
+----------------------------------------------------------------------
+How to use the extensions
+----------------------------------------------------------------------
+The transformation 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 
+use.extensions=1 and tablecolumns.extension=1.
+
+----------------------------------------------------------------------
+Manifest
+----------------------------------------------------------------------
+README        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
\ No newline at end of file