stylesheet.xsl

Creates a HTML page for a stylesheet.
This stylesheet creates the xhtml output for one stylesheet. It calls sub-templates to build documentation parts for different parts of a stylesheet (templates, functions etc.). Note that the default namespace of this stylesheet is set to http://www.w3.org/1999/xhtml. That means that any literal element is of this namespace if not specified specificely!
Author:
ibirrer
CVS Id:
stylesheet.xsl 43 2009-11-07 13:02:24Z ibirrer
Copyright:
2004, P&P Software GmbH
XSLT Version:
2.0
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
util - http://www.pnp-software.com/util
xd - http://www.pnp-software.com/XSLTdoc
xs - http://www.w3.org/2001/XMLSchema
xsl - http://www.w3.org/1999/XSL/Transform

Parameters Summary

xs:string access - source
Controls the maximum access level displayed.

Variables Summary

The upper-case hexadecimal digits

Keys Summary

xd:attribute-set (match: /xsl:stylesheet/xsl:attribute-set | /xsl:transform/xsl:attribute-set, use: @name) - source
Indexes all xsl:attribute-set elements in each stylesheet by name.
xd:character-map (match: /xsl:stylesheet/xsl:character-map | /xsl:transform/xsl:character-map, use: @name) - source
Indexes all xsl:character-map elements in each stylesheet by name.

Template Modes Summary

Translates specialized xd: elements into XHTML
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
No short description available
Selects the automatic text for an xd:link element.

Match Templates Summary

* (mode: XdocTags) - source
Default template in XdocTags mode
xd:* (mode: XdocTags) - source
Default template in XdocTags mode for elements in xd namespace
Converts a xd:link element to a html link
JK, 11/2007 - Outputs title for attribute sets details and creates detailed documentation for each attribute set
JK, 11/2007 Generates attribute set summary section
Outputs title for character map details and creates detailed documentation for each character map.
Generates character map summary section.
Outputs title for decimal format details and creates detailed documentation for each decimal format.
No short description available
Generates decimal formats summary section.
Outputs title for element space details and creates detailed documentation for each element.
Generates element space summary section.
Outputs title for function details and creates detailed documentation for each function
Generates function summary section
SM, 05/12/2007 - Outputs title for keys and creates detailed documentation for each key
SM, 05/12/2007 Generates key summary section
Outputs title for match template details and creates detailed documentation for each match template
Generates match template summary section
Outputs title for named template details and creates detailed documentation for each named template
Generates template summary section
Outputs title for namespace alias details and creates detailed documentation for each namespace alias.
Generates namespace alias summary section.
Outputs title for output details and creates detailed documentation for each output.
No short description available
No short description available
Generates output summary section.
Outputs title for parameter details and creates detailed documentation for each parameter
Generates parameter summary section
Prints the declaration of a function or template
Overwrites XSLT default rules.
* (param: element(xd:doc)? doc, mode: printShortDescription) - source
Prints the short description of a documented xsl function or template.
Calls sub-templates for each part of the stylesheet documentation.
Prints details of the stylesheet
Outputs title for template mode details and creates detailed documentation for each template mode.
Generates template mode summary section.
JK, 11/2007 - Outputs title for variables details and creates detailed documentation for each variable
JK, 11/2007 Generates variable summary section
No short description available
No short description available
No short description available

Named Templates Summary

extractDetailDescription (param: string doc) - source
Extracts the detail description from string
extractShortDescription (param: string doc) - source
Extracts the short description from a xd:doc element
getGeneratedId (param: nametypemodestylesheet-prefixresult-prefix) - source
No short description available
printTemplateDeclaration (param: node-set docnode-set template) - source
Prints the short form of the declaration of a template

Functions Summary

