tei-param.xsl

TEI stylesheet customization module for HTML output.
Author:
See AUTHORS
CVS Id:
tei-param.xsl 4801 2008-09-13 10:05:32Z rahtz
Copyright:
2008, TEI Consortium

Parameters Summary

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
string ID - source
An ID passed to the stylesheet to indicate which section to display
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
string URLPREFIX - source
A path fragment to put before all internal 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>
navbar - source
[html] Construction of navigation bar
navInterSep - source
No short description available
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 alignNavigationPanel - source
How to align the navigation panel at the bottom of the page
right
boolean autoEndNotes - source
Make all notes into endnotes
false
boolean autoToc - source
Make an automatic table of contents
true
boolean bottomNavigationPanel - source
Display navigation panel at bottom of pages
true
string class_ptr - source
CSS class for links derived from <ptr>
ptr
string class_ref - source
CSS class for links derived from <ref>
ref
string class_subtoc - source
CSS class for second-level TOC entries
subtoc
string class_xptr - source
CSS class for links derived from <xptr>
xptr
string class_xref - source
CSS class for links derived from <xref>
xref
boolean consecutiveFootnoteNumbers - source
Number footnotes consecutively
false
string contentStructure - source
How to use the front/body/back matter in creating columns.
body
anyURI cssFile - source
CSS style file to be associated with output file(s)
http://www.tei-c.org/release/xml/tei/stylesheet/tei.css
boolean cssFileInclude - source
Whether to include CSS by reference or by XInclusion
false
anyURI cssPrintFile - source
CSS style file for print; this will be given a media=print attribute
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.
integer divOffset - source
The difference between TEI div levels and HTML. headings.
2
string doctypePublic - source
Public Doctype of output file(s)
-//W3C//DTD HTML 4.0 Transitional//EN
string doctypeSystem - source
System Doctype of output file(s)
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.
96
anyURI feedbackURL - source
Link for feedback
mailto:feedback
boolean footnoteBackLink - source
Link back from footnotes to reference
false
boolean footnoteFile - source
Make a separate file for footnotes
false
boolean generateParagraphIDs - source
Generate a unique ID for all paragraphs
true
string htmlTitlePrefix - source
Fixed string to insert before normal page title in HTML meta <title> element
string ID - source
An ID passed to the stylesheet to indicate which section to display
boolean linkPanel - source
Make a panel with next page/previous page links
true
string linksWidth - source
Width of left-hand column when $pageLayout is "Table"
15%
anyURI navbarFile - source
XML resource defining a navigation bar.
boolean numberParagraphs - source
Automatically number paragraphs
false
string outputDir - source
Directory in which to place generated files
string outputEncoding - source
Encoding of output file(s)
iso-8859-1
string outputMethod - source
Output method for output file(s)
html
string outputName - source
The name of the output file
string outputSuffix - source
Suffix of output file(s)
.html
string pageLayout - source
The style of HTML (Simple, CSS or Table) which creates the layout for generated pages.
Simple
boolean rawXML - source
Pass through input essentially unchanged
false
string refDocFooterText - source
Text to link back to from foot of ODD reference pages
TEI Guidelines
anyURI refDocFooterURL - source
URL to link back to from foot of ODD reference pages
index.html
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
true
boolean showTitleAuthor - source
Show a title and author at start of document
false
boolean splitBackmatter - source
Break back matter into separate HTML pages (if splitting enabled)
true
boolean splitFrontmatter - source
Break front matter into separate HTML pages (if splitting enabled)
true
integer splitLevel - source
Level at which to split sections.
-1
string standardSuffix - source
Suffix for generated output files
.xml .html
integer subTocDepth - source
Depth at which to stop doing a recursive table of contents.
-1
boolean tocBack - source
Include the back matter in the table of contents
true
string tocContainerElement - source
Which HTML element to wrap each TOC sections in
div
string tocDepth - source
Depth to which table of contents is constructed
5
string tocElement - source
Which HTML element to wrap each TOCs entry in
p
boolean tocFront - source
Include the front matter in the table of contents
true
boolean topNavigationPanel - source
Display navigation panel at top of pages
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.
?ID=
string urlMarkup - source
HTML element to put around visible text of display URLs
span
string URLPREFIX - source
A path fragment to put before all internal URLs
boolean useIDs - source
Construct links using existing ID values.
true
boolean verbose - source
Be talkative while working
false
boolean virtualPages - source
Whether to make split pages appear virtually as layers in HTML, or physically as separate pages or server requests
false
boolean xhtml - source
Make XHTML-compatible markup
false

Named Templates Detail

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
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>.
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
navbar - source
[html] Construction of navigation bar
navInterSep - source
No short description available
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