The Text Encoding Initiative

TEI Consortium XSLT stylesheets

Home | Guidelines | Projects | Tutorials | Software | History | FAQs | P5 | Consortium | Activities | SIGs | Join in/Contact | Members area

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
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
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>
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>
Number footnotes consecutively
How to use the front/body/back matter in creating columns.
anyURI cssFile - source
CSS style file to be associated with output file(s)
Whether to include CSS by reference or by XInclusion
CSS style file for print; this will be given a media=print attribute
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.
Public Doctype of output file(s)
System Doctype of output file(s)
integer dpi - source
Resolution of images
Link for feedback
Link back from footnotes to reference
boolean footnoteFile - source
Make a separate file for footnotes
Generate a unique ID for all paragraphs
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.
Automatically number paragraphs
string outputDir - source
Directory in which to place generated files
Encoding of output file(s)
Output method for output file(s)
string outputName - source
The name of the output file
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
Text to link back to from foot of ODD reference pages
URL to link back to from foot of ODD reference pages
Character separating values in a rend attribute.
A wrapper around the ID, to allow for other ways of getting it
boolean showFigures - source
Display figures
Show a title and author at start of document
Break back matter into separate HTML pages (if splitting enabled)
Break front matter into separate HTML pages (if splitting enabled)
integer splitLevel - source
Level at which to split sections.
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
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
Display navigation panel at top of pages
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

[html] Hook where HTML can be inserted just before the <body> ends.
[html] Hook where HTML can be inserted just after <body>
[html] Hook where Javascript calls can be inserted just after <body>
[html] Banner for top of column
[html] Make a copyright claim
[html] Hook where extra CSS can be inserted
No short description available
[html] Hooks where HTML can be inserted when processing <egXML> element
emphasize (param: classcontent) - source
No short description available
[html] Hook where HTML can be inserted when processing a figure
[html] Header section across top of page
[html] Navigation bar
[html] Breadcrumb trail
[html] Hook where code can be added to the HTML <head>.
[html] Hook where HTML can be inserted when creating an <img>
[html] Hook where extra Javascript functions can be defined
lh-col-bottom (param: currentID) - source
[html]Bottom of left-hand column
[html]Top of left-hand column
[html] Logo
makeHTMLHeading (param: textclasslevel) - source
[html] Make a heading, if there some text to display
metaHTML (param: title) - source
[html] Making elements in HTML <head>
No short description available
[html] Construction of navigation bar
pageHeader (param: mode) - source
[html] Banner for top of page
[html] Hook where HTML can be inserted just before the <address>
[html] Text or action to take at the start of the breadcrumb trail
[html] Make a link saying how to get printable version of file
rh-col-bottom (param: currentID) - source
[html] Bottom of right-hand column
[html] Top of right-hand column
[html] Make a search box
[html] Construct a label for the link which makes a printable version of the document.
[html] Hook where HTML can be inserted at the start of processing each section
[html] Hook where HTML can be inserted at the beginning of the main text, after the header
[html] Hook where HTML can be inserted after processing <TEI>
[html] Hook where HTML can be inserted before processing <TEI>
[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:
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
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
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
Number footnotes consecutively
 
Default: false
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
Whether to include CSS by reference or by XInclusion
 
Default: false
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
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
Public Doctype of output file(s)
Default: -//W3C//DTD HTML 4.0 Transitional//EN
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
Link for feedback
 
Default: mailto:feedback
Link back from footnotes to reference
 
Default: false
boolean footnoteFile - source
Make a separate file for footnotes
 
Default: false
Generate a unique ID for all paragraphs
 
Default: true
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:
Automatically number paragraphs
Default: false
string outputDir - source
Directory in which to place generated files
Default:
Encoding of output file(s)
Default: iso-8859-1
Output method for output file(s)
Default: html
string outputName - source
The name of the output file
 
Default:
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
Text to link back to from foot of ODD reference pages
 
Default: TEI Guidelines
URL to link back to from foot of ODD reference pages
 
Default: index.html
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: ;
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
Show a title and author at start of document
 
Default: false
Break back matter into separate HTML pages (if splitting enabled)
Default: true
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
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
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
Display navigation panel at top of pages
Default: true
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

[html] Hook where HTML can be inserted just before the <body> ends.
This can be used to add a page-wide footer block.
[html] Hook where HTML can be inserted just after <body>
 
[html] Hook where Javascript calls can be inserted just after <body>
 
[html] Banner for top of column
 
[html] Make a copyright claim
 
[html] Hook where extra CSS can be inserted
 
No short description available
[html] Hooks where HTML can be inserted when processing <egXML> element
 
emphasize (param: classcontent) - source
No short description available
Parameters:
class -
content -
[html] Hook where HTML can be inserted when processing a figure
 
[html] Header section across top of page
 
[html] Navigation bar
 
[html] Breadcrumb trail
 
[html] Hook where code can be added to the HTML <head>.
This would be used insert <meta> tags.
[html] Hook where HTML can be inserted when creating an <img>
 
[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
[html]Top of left-hand column
 
[html] Logo
 
makeHTMLHeading (param: textclasslevel) - 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
No short description available
[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
[html] Hook where HTML can be inserted just before the <address>
 
[html] Text or action to take at the start of the breadcrumb trail
 
[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
[html] Top of right-hand column
 
[html] Make a search box
 
[html] Construct a label for the link which makes a printable version of the document.
 
[html] Hook where HTML can be inserted at the start of processing each section
 
[html] Hook where HTML can be inserted at the beginning of the main text, after the header
 
[html] Hook where HTML can be inserted after processing <TEI>
 
[html] Hook where HTML can be inserted before processing <TEI>
 
[html] Hook where HTML can be inserted when creating an <a> element