documentation html

XSLT stylesheet HTML documentation

This stylesheet generate HTML documentation for a given XSLT stylesheet

Usage

xsltproc -o htmloutput.html \
		--stringparam xsl.doc.html.fileName "${title}" \
		--stringparam xsl.doc.html.cssPath "${cssPath}" \
		${NSXML_ROOT}/ns/xsl/languages/xsl/documentation-html.xsl \
		xsl-file.xsl

With:

• xsl.doc.html.directoryIndexPathMode: Directory index path type
  • 'per-folder': Generate links to $xsl.doc.html.directoryIndexPath located in the same directory
  • 'root': Generate links to $xsl.doc.html.directoryIndexPath located in the documentation root. $xsl.doc.html.fileName is used to determaine the correct link
  • 'auto'
  • 'none': Do not generate parent directory links
• xsl.doc.html.directoryIndexPath: A dynamic HTML page (ie. PHP or any other server language) to use as a directory listing page.
• xsl.doc.html.fileName (optional): A path relative to the XSLT documentation root. A link to each parent directory will be generated automatically.
• xsl.doc.html.cssPath (optional): A file system path to a CSS style sheet, relative to the output path
• xsl.doc.html.fullHtmlPage If true() (the default). Generate a full HTML page with header and body. Otherwise, enclose stylesheet documentation in a <div/>

Examples

• The documentation of all XSLT stylesheets of this project can be found here
• For a more complete usage example, see the end of the <<file tools/sh/update-doc.sh>> utility program.