XSLdoc apps.XSLdoc.xsl.html.documenter.xsl

The stylsheet which XSLdoc uses to generate HTML documentation.

To submit a bug, please send email to bacman [at] bacman dot net. Include a detailed description of the bug and the source XML used to produce it. I welcome comments and suggestions on improving XSLdoc.

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xsldoc="http://www.bacman.net/XSLdoc" exclude-result-prefixes="xsldoc" version="1.0">

<xsl:output method="html" omit-xml-declaration="yes" indent="no" encoding="UTF-8"/>

Parameter Detail

baseURL

http://www.bacman.net/

Domain, including http:// and trailing slash.

css

/apps/XSLdoc/css/xsldoc.css

CSS URL.

documenter

XSLdoc.jsp?URL=

Documenter URL. This is used for linking XSLdoc to imports/includes.

fileName

File to document.

ignoreIncludeAndImport

false

Parse included and imported stylesheets

isHTTP

true

is HTTP or FILE base URL

path

Relative path excluding fileName. (e.g. apps/XSLdoc/html/)

Attribute Set Detail

border

<xsl:attribute-set name="border">

Attributes
`border`	`1`

group

<xsl:attribute-set name="group">

Attributes
`class`	`group`

heading

<xsl:attribute-set name="heading">

Apply style attributes to sub-table headings.

Attributes
`class`	`heading`

noBorder

<xsl:attribute-set name="noBorder">

Attributes
`border`	`0`

subHeading

<xsl:attribute-set name="subHeading">

Apply style attributes to sub-table headings.

Attributes
`class`	`subHeading`

table

<xsl:attribute-set name="table"
                        use-attribute-sets="noBorder">

Attributes to create a stanard HTML table.

Attributes
`cellpadding`	`0`
`cellspacing`	`0`
`width`	`100%` forces the table to span the width of the browser window

table2

<xsl:attribute-set name="table2"
                        use-attribute-sets="table">

Overrides the cellpadding of the attribute-set table.

Attributes
`cellpadding`	`2`

table3

<xsl:attribute-set name="table3"
                        use-attribute-sets="table">

Overrides the cellpadding of the attribute-set table.

Attributes
`cellpadding`	`3`

top

<xsl:attribute-set name="top">

Attributes
`valign`	`top`

x2

<xsl:attribute-set name="x2">

Attributes
`colspan`	`2`

x3

<xsl:attribute-set name="x3">

Attributes
`colspan`	`3`

x4

<xsl:attribute-set name="x4">

Attributes
`colspan`	`4`

y2

<xsl:attribute-set name="y2">

Attributes
`rowspan`	`2`

Name Template Detail

link-attribute-sets

<xsl:template name="link-attribute-sets">

This template creates HTML anchor tags for each attribute-set attribute contained within an xsl:attribute-set element. The attribute-set must be defined in the local or imported/included stylesheet for it to be linked.

Parameters
`attributeSetString`	Value of attribute use-attribute-sets.

link-variable

<xsl:template name="link-variable">

This template creates HTML anchor tags for each xsl:variable element. Variables must be defined in the local or imported/included stylesheet for them to be linked.

Parameters
`variableString`	Value of variable.

replace-string

<xsl:template name="replace-string">

Renders the parameter text, after all occurences of replace, have been replaced with the parameter with.

Parameters
`replace`
`text`
`with`

Match Template Detail

xsldoc:*

<xsl:template match="xsldoc:*">

This template allows for HTML within xsldoc elements (author, date, version)

xsl:attribute-set

<xsl:template match="xsl:attribute-set"
                        mode="xsldoc">

This template is used to document xsl:attribute-set elements.

xsldoc

xsl:comment | comment()

<xsl:template match="xsl:comment | comment()"
                        mode="xsldoc">

This template is used to document comments that are placed with both the xsl:comment element and <–– ––> syntax.

xsldoc

xsl:decimal-format

<xsl:template match="xsl:decimal-format"
                        mode="xsldoc">

This template is used to document the xsl:decimal-format element.

xsldoc

xsl:import | xsl:include

<xsl:template match="xsl:import | xsl:include"
                        mode="xsldoc">

This template is used to document all xsl:import and xsl:include elements.

xsldoc

xsl:key

<xsl:template match="xsl:key"
                        mode="xsldoc">

This template is used to document the xsl:key element.

xsldoc

xsl:param

<xsl:template match="xsl:param"
                        mode="xsldoc">

This template is used to document the xsl:param elements contained with xsl:stylsheet and xsl:template elements.

xsldoc

xsl:stylesheet

<xsl:template match="xsl:stylesheet"
                        mode="xsldoc">

This template is used to document the xsl:stylsheet element.

xsldoc

xsl:template[@match]

<xsl:template match="xsl:template[@match]"
                        mode="xsldoc">

This template is used to documents xsl:template elements that have a match attribute (match templates).

xsldoc

xsl:template[@name]

<xsl:template match="xsl:template[@name]"
                        mode="xsldoc">

This template is used to document xsl:template elements that have a name attribute (name templates).

xsldoc

xsl:variable

<xsl:template match="xsl:variable"
                        mode="xsldoc">

This template is used to document the xsl:variable element.

xsldoc

*

<xsl:template match="*"
                        mode="copy-no-ns">

copy-of without namespaces

copy-no-ns

/

<xsl:template match="/">

The root template.

/

<xsl:template match="/"
                        mode="xsldoc">

This template renders the HTML head and body tags.

xsldoc

@*|node()

<xsl:template match="@*|node()"
                        mode="pretty-print">

This template pretty-prints XML (variables, parameters, attribute-sets)

pretty-print

Parameters
`indent`	Indentation
`level`	`0` If level = 0, all child nodes are pretty-printed recursively. Else, only the current node is pretty-printed.

/apps/XSLdoc/xsl/html/documenter.xsl

Michael Bacarella
September 24, 2008
Version 1.5.4

Parameter Detail
`baseURL`	`http://www.bacman.net/` Domain, including http:// and trailing slash.
`css`	`/apps/XSLdoc/css/xsldoc.css` CSS URL.
`documenter`	`XSLdoc.jsp?URL=` Documenter URL. This is used for linking XSLdoc to imports/includes.
`fileName`	File to document.
`ignoreIncludeAndImport`	`false` Parse included and imported stylesheets
`isHTTP`	`true` is HTTP or FILE base URL
`path`	Relative path excluding fileName. (e.g. apps/XSLdoc/html/)

/apps/XSLdoc/xsl/html/documenter.xsl

Michael BacarellaSeptember 24, 2008Version 1.5.4

Michael Bacarella
September 24, 2008
Version 1.5.4