core.xsl

Core XSLTdoc Stylesheet
This stylesheet
Author:
ibirrer
CVS Id:
core.xsl 43 2009-11-07 13:02:24Z ibirrer
Copyright:
2004, P&P Software GmbH
XSLT Version:
2.0
Namespace Prefix Summary:
util - http://www.pnp-software.com/util
xd - http://www.pnp-software.com/XSLTdoc
xdt - http://www.pnp-software.com/XSLTdocTemplate
xs - http://www.w3.org/2001/XMLSchema
xsl - http://www.w3.org/1999/XSL/Transform

Outputs Summary

#default - source
No short description available
text - source
No short description available

Parameters Summary

xs:string* additionalCSS - source
Custom Stylesheets
string targetDir - source
The directory in which the documentation should be generated.

Template Modes Summary

#default
No short description available
enhancePageAttributes
No short description available
htmlTemplate
No short description available
namspace2xhtml
No short description available
renderContent
No short description available

Match Templates Summary

/XSLTdocConfig (param: element() config [tunnel=yes], mode: #default) - source
Root template if XSLTdocConfig file is used
/xsl:stylesheet | /xsl:transform (param: element() config [tunnel=yes], mode: #default) - source
Root template if XSLTdocConfig file is not used; if the input is a stylesheet
* (mode: enhancePageAttributes) - source
No short description available
page (mode: enhancePageAttributes) - source
No short description available
* (param: config [tunnel=yes], currentPage [tunnel=yes], mode: htmlTemplate) - source
Identity template for XSLTdoc templates
xdt:content (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:content element in the html template
xdt:cssDeclaration (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:cssDeclaration element in the html template
xdt:menuLinks (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:menuLinks element in the html template
xdt:siteTitle (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
Renders the site title
* (mode: namspace2xhtml) - source
No short description available
page[@id='functionTemplateList'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'functionTemplateList'
page[@id='mainPage'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'mainPage'
page[@id='stylesheetList'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'stylesheetList'
page[parent::pagelist[@id='stylesheets']] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This stylesheet renders the content for pages definded in the 'stylesheet' pagelist

Named Templates Summary

element()* buildStylesheetPagelist (param: xs:string stylesheetUri, xs:string rootUri, xs:string targetUri) - source
Builds a list of all stylesheet files by following the include and import links in each stylesheet
void generatePages (param: element() config) - source
Generates each page given in the config parameter

Outputs Detail

#default - source
No short description available
Attributes
indent
yes
method
xml
text - source
No short description available
Attributes
encoding
UTF-8

Parameters Detail

xs:string* additionalCSS - source
Custom Stylesheets
Add additional (custom) css stylesheets here to override css rules from the standard css file (XSLTdoc.css).
string targetDir - source
The directory in which the documentation should be generated.
The directory given must be relative to root stylesheet which is being processed. This parameter is used to compute the variable $targetDirUriAbs. If this parameter is not set the $targetDirUriAbs variable defaults to the directory 'doc', which is created inside the same directory in which the input stylesheet occurs.
Only used if the input is a stylesheet file. Not used if the input is a XSLTdocConfig XML file.

Template Modes Detail

#default
No short description available
Templates Using This Mode:
/XSLTdocConfig
/xsl:stylesheet | /xsl:transform
enhancePageAttributes
No short description available
Templates Using This Mode:
*
page
htmlTemplate
No short description available
Templates Using This Mode:
*
xdt:content
xdt:cssDeclaration
xdt:menuLinks
xdt:siteTitle
namspace2xhtml
No short description available
Templates Using This Mode:
*
renderContent
No short description available
Templates Using This Mode:
page[@id='functionTemplateList']
page[@id='mainPage']
page[@id='stylesheetList']
page[parent::pagelist[@id='stylesheets']]

Match Templates Detail

/XSLTdocConfig (param: element() config [tunnel=yes], mode: #default) - source
Root template if XSLTdocConfig file is used
Parameters:
element() config [tunnel=yes] -
/xsl:stylesheet | /xsl:transform (param: element() config [tunnel=yes], mode: #default) - source
Root template if XSLTdocConfig file is not used; if the input is a stylesheet
Parameters:
element() config [tunnel=yes] -
* (mode: enhancePageAttributes) - source
No short description available
page (mode: enhancePageAttributes) - source
No short description available
* (param: config [tunnel=yes], currentPage [tunnel=yes], mode: htmlTemplate) - source
Identity template for XSLTdoc templates
Parameters:
config [tunnel=yes] -
currentPage [tunnel=yes] -
xdt:content (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:content element in the html template
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
xdt:cssDeclaration (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:cssDeclaration element in the html template
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
xdt:menuLinks (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
This template replaces the xdt:menuLinks element in the html template
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
xdt:siteTitle (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: htmlTemplate) - source
Renders the site title
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
* (mode: namspace2xhtml) - source
No short description available
page[@id='functionTemplateList'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'functionTemplateList'
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
page[@id='mainPage'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'mainPage'
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
page[@id='stylesheetList'] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This templates creates the content for a page with the name 'stylesheetList'
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -
Namespace Prefix Summary:
#default - http://www.w3.org/1999/xhtml
page[parent::pagelist[@id='stylesheets']] (param: element() config [tunnel=yes], element() currentPage [tunnel=yes], mode: renderContent) - source
This stylesheet renders the content for pages definded in the 'stylesheet' pagelist
It just applies the template rules to the root element of the stylesheets linked in the page element. This calls the template rules defined in stylesheet.xsl.
Parameters:
element() config [tunnel=yes] -
element() currentPage [tunnel=yes] -

Named Templates Detail

element()* buildStylesheetPagelist (param: xs:string stylesheetUri, xs:string rootUri, xs:string targetUri) - source
Builds a list of all stylesheet files by following the include and import links in each stylesheet
Parameters:
xs:string stylesheetUri - The URI of the stylesheet from which indcludes/imports should be followed to find files.
xs:string rootUri - The root directory to which relative paths should be built to.
xs:string targetUri -
void generatePages (param: element() config) - source
Generates each page given in the config parameter
Parameters:
element() config -