README


1. Read INSTALL it gives you a lot of info on how to install mod-xslt. If you try without it be warned. Things might very likely go wrong

Here are some short instructions for use of mod-xslt.

The stylesheet is specified using the Processing Instruction

<?xml-stylesheet type="text/xsl" href="URL-OF-YOUR-STYLESHEET"?>

or now new

<?xslt-stylesheet agent="THE-USER-AGENT-STRING-OF-THE-BROWSER" href="URL-OF-YOUR-STYLESHEET"?>

This now enables you to use different Stylesheets for different browsers. (For example Netscape & IE) (or Web & WAP for that matter)

There are 2 other PI's that are processed:

<?xslt-base mode="file://|http://"?>
which tells mod-xslt how to get the stylesheet. Using a file url or
an http-request which permits you to generate your stylesheet using a script.
Per default this is set to mode="file://"

<?xslt-param name="NAME" select="VALUE"?>
Passes a Parameter to the processor. This overrides any parameters passed in the url.
This will generally be used by scripts to pass parameters to the stylesheet which
are not passed in the url or which it wants to override.

Parameters are generally only passed from the QUERY-STRING. So POST parameters are
ignored. It would be easy however to write a script reading the post parameters, reading a file,
and spitting that out so that you can retrieve these params as well.


There are a few Parameters that are passed along as well:
xslt-version = The current version
xslt-author = 'philipp@dunkel.org'
xslt-useragent = The User-Agent String passed by the Browser
xslt-fileurl = The URL of the document as a file:// URL
xslt-httpurl = The URL of the document as a http:// URL
xslt-document = The URL or File of the XML (depends on xslt-base)
xslt-stylesheet = The URL of the stylesheet (depends on xslt-base)


Last but not least:
If there are any Questions, don't hesitate to drop me a line. I'm happy to hear from you.

Philipp Dunkel
philipp@dunkel.org

P.S.: We have neglected to update the documentation xml and xsl files.
They reflect the state of the project at an alpha level and should not be
relied uppon. If you need help write me rather than read these files.
The only reason they are still there is to enable you to test whether your
installation is working.
