TEI Stylesheet family - tei-param.xsl

## The Text Encoding Initiative

# TEI Consortium XSLT stylesheets

Home | Guidelines | Projects | Tutorials | Software | History | FAQs | P5 | Consortium | Activities | SIGs | Join in/Contact | Members area
Stylesheet home page Summary Stylesheet List Template List

# tei-param.xsl

TEI stylesheet customization module for HTML output.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Author:
See AUTHORS
CVS Id:
tei-param.xsl 4801 2008-09-13 10:05:32Z rahtz
Copyright:
2008, TEI Consortium

## Parameters Summary

string ID - source
An ID passed to the stylesheet to indicate which section to display
string URLPREFIX - source
A path fragment to put before all internal URLs
string alignNavigationPanel - source
How to align the navigation panel at the bottom of the page
boolean autoEndNotes - source
Make all notes into endnotes
boolean autoToc - source
Make an automatic table of contents
boolean bottomNavigationPanel - source
Display navigation panel at bottom of pages
string class_ptr - source
CSS class for links derived from <ptr>
string class_ref - source
CSS class for links derived from <ref>
string class_subtoc - source
CSS class for second-level TOC entries
string class_xptr - source
CSS class for links derived from <xptr>
string class_xref - source
CSS class for links derived from <xref>
boolean consecutiveFootnoteNumbers - source
Number footnotes consecutively
string contentStructure - source
How to use the front/body/back matter in creating columns.
anyURI cssFile - source
CSS style file to be associated with output file(s)
boolean cssFileInclude - source
Whether to include CSS by reference or by XInclusion
anyURI cssPrintFile - source
CSS style file for print; this will be given a media=print attribute
anyURI cssSecondaryFile - source
Secondary CSS style file; this will be given a media=screen attribute, so that it does not affect printing
integer divOffset - source
The difference between TEI div levels and HTML. headings.
string doctypePublic - source
Public Doctype of output file(s)
string doctypeSystem - source
System Doctype of output file(s)
integer dpi - source
Resolution of images
anyURI feedbackURL - source
Link for feedback
boolean footnoteBackLink - source
Link back from footnotes to reference
boolean footnoteFile - source
Make a separate file for footnotes
boolean generateParagraphIDs - source
Generate a unique ID for all paragraphs
string htmlTitlePrefix - source
Fixed string to insert before normal page title in HTML meta <title> element
boolean linkPanel - source
Make a panel with next page/previous page links
string linksWidth - source
Width of left-hand column when $pageLayout is "Table"
anyURI navbarFile - source
XML resource defining a navigation bar.
boolean numberParagraphs - source
Automatically number paragraphs
string outputDir - source
Directory in which to place generated files
string outputEncoding - source
Encoding of output file(s)
string outputMethod - source
Output method for output file(s)
string outputName - source
The name of the output file
string outputSuffix - source
Suffix of output file(s)
string pageLayout - source
The style of HTML (Simple, CSS or Table) which creates the layout for generated pages.
boolean rawXML - source
Pass through input essentially unchanged
string refDocFooterText - source
Text to link back to from foot of ODD reference pages
anyURI refDocFooterURL - source
URL to link back to from foot of ODD reference pages
string rendSeparator - source
Character separating values in a rend attribute.
string requestedID - source
A wrapper around the ID, to allow for other ways of getting it
boolean showFigures - source
Display figures
boolean showTitleAuthor - source
Show a title and author at start of document
boolean splitBackmatter - source
Break back matter into separate HTML pages (if splitting enabled)
boolean splitFrontmatter - source
Break front matter into separate HTML pages (if splitting enabled)
integer splitLevel - source
Level at which to split sections.
string standardSuffix - source
Suffix for generated output files
integer subTocDepth - source
Depth at which to stop doing a recursive table of contents.
boolean tocBack - source
Include the back matter in the table of contents
string tocContainerElement - source
Which HTML element to wrap each TOC sections in
string tocDepth - source
Depth to which table of contents is constructed
string tocElement - source
Which HTML element to wrap each TOCs entry in
boolean tocFront - source
Include the front matter in the table of contents
boolean topNavigationPanel - source
Display navigation panel at top of pages
string urlChunkPrefix - source
How to specify infra-document links
string urlMarkup - source
HTML element to put around visible text of display URLs
boolean useIDs - source
Construct links using existing ID values.
boolean verbose - source
Be talkative while working
boolean virtualPages - source
Whether to make split pages appear virtually as layers in HTML, or physically as separate pages or server requests
boolean xhtml - source
Make XHTML-compatible markup