xs:boolean xd:accessMatch (param: element(*)? element) - source
Determines if an element satisfies the access level specified for the documentation generation.
xs:string xd:decToBase (param: xs:integer decxs:string* digits) - source
Converts a decimal number to a string with another numeric base, given the set of digits.
element(xd:doc)? xd:getDoc (param: element(*) element) - source
Returns the xd:doc node of an element.
element(xd:doc)* xd:getModeDoc (param: element(*) elementmode) - source
Returns the xd:doc nodes for the mode(s) of a template.
xs:string* xd:getModes (param: element(*) element) - source
Returns a sequence of names of modes in a stylesheet.
element(xsl:template)* xd:getTemplatesByMode (param: element(*) elementxs:string mode) - source
Returns a sequence of templates using a given mode in a stylesheet.
xd:printAttribute (param: att) - source
No short description available
xd:printMatchTemplate (param: template) - source
No short description available
xd:printMode (param: element(*) rootmode) - source
No short description available
xd:printParamDeclaration (param: paramdoc) - source
No short description available
xs:string* xd:splitWhitespaceString (param: xs:string? string) - source
Splits a whitespace-separated string into a sequence.

Parameters Detail

xs:string access - source
Controls the maximum access level displayed.
This parameter overrides the <Access> element inside an XSLTdocConfig file.

Variables Detail

The upper-case hexadecimal digits

Keys Detail

xd:attribute-set (match: /xsl:stylesheet/xsl:attribute-set | /xsl:transform/xsl:attribute-set, use: @name) - source
Indexes all xsl:attribute-set elements in each stylesheet by name.
xd:character-map (match: /xsl:stylesheet/xsl:character-map | /xsl:transform/xsl:character-map, use: @name) - source
Indexes all xsl:character-map elements in each stylesheet by name.

Template Modes Detail

Translates specialized xd: elements into XHTML
This allows for extension elements that can do things such as link to other parts of the documentation or easily include formatted XML.
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:
No short description available
Templates Using This Mode:

Match Templates Detail

* (mode: XdocTags) - source
Default template in XdocTags mode
This ensures that elements that need no conversion(html tags) are copied to the result tree. The namespace of an element is translated to xhtml!
xd:* (mode: XdocTags) - source
Default template in XdocTags mode for elements in xd namespace
Converts a xd:link element to a html link
(JK, 11/2007)
JK, 11/2007 - Outputs title for attribute sets details and creates detailed documentation for each attribute set
JK, 11/2007 Generates attribute set summary section
Prints title of the section and then iterates through all top level variables and prints its declaration and short description
Outputs title for character map details and creates detailed documentation for each character map.
Author:
Greg Beauchesne
Since:
09/2009
Generates character map summary section.
Prints title of the section and then iterates through all character maps and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
Outputs title for decimal format details and creates detailed documentation for each decimal format.
Author:
Greg Beauchesne
Since:
09/2009
No short description available
Generates decimal formats summary section.
Prints title of the section and then iterates through all decimal formats and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
Outputs title for element space details and creates detailed documentation for each element.
Author:
Greg Beauchesne
Since:
09/2009
Generates element space summary section.
Prints title of the section and then iterates through all strip-space and preserve-space elements and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
Outputs title for function details and creates detailed documentation for each function
Generates function summary section
Prints title of the section and then iterates through all functions and prints its declaration and short description
SM, 05/12/2007 - Outputs title for keys and creates detailed documentation for each key
SM, 05/12/2007 Generates key summary section
Prints title of the section and then iterates through all keys and prints its declaration and short description
Outputs title for match template details and creates detailed documentation for each match template
Generates match template summary section
Prints title of the section and then iterates through all templates and prints its declaration and short description
Outputs title for named template details and creates detailed documentation for each named template
Generates template summary section
Prints title of the section and then iterates through all templates and prints its declaration and short description
Outputs title for namespace alias details and creates detailed documentation for each namespace alias.
Author:
Greg Beauchesne
Since:
09/2009
Generates namespace alias summary section.
Prints title of the section and then iterates through all namespace aliases and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
Outputs title for output details and creates detailed documentation for each output.
Author:
Greg Beauchesne
Since:
09/2009
No short description available
No short description available
Generates output summary section.
Prints title of the section and then iterates through all outputs and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
Outputs title for parameter details and creates detailed documentation for each parameter
Generates parameter summary section
Prints title of the section and then iterates through all parameters and prints its declaration and short description
Prints the declaration of a function or template
Parameters:
link - If this parameter equals to true() it adds the declaration as a link to the detailied declaration
element(xd:doc)? doc -
sourceLinkNode -
verbatimUriRel -
element(*)? root -
showModes -
Prints the detail description of a xd:doc element.
If no detail description is found, the string "No detail description available" is printed
Parameters:
element(xd:doc)? doc -
Prints the properties of a xd:doc element.
Parameters:
element(xd:doc)? doc -
element(*)? root -
modeDoc -
Overwrites XSLT default rules.
This ensures that tags not handled in the mode printProperty are not printed.
* (param: element(xd:doc)? doc, mode: printShortDescription) - source
Prints the short description of a documented xsl function or template.
If there's nn xd:doc element dedined or he xd:doc element does not contain a short description, the string "No short description available" is printed.
Parameters:
element(xd:doc)? doc -
Calls sub-templates for each part of the stylesheet documentation.
Prints details of the stylesheet
Outputs title for template mode details and creates detailed documentation for each template mode.
Author:
Greg Beauchesne
Since:
09/2009
Generates template mode summary section.
Prints title of the section and then iterates through all template modes and prints their declarations and short descriptions.
Author:
Greg Beauchesne
Since:
09/2009
JK, 11/2007 - Outputs title for variables details and creates detailed documentation for each variable
JK, 11/2007 Generates variable summary section
Prints title of the section and then iterates through all top level variables and prints its declaration and short description
No short description available
No short description available
No short description available

