stylesheet.xsl

Includes

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 41 2009-01-10 11:31:18Z ibirrer
Copyright:
2004, P&P Software GmbH

Match Templates Summary

xsl:stylesheet (mode: attSetsDetail) - source
JK, 11/2007 - Outputs title for attribute sets details and creates detailed documentation for each attribute set
xsl:stylesheet (mode: attSetsSummary) - source
JK, 11/2007 Generates attribute set summary section
xsl:stylesheet (mode: functionsDetail) - source
Outputs title for function details and creates detailed documentation for each function
xsl:stylesheet (mode: functionsSummary) - source
Generates function summary section
xsl:stylesheet (mode: keysDetail) - source
SM, 05/12/2007 - Outputs title for keys and creates detailed documentation for each key
xsl:stylesheet (mode: keysSummary) - source
SM, 05/12/2007 Generates key summary section
xsl:stylesheet (mode: matchTemplatesDetail) - source
Outputs title for match template details and creates detailed documentation for each match template
xsl:stylesheet (mode: matchTemplatesSummary) - source
Generates match template summary section
xsl:stylesheet (mode: namedTemplatesDetail) - source
Outputs title for named template details and creates detailed documentation for each named template
xsl:stylesheet (mode: namedTemplatesSummary) - source
Generates template summary section
xsl:stylesheet (mode: parametersDetail) - source
Outputs title for parameter details and creates detailed documentation for each parameter
xsl:stylesheet (mode: parametersSummary) - source
Generates parameter summary section
xsl:function | xsl:template | xsl:param | xsl:variable | xsl:attribute-set | xsl:key (param: link, verbatimUriRelmode: printDeclaration) - source
Prints the declaration of a function or template
xsl:function | xsl:template | xsl:stylesheet | xsl:param | xsl:variable | xsl:attribute-set | xsl:key (mode: printDetailDescription) - source
Prints the detail description of a xd:doc element.
xsl:function | xsl:template | xsl:stylesheet | xsl:attribute-set (mode: printProperties) - source
Prints the properties of a xd:doc element.
* (mode: printProperty) - source
Overwrites XSLT default rules.
* (mode: printShortDescription) - source
Prints the short description of a documented xsl function or template.
/xsl:stylesheet (mode: stylesheet) - source
Calls sub-templates for each part of the stylesheet documentation.
xsl:stylesheet (mode: stylesheetDetail) - source
Prints details of the stylesheet
xsl:stylesheet (mode: variablesDetail) - source
JK, 11/2007 - Outputs title for variables details and creates detailed documentation for each variable
xsl:stylesheet (mode: variablesSummary) - source
JK, 11/2007 Generates variable summary section
* (mode: XdocTags) - source
Default template in XdocTags mode
xd:* (mode: XdocTags) - source
Default template in XdocTags mode for elements in xd namespace
xd:link (mode: XdocTags) - source
Converts a xd:link element to a html link

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: name, type, mode) - source
No short description available
printTemplateDeclaration (param: node-set doc, node-set template) - source
Prints the short form of the declaration of a template

Functions Summary

element(xd:doc)? xd:getDoc (param: element(*) element) - source
Returns the xd:doc node of an element.
xd:printAttribute (param: att) - source
No short description available
xd:printParamDeclaration (param: param, doc) - source
xd:printUseAttributeSets (param: set) - source
No short description available

Match Templates Detail

xsl:stylesheet (mode: attSetsDetail) - source
JK, 11/2007 - Outputs title for attribute sets details and creates detailed documentation for each attribute set
xsl:stylesheet (mode: attSetsSummary) - source
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
xsl:stylesheet (mode: functionsDetail) - source
Outputs title for function details and creates detailed documentation for each function
xsl:stylesheet (mode: functionsSummary) - source
Generates function summary section
Prints title of the section and then iterates through all functions and prints its declaration and short description
xsl:stylesheet (mode: keysDetail) - source
SM, 05/12/2007 - Outputs title for keys and creates detailed documentation for each key
xsl:stylesheet (mode: keysSummary) - source
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
xsl:stylesheet (mode: matchTemplatesDetail) - source
Outputs title for match template details and creates detailed documentation for each match template
xsl:stylesheet (mode: matchTemplatesSummary) - source
Generates match template summary section
Prints title of the section and then iterates through all templates and prints its declaration and short description
xsl:stylesheet (mode: namedTemplatesDetail) - source
Outputs title for named template details and creates detailed documentation for each named template
xsl:stylesheet (mode: namedTemplatesSummary) - source
Generates template summary section
Prints title of the section and then iterates through all templates and prints its declaration and short description
xsl:stylesheet (mode: parametersDetail) - source
Outputs title for parameter details and creates detailed documentation for each parameter
xsl:stylesheet (mode: parametersSummary) - source
Generates parameter summary section
Prints title of the section and then iterates through all parameters and prints its declaration and short description
xsl:function | xsl:template | xsl:param | xsl:variable | xsl:attribute-set | xsl:key (param: link, verbatimUriRelmode: printDeclaration) - source
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
verbatimUriRel -
xsl:function | xsl:template | xsl:stylesheet | xsl:param | xsl:variable | xsl:attribute-set | xsl:key (mode: printDetailDescription) - source
Prints the detail description of a xd:doc element.
If no detail description is found, the string "No detail description available" is printed
xsl:function | xsl:template | xsl:stylesheet | xsl:attribute-set (mode: printProperties) - source
Prints the properties of a xd:doc element.
* (mode: printProperty) - source
Overwrites XSLT default rules.
This ensures that tags not handled in the mode printProperty are not printed.
* (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.
/xsl:stylesheet (mode: stylesheet) - source
Calls sub-templates for each part of the stylesheet documentation.
xsl:stylesheet (mode: stylesheetDetail) - source
Prints details of the stylesheet
xsl:stylesheet (mode: variablesDetail) - source
JK, 11/2007 - Outputs title for variables details and creates detailed documentation for each variable
xsl:stylesheet (mode: variablesSummary) - source
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
* (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
xd:link (mode: XdocTags) - source
Converts a xd:link element to a html link
(JK, 11/2007)

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: name, type, mode) - source
No short description available
Parameters:
name -
type -
mode -
printTemplateDeclaration (param: node-set doc, node-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

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:template
  • xsl:function
Returns the empty sequence if no xd:doc element was found for the given element.
xd:printAttribute (param: att) - source
No short description available
Parameters:
att -
xd:printParamDeclaration (param: param, doc) - source
Parameters:
param -
doc -
xd:printUseAttributeSets (param: set) - source
No short description available
Parameters:
set -