## Named Templates Summary

bodyEndHook - source
[html] Hook where HTML can be inserted just before the <body> ends.
bodyHook - source
[html] Hook where HTML can be inserted just after <body>
bodyJavascriptHook - source
[html] Hook where Javascript calls can be inserted just after <body>
columnHeader - source
[html] Banner for top of column
copyrightStatement - source
[html] Make a copyright claim
cssHook - source
[html] Hook where extra CSS can be inserted
egXMLEndHook - source
No short description available
egXMLStartHook - source
[html] Hooks where HTML can be inserted when processing <egXML> element
emphasize (param: class, content) - source
No short description available
figureHook - source
[html] Hook where HTML can be inserted when processing a figure
hdr - source
[html] Header section across top of page
hdr2 - source
[html] Navigation bar
hdr3 - source
[html] Breadcrumb trail
headHook - source
[html] Hook where code can be added to the HTML <head>.
imgHook - source
[html] Hook where HTML can be inserted when creating an <img>
javascriptHook - source
[html] Hook where extra Javascript functions can be defined
lh-col-bottom (param: currentID) - source
[html]Bottom of left-hand column
lh-col-top - source
[html]Top of left-hand column
logoPicture - source
[html] Logo
makeHTMLHeading (param: text, class, level) - source
[html] Make a heading, if there some text to display
metaHTML (param: title) - source
[html] Making elements in HTML <head>
navInterSep - source
No short description available
navbar - source
[html] Construction of navigation bar
pageHeader (param: mode) - source
[html] Banner for top of page
preAddressHook - source
[html] Hook where HTML can be inserted just before the <address>
preBreadCrumbPath - source
[html] Text or action to take at the start of the breadcrumb trail
printLink - source
[html] Make a link saying how to get printable version of file
rh-col-bottom (param: currentID) - source
[html] Bottom of right-hand column
rh-col-top - source
[html] Top of right-hand column
searchbox - source
[html] Make a search box
singleFileLabel - source
[html] Construct a label for the link which makes a printable version of the document.
startDivHook - source
[html] Hook where HTML can be inserted at the start of processing each section
startHook - source
[html] Hook where HTML can be inserted at the beginning of the main text, after the header
teiEndHook - source
[html] Hook where HTML can be inserted after processing <TEI>
teiStartHook - source
[html] Hook where HTML can be inserted before processing <TEI>
xrefHook - source
[html] Hook where HTML can be inserted when creating an <a> element

## Parameters Detail

string ID - source
An ID passed to the stylesheet to indicate which section to display
Default:
string URLPREFIX - source
A path fragment to put before all internal URLs
Default:
string alignNavigationPanel - source
How to align the navigation panel at the bottom of the page
Default: right
boolean autoEndNotes - source
Make all notes into endnotes
Default: false
boolean autoToc - source
Make an automatic table of contents
Default: true
boolean bottomNavigationPanel - source
Display navigation panel at bottom of pages
Default: true
string class_ptr - source
CSS class for links derived from <ptr>
Default: ptr
string class_ref - source
CSS class for links derived from <ref>
Default: ref
string class_subtoc - source
CSS class for second-level TOC entries
Default: subtoc
string class_xptr - source
CSS class for links derived from <xptr>
Default: xptr
string class_xref - source
CSS class for links derived from <xref>
Default: xref
boolean consecutiveFootnoteNumbers - source
Number footnotes consecutively
Default: false
string contentStructure - source
How to use the front/body/back matter in creating columns.
The choice is between

all
  use <front> for left-hand column, use <body> for centre column, and use <back> for right-hand column
body
  use <body> for right-hand column, generate left-hand with a TOC or whatever