Named Templates Detail

extractDetailDescription (param: string doc) - source
Extracts the detail description from string
Everything after the first period is considered as detail description. If no detail description can be extracted, the empty string is returned.
Parameters:
string doc - xd:doc element
extractShortDescription (param: string doc) - source
Extracts the short description from a xd:doc element
Everything before the first period is considered as short description. If the string doesn't contain a period, the whole string is returned.
Parameters:
string doc - xd:doc element
getGeneratedId (param: nametypemodestylesheet-prefixresult-prefix) - source
No short description available
Parameters:
name -
type -
mode -
stylesheet-prefix -
result-prefix -
printTemplateDeclaration (param: node-set docnode-set template) - source
Prints the short form of the declaration of a template
This includes the parameters and the mode.
Parameters:
node-set doc - The xd:doc node-set
node-set template - The xsl:template node-set for which the declaration should be printed

Functions Detail

xs:boolean xd:accessMatch (param: element(*)? element) - source
Determines if an element satisfies the access level specified for the documentation generation.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
element(*)? element - The element to check.
access - The access level. Defaults to the global xd:access parameter.
xs:string xd:decToBase (param: xs:integer decxs:string* digits) - source
Converts a decimal number to a string with another numeric base, given the set of digits.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
xs:integer dec - The decimal number.
xs:string* digits - The sequence of digits.
element(xd:doc)? xd:getDoc (param: element(*) element) - source
Returns the xd:doc node of an element.
Parameters:
element(*) element - The element can be one of the following:
  • xsl:stylesheet
  • xsl:transform
  • xsl:template
  • xsl:function
Returns the empty sequence if no xd:doc element was found for the given element.
element(xd:doc)* xd:getModeDoc (param: element(*) elementmode) - source
Returns the xd:doc nodes for the mode(s) of a template.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
element(*) element - The xsl:stylesheet or xsl:transform element.
mode -
modeAttr - The mode attribute.
xs:string* xd:getModes (param: element(*) element) - source
Returns a sequence of names of modes in a stylesheet.
This function returns both modes that are explicitly documented and modes that are implicitly used.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
element(*) element - The xsl:stylesheet or xsl:transform element.
element(xsl:template)* xd:getTemplatesByMode (param: element(*) elementxs:string mode) - source
Returns a sequence of templates using a given mode in a stylesheet.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
element(*) element - The xsl:stylesheet or xsl:transform element.
xs:string mode -
name - The mode name for which to search.
xd:printAttribute (param: att) - source
No short description available
Parameters:
att -
xd:printMatchTemplate (param: template) - source
No short description available
Parameters:
template -
xd:printMode (param: element(*) rootmode) - source
No short description available
Parameters:
element(*) root -
mode -
xd:printParamDeclaration (param: paramdoc) - source
Parameters:
param -
doc -
No short description available
Parameters:
set -
xs:string* xd:splitWhitespaceString (param: xs:string? string) - source
Splits a whitespace-separated string into a sequence.
Author:
Greg Beauchesne
Since:
09/2009
Parameters:
xs:string? string - The string to split.