This section describes how to produce a customization of the TEI stylesheets. It describes all the parameters which you can set, the templates which are designed to be changed, and the empty templates provided into which you can add your own code.
There are 13 areas for customization. In most cases there are parameters and templates which are specific to one of the three output methods (HTML, FO and LaTeX), and those which are common to all three.
You can simply refer to the specification xhtml2/tei.xsl directly with your XSL processor, or install it locally on your own server. For more flexibility, you may prefer to reference the specifications from an XSL wrapper of your own. The minimal specification would look like this:
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> <xsl:import href="xhtml2/tei.xsl"/> </xsl:stylesheet>
You can customize the result by adding to this wrapper file. The normal result will be a single stream of HTML which you can save in a file. You can also configure it to produce multiple output files, one per top-level <div> or <div1>.
The default behaviour of the system is to construct each HTML page with per-page navigation bars top and bottom, and a standard set of navigation links underneath.
| Type | Name | Description | Default |
| department | Name of department within institution [string] | ||
| homeLabel | Name of link to home page of application [string] | Home | |
| homeURL | Project Home [anyURI] | http://www.tei-c.org/ | |
| homeWords | Project [string] | TEI | |
| institution | Institution [string] | A TEI Project | |
| parentURL | Institution link [anyURI] | http://www.tei-c.org/ | |
| parentWords | Name of overall institution [string] | Parent Institution | |
| searchURL | Link to search application [anyURI] | http://www.google.com | |
| xhtml | alignNavigationPanel | How to align the navigation panel at the bottom of the page [string] | right |
| xhtml | bottomNavigationPanel | Display navigation panel at bottom of pages [boolean] | true |
| xhtml | feedbackURL | Link for feedback [anyURI] | mailto:feedback |
| xhtml | htmlTitlePrefix | Fixed string to insert before normal page title in HTML meta <title> element [string] | |
| xhtml | linkPanel | Make a panel with next page/previous page links. [boolean] | true |
There are a few ways to provide a constant navigation aid, with a table of links on the left or right.
Hypertext links present special problems, as we have to choose whether they should start a new window, occupy all of the current window, or stay within the frame. These stylesheets implement the following rules:
| Type | Name | Description | Default |
| consecutiveFNs | Number footnotes consecutively [boolean] | false | |
| autoEndNotes | Make all notes into endnotes [boolean] | false | |
| oddWeaveLite | Whether to make simplified display of ODD [boolean] | false | |
| parIndent | Paragraph indentation [string] | 1em | |
| biblioStyle | Style for formatted bibliography [string] | ||
| parSkip | Default spacing between paragraphs [string] | 0pt | |
| xhtml | filePerPage | Whether we should construct a separate file for each page (based on page breaks) [boolean] | false |
| xhtml | viewPortWidth | When making fixed format epub, width of viewport [number] | 1200 |
| xhtml | viewPortHeight | When making fixed format epub, height of viewport [number] | 1700 |
| xhtml | footnoteBackLink | Link back from footnotes to reference [boolean] | false |
| xhtml | contentStructure | 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 columnbody: use <body> for right-hand column, generate left-hand with a TOC or whatever [string] | body |
| xhtml | divOffset | 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 <div1> will generate an <h2> [integer] | 2 |
| xhtml | footnoteFile | Make a separate file for footnotes [boolean] | false |
| xhtml | linksWidth | Width of left-hand column when $pageLayout is "Table" [string] | 15% |
| xhtml | navbarFile | XML resource defining a navigation bar. The XML should provide a <list> containing a series of <item> elements, each containing an <xref> link. [anyURI] | |
| fo | backMulticolumns | Put back matter in multiple columns [boolean] | false |
| fo | bodyMarginBottom | Margin at bottom of text body [string] | 24pt |
| fo | bodyMarginTop | Margin at top of text body [string] | 24pt |
| fo | bodyMulticolumns | Put body matter in multiple columns [boolean] | false |
| fo | bulletFour | Symbol for 4th level itemized list [string] | + |
| fo | bulletOne | Symbol for top-level itemized list [string] | • |
| fo | bulletThree | Symbol for 3rd level itemized list [string] | * |
| fo | bulletTwo | Symbol for 2nd level itemized list [string] | – |
| fo | columnCount | Number of columns, when multiple-column work is requested [integer] | 1 |
| fo | betweenStarts | XSL FO "provisional-distance-between starts" [string] | 18pt |
| fo | betweenGlossStarts | XSL FO "provisional-distance-between starts" for gloss lists [string] | 42pt |
| fo | betweenBiblStarts | XSL FO "provisional-distance-between starts" for bibliographies [string] | 14pt |
| fo | divRunningheads | Display section headings in running heads [boolean] | false |
| fo | exampleAfter | Space below examples [string] | 4pt |
| fo | exampleBefore | Space above examples [string] | 4pt |
| fo | exampleMargin | Left margin for examples [string] | 12pt |
| fo | flowMarginLeft | Left margin of flow [string] | |
| fo | forcePageMaster | Which named page master name to use [string] | |
| fo | formatBackpage | How to format page numbers in back matter (use XSLT number format) [string] | 1 |
| fo | formatBodypage | How to format page numbers in main matter (use XSLT number format) [string] | 1 |
| fo | formatFrontpage | How to format page numbers in front matter (use XSLT number format) [string] | i |
| fo | frontMulticolumns | Put front matter in multiple columns [boolean] | false |
| fo | labelSeparation | XSL FO "provisional-label-separation" [string] | 6pt |
| fo | listAbove-1 | Space above lists at top level [string] | 6pt |
| fo | listAbove-2 | Space above lists at 2nd level [string] | 4pt |
| fo | listAbove-3 | Space above lists at 3rd level [string] | 0pt |
| fo | listAbove-4 | Space above lists at 4th level [string] | 0pt |
| fo | listBelow-1 | Space below lists at top level [string] | 6pt |
| fo | listBelow-2 | Space below lists at 2nd level [string] | 4pt |
| fo | listBelow-3 | Space below lists at 3rd level [string] | 0pt |
| fo | listBelow-4 | Space below lists at 4th level [string] | 0pt |
| fo | listItemsep | Spacing between list items [string] | 4pt |
| fo | listLeftGlossIndent | Left margin for gloss lists [string] | 0.5in |
| fo | listLeftGlossInnerIndent | Left margin for nested gloss lists [string] | 0.25in |
| fo | listLeftIndent | Indentation for lists [string] | 0pt |
| fo | listRightMargin | Right margin for lists [string] | 10pt |
| fo | pageHeight | Paper height [string] | 297mm |
| fo | pageMarginBottom | Margin at bottom of text area [string] | 100pt |
| fo | pageMarginLeft | Left margin [string] | 80pt |
| fo | pageMarginRight | Right margin [string] | 150pt |
| fo | pageMarginTop | Margin at top of text area [string] | 75pt |
| fo | pageWidth | Paper width [string] | 211mm |
| fo | parSkipmax | Maximum space allowed between paragraphs [string] | 12pt |
| fo | readColSpecFile | External XML file containing specifications for column sizes for tables in document [anyURI] | |
| fo | regionAfterExtent | Region after [string] | 14pt |
| fo | regionBeforeExtent | Region before [string] | 14pt |
| fo | sectionHeaders | Construct running headers from page number and section headings [boolean] | true |
| fo | spaceAfterBibl | Space after bibliography [string] | 0pt |
| fo | spaceAroundTable | Space above and below a table [string] | 8pt |
| fo | spaceBeforeBibl | Space above bibliography [string] | 4pt |
| fo | spaceBelowCaption | Space below caption of figure or table [string] | 4pt |
| fo | titlePage | Make title page [boolean] | true |
| fo | twoSided | Make 2-page spreads [boolean] | true |
| latex | classParameters | Optional parameters for documentclass [string] | 11pt,twoside |
| latex | latexLogo | Logo graphics file [string] | |
| latex | pagebreakStyle | When processing a "pb" element, decide what to generate: "active" generates a page break; "visible" generates a bracketed number (with scissors), and "bracketsonly" generates a bracketed number (without scissors). [float] | |
| latex | tableMaxWidth | When making a table, what width must be constrained to fit, as a proportion of the page width. [float] | 0.85 |
| latex | verseNumbering | Whether to number lines of poetry [boolean] | false |
| latex | everyHowManyLines | When numbering poetry, how often to put in a line number [integer] | 5 |
| latex | resetVerseLineNumbering | When numbering poetry, when to restart the sequence; this must be the name of a TEI element [string] | div1 |
| latex | latexPaperSize | LaTeX paper size [ | a4paper |
Headings for sections can be customized in various ways.
| Type | Name | Description | Default |
| autoHead | Whether to construct a heading for <div> elements with no <head> - by default, not. [boolean] | false | |
| numberSpacer | Character to put after number of section header [string] | ||
<xsl:text
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/> | |||
Section headings, figures, tables and notes can be numbered automatically. We can set the numbering of front matter and back matter separately. If you prefer to supply your own numbering, using the n attribute, you can choose this over automatic numbering.
Normally, heading numbers are followed by ‘. ’, but you can vary this. This would let you use eg fixed spaces.
| Type | Name | Description | Default |
| numberBackFigures | Automatically number figures in back matter [boolean] | false | |
| numberBackHeadings | How to construct heading numbering in back matter [string] | A.1 | |
| numberBackTables | Automatically number tables in back matter [boolean] | true | |
| numberFigures | Automatically number figures [boolean] | true | |
| numberFrontFigures | Automatically number figures in front matter [boolean] | false | |
| numberFrontHeadings | How to construct heading numbering in front matter [string] | ||
| numberFrontTables | Automatically number tables in front matter [boolean] | true | |
| numberHeadings | Automatically number sections [boolean] | true | |
| numberHeadingsDepth | Depth to which sections should be numbered [integer] | 9 | |
| numberTables | Automatically number tables [boolean] | true | |
| prenumberedHeadings | Use value of "n" attribute to number sections [boolean] | false | |
| numberParagraphs | Automatically number paragraphs. [boolean] | false |
You can set a name for the output file(s); if you ask for multiple output files, this name will be used to create unique filenames for each section. By default, results will go to wherever your XSLT processor normally writes (usually standard output). If you opt to have files created, you can specify the name of the directory where the output is to be placed.
If you are making HTML, do you want a single output page, or a separate one for each section of the document? You can decide to have a different splitting policy for front and back matter.
| Type | Name | Description | Default |
| outputTarget | Type of output being generated [string] | html | |
| REQUEST | The complete URL when the document is being delivered from a web server (normally set by Apache or Cocoon) [string] | ||
| STDOUT | Write to standard output channel [boolean] | true | |
| xhtml | ID | An ID passed to the stylesheet to indicate which section to display [string] | |
| xhtml | requestedID | A wrapper around the ID, to allow for other ways of getting it [string] | |
<xsl:value-of
select="$ID"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/> | |||
| xhtml | URLPREFIX | A path fragment to put before all internal URLs [string] | |
| xhtml | outputName | The name of the output file [string] | |
| xhtml | outputDir | Directory in which to place generated files. [string] | |
| xhtml | outputEncoding | Encoding of output file(s). [string] | utf-8 |
| xhtml | outputMethod | Output method for output file(s). [string] | xhtml |
| xhtml | outputSuffix | Suffix of output file(s). [string] | .html |
| xhtml | doctypePublic | Public Doctype of output file(s). [string] | -//W3C//DTD XHTML 1.0 Transitional//EN |
| xhtml | doctypeSystem | System Doctype of output file(s). [string] | http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd |
| xhtml | pageLayout | The style of HTML (Simple, CSS or Table) which creates the layout for generated pages. The choice is between Simple: A linear presentation is createdCSS: The page is created as a series of nested <div>s which can be arranged using CSS into a multicolumn layoutTable: The page is created as an HTML table [string] | Simple |
| xhtml | splitBackmatter | Break back matter into separate HTML pages (if splitting enabled). [boolean] | true |
| xhtml | splitFrontmatter | Break front matter into separate HTML pages (if splitting enabled). [boolean] | true |
| xhtml | splitLevel | 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 <div1>, setting this parameter to 0 will cause top-level sections to be split apart. The default is not to split at all. [integer] | -1 |
| xhtml | standardSuffix | Suffix for generated output files. [string] | |
<xsl:choose
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:when
test="tei:teiCorpus">.html</xsl:when>
<xsl:when
test="$STDOUT='true'"/>
<xsl:otherwise>
<xsl:value-of
select="$outputSuffix"/>
</xsl:otherwise>
</xsl:choose> | |||
| xhtml | topNavigationPanel | Display navigation panel at top of pages. [boolean] | true |
| xhtml | urlChunkPrefix | 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. [string] | ?ID= |
| xhtml | useIDs | 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. [boolean] | true |
| fo | language | Language (for hyphenation) [string] | en_US |
| fo | foEngine | Name of intended XSL FO engine This is used to tailor the result for different XSL FO processors. By default, no special measures are taken, so there are no bookmarks or other such features. Possible values are passivetex (the TeX-based PassiveTeX processor) xep (XEP) fop (FOP) antenna (Antenna House) [string] | |
| latex | ORIGDIR | location of original XML file, for looking up relative pointers [string] | |
| latex | baseURL | URL root where referenced documents are located [string] | |
| latex | reencode | Whether or not to load LaTeX packages which attempt to process the UTF-8 characters. Set to "false" if you are using XeTeX or similar. [boolean] | true |
| latex | realFigures | Use real name of graphics files rather than pointers [boolean] | true |
You probably want tables of contents built for your document, using the <div> structure. However, if you have used a <divGen type="toc"> explicitly, that will also create a table of contents, so you can suppress the automatic one. When a table of contents is created, you choose how many levels of headings it will show. You can choose whether or not the front and backmatter appear in the table of contents.
| Type | Name | Description | Default |
| xhtml | autoToc | Make an automatic table of contents [boolean] | true |
| xhtml | class_subtoc | CSS class for second-level TOC entries [string] | subtoc |
| xhtml | subTocDepth | 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. [integer] | -1 |
| xhtml | tocBack | Include the back matter in the table of contents. [boolean] | true |
| xhtml | tocDepth | Depth to which table of contents is constructed. [string] | 5 |
| xhtml | tocFront | Include the front matter in the table of contents. [boolean] | true |
| xhtml | tocElement | Which HTML element to wrap each TOCs entry in. [string] | p |
| xhtml | tocContainerElement | Which HTML element to wrap each TOC sections in. [string] | div |
| xhtml | refDocFooterText | Text to link back to from foot of ODD reference pages [string] | TEI Guidelines |
| xhtml | refDocFooterURL | URL to link back to from foot of ODD reference pages [anyURI] | index.html |
| xhtml | generateDivFromP | When a TEI <p> generates an HTML <p> (possibly split) or a <div class="p"> [boolean] | false |
| fo | div0Tocindent | Indentation for level 0 TOC entries [string] | 0in |
| fo | div1Tocindent | Indentation for level 1 TOC entries [string] | 0.25in |
| fo | div2Tocindent | Indentation for level 2 TOC entries [string] | 0.5in |
| fo | div3Tocindent | Indentation for level 3 TOC entries [string] | 0.75in |
| fo | div4Tocindent | Indentation for level 4 TOC entries [string] | 1in |
| fo | div5Tocindent | Indentation for level 5 TOC entries [string] | 1.25in |
| fo | tocBack | Make TOC for sections in <back> [boolean] | true |
| fo | tocFront | Make TOC for sections in <front> [boolean] | true |
| fo | tocNumberSuffix | Punctuation to insert after a section number in a TOC [string] | . |
| fo | tocStartPage | Page number on which TOC should start [integer] | 1 |
At various places, the system has to create text. You can choose the words it uses (eg translate them to another language).
| Type | Name | Description | Default |
Setting up material for the CSS file to accompany HTML output.
| Type | Name | Description | Default |
| class_toc | CSS class for TOC entries [string] | toc | |
| xhtml | class_ptr | CSS class for links derived from <ptr> [string] | ptr |
| xhtml | class_ref | CSS class for links derived from <ref> [string] | ref |
| xhtml | cssFile | CSS style file to be associated with output file(s) [anyURI] | http://www.tei-c.org/release/xml/tei/stylesheet/tei.css |
| xhtml | cssPrintFile | CSS style file for print; this will be given a media=print attribute. [anyURI] | http://www.tei-c.org/release/xml/tei/stylesheet/tei-print.css |
| xhtml | cssSecondaryFile | 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. [anyURI] | |
| xhtml | cssInlineFile | CSS file to include in the output file directly [anyURI] |
Default behaviour of table elements.
| Type | Name | Description | Default |
| cellAlign | Default alignment of table cells [string] | left | |
| tableAlign | Default alignment of tables [string] | left | |
| fo | defaultCellLabelBackground | Default colour for background of table cells which are labelling rows or columns [string] | silver |
| fo | inlineTables | Force tables to appear inline [boolean] | false |
| fo | makeTableCaption | Put a caption on tables [boolean] | true |
| fo | tableCaptionAlign | Alignment of table captions [string] | center |
| fo | tableCellPadding | Default padding on table cells [string] | 2pt |
Sometimes you need to prefix the names of all graphics files with a directory name or a URL, or provide a default suffix. You can also tell <figure> elements whether or not to produce anything.
| Type | Name | Description | Default |
| graphicsPrefix | Directory specification to put before names of graphics files, unless they start with "./" [string] | ||
| graphicsSuffix | Default file suffix for graphics files, if not directly specified [string] | .png | |
| standardScale | Scaling of imported graphics [decimal] | 1 | |
| headInXref | [common] Whether cross-reference to a figure or table includes its caption [boolean] | true | |
| xhtml | dpi | Resolution of images. This is needed to calculate HTML width and height (in pixels) from supplied dimensions. [integer] | 96 |
| xhtml | showFigures | Display figures. [boolean] | true |
| fo | autoScaleFigures | How to scale figures if no width and height specified (pass to XSL FO content-width) [string] | |
| fo | captionInlineFigures | Put captions on inline figures [boolean] | false |
| fo | showFloatHead | Show the contents of <head> in a cross-reference to table or figure [boolean] | false |
| fo | showFloatLabel | Show a title for figures or tables (eg Table or Figure) in a cross-reference [boolean] | false |
| fo | xrefShowPage | Show the page number in a cross-reference to table or figure [boolean] | false |
You can choose lots of features which affect the font, size, etc
| Type | Name | Description | Default |
| pagebreakStyle | Display of <pb> element. Choices are "visible", "active" and "none". [string] | visible | |
| displayMode | How to display Relax NG schema fragments (rnc or rng) [string] | rnc | |
| minimalCrossRef | Provide minimal context for a link [boolean] | false | |
| postQuote | Character to insert at end of quote. [string] | ’ | |
| preQuote | Character to insert at start of quote [string] | ‘ | |
| xhtml | urlMarkup | HTML element to put around visible text of display URLs [string] | span |
| fo | activeLinebreaks | Make <lb> active (ie cause a line break) [boolean] | true |
| fo | alignment | Alignment of text (ie justified or ragged) [string] | justify |
| fo | biblSize | Font size for bibliography [string] | 16pt |
| fo | bodyFont | Default font for body [string] | Times |
| fo | bodyMaster | Default font size for body (without dimension) [string] | 10 |
| fo | bodySize | Calculation of normal body font size (add dimension) [string] | |
<xsl:value-of
select="$bodyMaster"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/>
<xsl:text>pt</xsl:text> | |||
| fo | divFont | Font for section headings [string] | Times |
| fo | exampleColor | Colour for display of <eg> blocks. [string] | black |
| fo | exampleBackgroundColor | Colour for background display of <eg> blocks. [string] | gray |
| fo | exampleSize | Calculation of font size for examples (add dimension) [string] | |
<xsl:value-of
select="$bodyMaster * 0.6"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/>
<xsl:text>pt</xsl:text> | |||
| fo | quoteSize | Calculation of font size for quotations [string] | |
<xsl:value-of
select="$bodyMaster * 0.9"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/>
<xsl:text>pt</xsl:text> | |||
| fo | footnoteSize | Font size for footnotes [string] | |
<xsl:value-of
select="$bodyMaster * 0.9"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/> | |||
| fo | footnotenumSize | Font size for footnote numbers [string] | |
<xsl:value-of
select="$bodyMaster * 0.7"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/> | |||
| fo | giColor | Colour for display of element names [string] | black |
| fo | headingOutdent | Indentation of headings [string] | 0em |
| fo | hyphenate | Hyphenate text [boolean] | true |
| fo | identColor | Colour for display of <ident> values Customization parameter. [string] | black |
| fo | runFont | Font family for running header and footer [string] | sans-serif |
| fo | runSize | Font size for running header and footer [string] | 9pt |
| fo | sansFont | Sans-serif font [string] | Helvetica |
| fo | smallSize | Calculation of small font size (add dimension) [string] | |
<xsl:value-of
select="$bodyMaster * 0.9"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/>
<xsl:text>pt</xsl:text> | |||
| fo | tableSize | Create font size for tables, by reference to $bodyMaster [string] | |
<xsl:value-of
select="$bodyMaster * 0.9"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"/>
<xsl:text>pt</xsl:text> | |||
| fo | tocSize | Font size for TOC heading [string] | 16pt |
| fo | typewriterFont | Font for literal code [string] | Courier |
| latex | typewriterFont | Font for literal code [string] | DejaVu Sans Mono |
| latex | sansFont | Font for sans-serif [string] | |
| latex | romanFont | Font for serif [string] | |
| latex | gothicFont | Font for gothic [string] | Lucida Blackletter |
| latex | calligraphicFont | Font for calligraphic [string] | Lucida Calligraphy |
A set of templates which are empty by default; they can be used to add code at strategic points. The content must be valid XSLT.
| Type | Name | Description | Default |
Finally, some miscellaneous or advanced features which you probably won't use much.
| Type | Name | Description | Default |
| teixslHome | The home page for these stylesheets [anyURI] | http://www.tei-c.org/Stylesheets/ | |
| teiP4Compat | Process elements according to assumptions of TEI P4 [boolean] | false | |
| xhtml | generateParagraphIDs | Generate a unique ID for all paragraphs [boolean] | false |
| xhtml | rendSeparator | Character separating values in a rend attribute. Some projects use multiple values in rend attributes. These are handled, but the separator character(s) must be specified. [string] | ; |
| xhtml | showTitleAuthor | Show a title and author at start of document [boolean] | false |
| xhtml | verbose | Be talkative while working. [boolean] | false |