Default: body
anyURI cssFile - source
CSS style file to be associated with output file(s)
Default: http://www.tei-c.org/release/xml/tei/stylesheet/tei.css
boolean cssFileInclude - source
Whether to include CSS by reference or by XInclusion
Default: false
anyURI cssPrintFile - source
CSS style file for print; this will be given a media=print attribute
Default: http://www.tei-c.org/release/xml/tei/stylesheet/tei-print.css
anyURI cssSecondaryFile - source
Secondary CSS style file; this will be given a media=screen attribute, so that it does not affect printing
It should be used for screen layout.
Default:
integer divOffset - source
The difference between TEI div levels and HTML. headings.
TEI <div>s are implicitly or explicitly numbered from 0 upwards; this offset is added to that number to produce an HTML <Hn> element. So a value of 2 here means that a <div0> will generate an <h2>
Default: 2
string doctypePublic - source
Public Doctype of output file(s)
Default: -//W3C//DTD HTML 4.0 Transitional//EN
string doctypeSystem - source
System Doctype of output file(s)
Default: http://www.w3.org/TR/html4/loose.dtd
integer dpi - source
Resolution of images
This is needed to calculate HTML width and height (in pixels) from supplied dimensions.
Default: 96
anyURI feedbackURL - source
Link for feedback
Default: mailto:feedback
boolean footnoteBackLink - source
Link back from footnotes to reference
Default: false
boolean footnoteFile - source
Make a separate file for footnotes
Default: false
boolean generateParagraphIDs - source
Generate a unique ID for all paragraphs
Default: true
string htmlTitlePrefix - source
Fixed string to insert before normal page title in HTML meta <title> element
Default:
boolean linkPanel - source
Make a panel with next page/previous page links
Default: true
string linksWidth - source
Width of left-hand column when $pageLayout is "Table"
Default: 15%
anyURI navbarFile - source
XML resource defining a navigation bar.
The XML should provide a <list> containing a series of <item> elements, each containing an <xref> link.
Default:
boolean numberParagraphs - source
Automatically number paragraphs
Default: false
string outputDir - source
Directory in which to place generated files
Default:
string outputEncoding - source
Encoding of output file(s)
Default: iso-8859-1
string outputMethod - source
Output method for output file(s)
Default: html
string outputName - source
The name of the output file
Default:
string outputSuffix - source
Suffix of output file(s)
Default: .html
string pageLayout - source
The style of HTML (Simple, CSS or Table) which creates the layout for generated pages.
The choice is between

Simple
  A linear presentation is created
CSS
  The page is created as a series of nested <div>s which can be arranged using CSS into a multicolumn layout
Table
  The page is created as an HTML table

Default: Simple
boolean rawXML - source
Pass through input essentially unchanged
Default: false
string refDocFooterText - source
Text to link back to from foot of ODD reference pages
Default: TEI Guidelines
anyURI refDocFooterURL - source
URL to link back to from foot of ODD reference pages
Default: index.html
string rendSeparator - source
Character separating values in a rend attribute.
Some projects use multiple values in `rend` attributes. These are handled, but the separator character must be specified.
Default: ;
string requestedID - source
A wrapper around the ID, to allow for other ways of getting it
Default: <value-of select="$ID"/>
boolean showFigures - source
Display figures
Default: true
boolean showTitleAuthor - source
Show a title and author at start of document
Default: false
boolean splitBackmatter - source
Break back matter into separate HTML pages (if splitting enabled)
Default: true
boolean splitFrontmatter - source
Break front matter into separate HTML pages (if splitting enabled)
Default: true
integer splitLevel - source
Level at which to split sections.
When processing a <div> or <div[0-5]>, compare the nesting depth and see whether to start a new HTML page. Since the TEI starts with <div0>, setting this parameter to 0 will cause top-level sections to be split apart. The default is not to split at all.
Default: -1
string standardSuffix - source
Suffix for generated output files
Default: <choose> <when test="$rawXML='true'">.xml</when> <when test="tei:teiCorpus">.html</when> <when test="$STDOUT='true'"/> <otherwise> <value-of select="$outputSuffix"/> </otherwise> </choose>
integer subTocDepth - source
Depth at which to stop doing a recursive table of contents.
You can have a mini table of contents at the start of each section. The default is only to construct a TOC at the top level; a value of -1 here means no subtoc at all.
Default: -1
boolean tocBack - source
Include the back matter in the table of contents
Default: true
string tocContainerElement - source
Which HTML element to wrap each TOC sections in
Default: div
string tocDepth - source
Depth to which table of contents is constructed
Default: 5
string tocElement - source
Which HTML element to wrap each TOCs entry in
Default: p
boolean tocFront - source
Include the front matter in the table of contents
Default: true
boolean topNavigationPanel - source
Display navigation panel at top of pages
Default: true
string urlChunkPrefix - source
How to specify infra-document links
When a document is split, links need to be constructed between parts of the document. The default is to use a query parameter on the URL.
Default: ?ID=
string urlMarkup - source
HTML element to put around visible text of display URLs
Default: span
boolean useIDs - source
Construct links using existing ID values.
It is often nice if, when making separate files, their names correspond to the ID attribute of the >div<. Alternatively, you can let the system choose names.
Default: true
boolean verbose - source
Be talkative while working
Default: false
boolean virtualPages - source
Whether to make split pages appear virtually as layers in HTML, or physically as separate pages or server requests
Default: false
boolean xhtml - source
Make XHTML-compatible markup
Default: false

## Named Templates Detail

bodyEndHook - source
[html] Hook where HTML can be inserted just before the <body> ends.
This can be used to add a page-wide footer block.
bodyHook - source
[html] Hook where HTML can be inserted just after <body>
bodyJavascriptHook - source
[html] Hook where Javascript calls can be inserted just after <body>
columnHeader - source
[html] Banner for top of column
copyrightStatement - source
[html] Make a copyright claim
cssHook - source
[html] Hook where extra CSS can be inserted
egXMLEndHook - source
No short description available
egXMLStartHook - source
[html] Hooks where HTML can be inserted when processing <egXML> element
emphasize (param: class, content) - source
No short description available
Parameters:
class -
content -
figureHook - source
[html] Hook where HTML can be inserted when processing a figure
hdr - source
[html] Header section across top of page
hdr2 - source
[html] Navigation bar
hdr3 - source
[html] Breadcrumb trail
headHook - source
[html] Hook where code can be added to the HTML <head>.
This would be used insert <meta> tags.
imgHook - source
[html] Hook where HTML can be inserted when creating an <img>
javascriptHook - source
[html] Hook where extra Javascript functions can be defined
lh-col-bottom (param: currentID) - source
[html]Bottom of left-hand column
Parameters:
currentID - ID of selected section
lh-col-top - source
[html]Top of left-hand column
logoPicture - source
[html] Logo
makeHTMLHeading (param: text, class, level) - source
[html] Make a heading, if there some text to display
Parameters:
text - Heading title
class - CSS class
level - Heading level
metaHTML (param: title) - source
[html] Making elements in HTML <head>
Parameters:
title - The text used to create the DC.Title field in the HTML header
navInterSep - source
No short description available
navbar - source
[html] Construction of navigation bar
A file is looked for relative to the stylesheet (the second parameter of the document function), which is expected to contain a TEI <list> where each <item> has an embedded <xref>
pageHeader (param: mode) - source
[html] Banner for top of page
Parameters:
mode - layout mode
preAddressHook - source
[html] Hook where HTML can be inserted just before the <address>
preBreadCrumbPath - source
[html] Text or action to take at the start of the breadcrumb trail
printLink - source
[html] Make a link saying how to get printable version of file
rh-col-bottom (param: currentID) - source
[html] Bottom of right-hand column
Parameters:
currentID - ID of selected section
rh-col-top - source
[html] Top of right-hand column
searchbox - source
[html] Make a search box
singleFileLabel - source
[html] Construct a label for the link which makes a printable version of the document.
startDivHook - source
[html] Hook where HTML can be inserted at the start of processing each section
startHook - source
[html] Hook where HTML can be inserted at the beginning of the main text, after the header
teiEndHook - source
[html] Hook where HTML can be inserted after processing <TEI>
teiStartHook - source
[html] Hook where HTML can be inserted before processing <TEI>
xrefHook - source
[html] Hook where HTML can be inserted when creating an <a> element