Mode:

Compact lists

Showing:

Documentation
Parameters
Used by
References
Overriding
Imported from
Source
Stylesheet tei-param.xsl
Documentation

Description

TEI stylesheet customization module for HTML output.

This software is dual-licensed: 1. Distributed under a Creative Commons Attribution-ShareAlike 3.0 Unported License http://creativecommons.org/licenses/by-sa/3.0/ 2. http://www.opensource.org/licenses/BSD-2-Clause All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Author: See AUTHORS

Id: $Id: tei-param.xsl 10057 2012-01-21 16:57:14Z rahtz $

Copyright: 2011, TEI Consortium
Imported from
Stylesheet version 2.0
Template bodyHook
Documentation

Description

[html] Hook where HTML can be inserted just after <body>
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="bodyHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template bodyEndHook
Documentation

Description

[html] Hook where HTML can be inserted just before the <body> ends.

This can be used to add a page-wide footer block.
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="bodyEndHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template bodyJavascriptHook
Documentation

Description

[html] Hook where Javascript calls can be inserted just after <body>
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="bodyJavascriptHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template cssHook
Documentation

Description

[html] Hook where extra CSS can be inserted

 

Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="cssHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template headHook
Documentation

Description

[html] Hook where code can be added to the HTML <head>.

This would be used to insert <meta> tags.
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="headHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template imgHook
Documentation

Description

[html] Hook where HTML can be inserted when creating an <img>
Namespace No namespace
Used by
Template
showGraphic
Import precedence 2
Source
 
<xsl:template name="imgHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template figureHook
Documentation

Description

[html] Hook where HTML can be inserted when processing a figure
Namespace No namespace
Used by
Template
tei:figure
Import precedence 2
Source
 
<xsl:template name="figureHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template javascriptHook
Documentation

Description

[html] Hook where extra Javascript functions can be defined
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="javascriptHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template preAddressHook
Documentation

Description

[html] Hook where HTML can be inserted just before the <address>
Namespace No namespace
Used by
Template
stdfooter
Import precedence 2
Source
 
<xsl:template name="preAddressHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template startDivHook
Documentation

Description

[html] Hook where HTML can be inserted at the start of processing each section
Namespace No namespace
Used by
Template
doDivBody
Import precedence 2
Source
 
<xsl:template name="startDivHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template startHook
Documentation

Description

[html] Hook where HTML can be inserted at the beginning of the main text, after the header
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="startHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template teiEndHook
Documentation

Description

[html] Hook where HTML can be inserted after processing <TEI>
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="teiEndHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template teiStartHook
Documentation

Description

[html] Hook where HTML can be inserted before processing <TEI>
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="teiStartHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template xrefHook
Documentation

Description

[html] Hook where HTML can be inserted when creating an <a> element
Namespace No namespace
Used by
Template
makeExternalLink
Import precedence 2
Source
 
<xsl:template name="xrefHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template copyrightStatement
Documentation

Description

[html] Make a copyright claim
Namespace No namespace
Overriding
Import precedence 2
Source
 
<xsl:template name="copyrightStatement">This page is copyrighted</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template columnHeader
Documentation

Description

[html] Banner for top of column
Namespace No namespace
Used by
Template
rh-col-top
Import precedence 2
Source
 
<xsl:template name="columnHeader">
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template hdr
Documentation

Description

[html] Header section across top of page
Namespace No namespace
Used by
References
Template
pageHeader
Import precedence 2
Source
 
<xsl:template name="hdr">
  <xsl:call-template name="pageHeader">
    <xsl:with-param name="mode"/>
  </xsl:call-template>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template hdr2
Documentation

Description

[html] Navigation bar
Namespace No namespace
Used by
References
Template
navbar
Import precedence 2
Source
 
<xsl:template name="hdr2">
  <xsl:call-template name="navbar"/>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template preBreadCrumbPath
Documentation

Description

[html] Text or action to take at the start of the breadcrumb trail
Namespace No namespace
Used by
Template
crumbPath
Import precedence 2
Source
 
<xsl:template name="preBreadCrumbPath"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template hdr3
Documentation

Description

[html] Breadcrumb trail
Namespace No namespace
Used by
References
Template
crumbPath
Parameters
parentURL;
parentWords
Import precedence 2
Source
 
<xsl:template name="hdr3">
  <a href="#rh-col" title="Go to main page content" class="skiplinks">Skip links</a>
  <a class="hide">|</a>
  <xsl:call-template name="crumbPath"/>
  <a class="hide">|</a>
  <a class="bannerright" href="{$parentURL}" title="Go to home page">
    <xsl:value-of select="$parentWords"/>
  </a>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template lh-col-bottom
Documentation

Description

[html]Bottom of left-hand column

Parameters

currentID ID of selected section
Namespace No namespace
Used by
Template
bodyLayout
References
Template
leftHandFrame
Parameters
QName Namespace
currentID No namespace
Import precedence 2
Source
 
<xsl:template name="lh-col-bottom">
  <xsl:param name="currentID"/>
  <xsl:call-template name="leftHandFrame">
    <xsl:with-param name="currentID" select="$currentID"/>
  </xsl:call-template>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template lh-col-top
Documentation

Description

[html]Top of left-hand column
Namespace No namespace
Used by
Template
bodyLayout
References
Templates
printLink;
searchbox
Import precedence 2
Source
 
<xsl:template name="lh-col-top">
  <xsl:call-template name="searchbox"/>
  <xsl:call-template name="printLink"/>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template logoPicture
Documentation

Description

[html] Logo
Namespace No namespace
Import precedence 2
Source
 
<xsl:template name="logoPicture">
  <a class="framelogo" href="http://www.tei-c.org/Stylesheets/">
    <img src="http://www.tei-c.org/release/common2/doc/tei-xsl-common/teixsl.png" vspace="5" width="124" height="161" border="0" alt="created by TEI XSL Stylesheets"/>
  </a>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template metaHTML
Documentation

Description

[html] Making elements in HTML <head>

Parameters

title The text used to create the DC.Title field in the HTML header
Namespace No namespace
Used by
References
Parameters
QName Namespace
title No namespace
Import precedence 2
Source
 
<xsl:template name="metaHTML">
  <xsl:param name="title"/>
  <meta name="author">
    <xsl:attribute name="content">
      <xsl:call-template name="generateAuthor"/>
    </xsl:attribute>
  </meta>
  <xsl:if test="$filePerPage='true'">
    <meta name="viewport" content="width={$viewPortWidth}, height={$viewPortHeight}"/>
  </xsl:if>
  <meta name="generator" content="Text Encoding Initiative Consortium XSLT stylesheets"/>
  <xsl:choose>
    <xsl:when test="$outputTarget='html5' or $outputTarget='epub3'">
      <meta charset="utf-8"/>
    </xsl:when>
    <xsl:otherwise>
      <meta http-equiv="Content-Type" content="text/html; charset={$outputEncoding}"/>
      <meta name="DC.Title">
        <xsl:attribute name="content">
          <xsl:value-of select="normalize-space(translate($title,'<>','〈〉'))"/>
        </xsl:attribute>
      </meta>
      <meta name="DC.Type" content="Text"/>
      <meta name="DC.Format" content="text/html"/>
    </xsl:otherwise>
  </xsl:choose>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template navbar
Documentation

Description

[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>

Namespace No namespace
Used by
Template
hdr2
References
Import precedence 2
Source
 
<xsl:template name="navbar">
  <xsl:choose>
    <xsl:when test="$navbarFile=''">
      <xsl:comment>no nav bar</xsl:comment>
    </xsl:when>
    <xsl:otherwise>
      <xsl:element name="{if ($outputTarget='html5') then 'nav' else 'div'}">
        <xsl:for-each select="document($navbarFile,document(''))">
          <xsl:for-each select="tei:list/tei:item">
            <span class="navbar">
              <a href="{$URLPREFIX}{tei:xref/@url}" class="navbar">
                <xsl:apply-templates select="tei:xref/text()"/>
              </a>
            </span>
            <xsl:if test="following-sibling::tei:item">|</xsl:if>
          </xsl:for-each>
        </xsl:for-each>
      </xsl:element>
    </xsl:otherwise>
  </xsl:choose>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template pageHeader
Documentation

Description

[html] Banner for top of page

Parameters

mode layout mode
Namespace No namespace
Used by
Templates
hdr;
pageLayoutTable
References
Parameters
QName Namespace
mode No namespace
Import precedence 2
Source
 
<xsl:template name="pageHeader">
  <xsl:param name="mode"/>
  <xsl:choose>
    <xsl:when test="$mode='table'">
      <table width="100%" border="0">
        <tr>
          <td height="98" class="bgimage" onclick="window.location='{$homeURL}'" cellpadding="0">
            <xsl:call-template name="makeHTMLHeading">
              <xsl:with-param name="class">subtitle</xsl:with-param>
              <xsl:with-param name="text">
                <xsl:call-template name="generateSubTitle"/>
              </xsl:with-param>
              <xsl:with-param name="level">2</xsl:with-param>
            </xsl:call-template>
            <xsl:call-template name="makeHTMLHeading">
              <xsl:with-param name="class">title</xsl:with-param>
              <xsl:with-param name="text">
                <xsl:call-template name="generateTitle"/>
              </xsl:with-param>
              <xsl:with-param name="level">1</xsl:with-param>
            </xsl:call-template>
          </td>
          <td style="vertical-align:top;"/>
        </tr>
      </table>
    </xsl:when>
    <xsl:otherwise>
      <xsl:call-template name="makeHTMLHeading">
        <xsl:with-param name="class">subtitle</xsl:with-param>
        <xsl:with-param name="text">
          <xsl:call-template name="generateSubTitle"/>
        </xsl:with-param>
        <xsl:with-param name="level">2</xsl:with-param>
      </xsl:call-template>
      <xsl:call-template name="makeHTMLHeading">
        <xsl:with-param name="class">title</xsl:with-param>
        <xsl:with-param name="text">
          <xsl:call-template name="generateTitle"/>
        </xsl:with-param>
        <xsl:with-param name="level">1</xsl:with-param>
      </xsl:call-template>
    </xsl:otherwise>
  </xsl:choose>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template makeHTMLHeading
Documentation

Description

[html] Make a heading, if there some text to display

Parameters

text Heading title class CSS class level Heading level
Namespace No namespace
Used by
Templates
pageHeader;
stdheader
Parameters
QName Namespace
class No namespace
level No namespace
text No namespace
Import precedence 2
Source
 
<xsl:template name="makeHTMLHeading">
  <xsl:param name="text"/>
  <xsl:param name="class">title</xsl:param>
  <xsl:param name="level">1</xsl:param>
  <xsl:if test="not($text='')">
    <xsl:choose>
      <xsl:when test="$level > 6">
        <div class="h{$level}">
          <xsl:copy-of select="$text"/>
        </div>
      </xsl:when>
      <xsl:otherwise>
        <xsl:element name="h{$level}">
          <xsl:attribute name="class">
            <xsl:value-of select="$class"/>
          </xsl:attribute>
          <xsl:copy-of select="$text"/>
        </xsl:element>
      </xsl:otherwise>
    </xsl:choose>
  </xsl:if>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template printLink
Documentation
Namespace No namespace
Used by
Import precedence 2
Source
Stylesheet location ../xhtml2/tei-param.xsl
Template rh-col-bottom
Documentation

Description

[html] Bottom of right-hand column

Parameters

currentID ID of selected section
Namespace No namespace
Used by
Template
bodyLayout
References
Template
mainFrame
Parameters
QName Namespace
currentID No namespace
Import precedence 2
Source
 
<xsl:template name="rh-col-bottom">
  <xsl:param name="currentID"/>
  <xsl:call-template name="mainFrame">
    <xsl:with-param name="currentID" select="$currentID"/>
  </xsl:call-template>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template rh-col-top
Documentation

Description

[html] Top of right-hand column
Namespace No namespace
Used by
Template
bodyLayout
References
Template
columnHeader
Import precedence 2
Source
 
<xsl:template name="rh-col-top">
  <xsl:call-template name="columnHeader"/>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template searchbox
Documentation

Description

[html] Make a search box
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="searchbox"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template singleFileLabel
Documentation

Description

[html] Construct a label for the link which makes a printable version of the document.
Namespace No namespace
Import precedence 2
Source
 
<xsl:template name="singleFileLabel">For Printing</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template navInterSep
Documentation

Description

Gap between elements in navigation list
Namespace No namespace
Used by
Import precedence 2
Source
 
<xsl:template name="navInterSep">
  <xsl:text>: </xsl:text>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Template egXMLStartHook
Documentation

Description

[html] Hooks where HTML can be inserted when processing <egXML> element
Namespace No namespace
Used by
Template
teix:egXML
Import precedence 2
Source
 
<xsl:template name="egXMLStartHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template egXMLEndHook
Namespace No namespace
Used by
Template
teix:egXML
Import precedence 2
Source
 
<xsl:template name="egXMLEndHook"/>
Stylesheet location ../xhtml2/tei-param.xsl
Template emphasize
Namespace No namespace
Used by
Parameters
QName Namespace
class No namespace
content No namespace
Import precedence 2
Source
 
<xsl:template name="emphasize">
  <xsl:param name="class"/>
  <xsl:param name="content"/>
  <xsl:choose>
    <xsl:when test="$class='titlea'">
      <q class="titlea">
        <xsl:copy-of select="$content"/>
      </q>
    </xsl:when>
    <xsl:otherwise>
      <span class="{$class}">
        <xsl:copy-of select="$content"/>
      </span>
    </xsl:otherwise>
  </xsl:choose>
</xsl:template>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter class_ptr
Documentation

Description

CSS class for links derived from <ptr>
Namespace No namespace
Source
 
<xsl:param name="class_ptr">ptr</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter class_ref
Documentation

Description

CSS class for links derived from <ref>
Namespace No namespace
Source
 
<xsl:param name="class_ref">ref</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter filePerPage
Documentation

Description

Whether we should construct a separate file for each page (based on page breaks)
Namespace No namespace
Used by
Source
 
<xsl:param name="filePerPage">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter viewPortWidth
Documentation

Description

When making fixed format epub, width of viewport
Namespace No namespace
Used by
Template
metaHTML
Source
 
<xsl:param name="viewPortWidth">1200</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter viewPortHeight
Documentation

Description

When making fixed format epub, height of viewport
Namespace No namespace
Used by
Template
metaHTML
Source
 
<xsl:param name="viewPortHeight">1700</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter consecutiveFNs
Documentation

Description

Number footnotes consecutively
Namespace No namespace
Used by
Template
noteN
Source
 
<xsl:param name="consecutiveFNs">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter footnoteBackLink
Documentation
Namespace No namespace
Used by
Source
Stylesheet location ../xhtml2/tei-param.xsl
Parameter cssFileInclude
Documentation

Description

Whether to include CSS by reference or by XInclusion
Namespace No namespace
Source
 
<xsl:param name="cssFileInclude">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter cssFile
Documentation

Description

CSS style file to be associated with output file(s)
Namespace No namespace
Type xs:string
Overriding
Parameter
cssFile
Source
 
<xsl:param name="cssFile" as="xs:string">http://www.tei-c.org/release/xml/tei/stylesheet/tei.css</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter cssPrintFile
Documentation

Description

CSS style file for print; this will be given a media=print attribute.
Namespace No namespace
Type xs:string
Used by
Template
includeCSS
Source
 
<xsl:param name="cssPrintFile" as="xs:string">http://www.tei-c.org/release/xml/tei/stylesheet/tei-print.css</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter cssSecondaryFile
Documentation

Description

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.
Namespace No namespace
Select ''
Type xs:string
Used by
Template
includeCSS
Source
 
<xsl:param name="cssSecondaryFile" as="xs:string" select="''"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter cssInlineFile
Documentation

Description

CSS file to include in the output file directly
Namespace No namespace
Select ''
Type xs:string
Used by
Template
includeCSS
Source
 
<xsl:param name="cssInlineFile" as="xs:string" select="''"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter dpi
Documentation

Description

Resolution of images. This is needed to calculate HTML width and height (in pixels) from supplied dimensions.
Namespace No namespace
Used by
Template
setDimension
Source
 
<xsl:param name="dpi">96</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter showFigures
Documentation

Description

Display figures.
Namespace No namespace
Used by
Template
showGraphic
Source
 
<xsl:param name="showFigures">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter contentStructure
Documentation

Description

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

Namespace No namespace
Used by
Template
mainPage
Source
 
<xsl:param name="contentStructure">body</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter divOffset
Documentation

Description

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>

Namespace No namespace
Used by
Template
divContents
Source
 
<xsl:param name="divOffset">2</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter footnoteFile
Documentation

Description

Make a separate file for footnotes
Namespace No namespace
Used by
Source
 
<xsl:param name="footnoteFile">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter linksWidth
Documentation

Description

Width of left-hand column when $pageLayout is "Table"
Namespace No namespace
Used by
Source
 
<xsl:param name="linksWidth">15%</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter navbarFile
Documentation

Description

XML resource defining a navigation bar.

The XML should provide a <list> containing a series of <item> elements, each containing an <xref> link.

Namespace No namespace
Used by
Template
navbar
Source
 
<xsl:param name="navbarFile"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter alignNavigationPanel
Documentation

Description

How to align the navigation panel at the bottom of the page
Namespace No namespace
Source
 
<xsl:param name="alignNavigationPanel">right</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter bottomNavigationPanel
Documentation

Description

Display navigation panel at bottom of pages
Namespace No namespace
Overriding
Source
 
<xsl:param name="bottomNavigationPanel">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter feedbackURL
Documentation

Description

Link for feedback
Namespace No namespace
Used by
Template
stdfooter
Source
 
<xsl:param name="feedbackURL">mailto:feedback</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter htmlTitlePrefix
Documentation

Description

Fixed string to insert before normal page title in HTML meta <title> element
Namespace No namespace
Used by
Source
 
<xsl:param name="htmlTitlePrefix"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter linkPanel
Documentation

Description

Make a panel with next page/previous page links.
Namespace No namespace
Overriding
Parameter
linkPanel
Source
 
<xsl:param name="linkPanel">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter generateParagraphIDs
Documentation

Description

Generate a unique ID for all paragraphs
Namespace No namespace
Used by
Templates
rendToClass;
tei:item
Source
 
<xsl:param name="generateParagraphIDs">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter rendSeparator
Documentation

Description

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.

Namespace No namespace
Used by
Templates
applyRend;
rendering
Source
 
<xsl:param name="rendSeparator">;</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter showTitleAuthor
Documentation

Description

Show a title and author at start of document
Namespace No namespace
Used by
Template
stdheader
Source
 
<xsl:param name="showTitleAuthor">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter verbose
Documentation

Description

Be talkative while working.
Namespace No namespace
Used by
Source
 
<xsl:param name="verbose">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter autoEndNotes
Documentation

Description

Make all notes into endnotes
Namespace No namespace
Used by
Source
 
<xsl:param name="autoEndNotes">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter ID
Documentation

Description

An ID passed to the stylesheet to indicate which section to display
Namespace No namespace
Used by
Parameter
requestedID
Source
 
<xsl:param name="ID"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter requestedID
Documentation

Description

A wrapper around the ID, to allow for other ways of getting it
Namespace No namespace
Used by
References
Parameter
ID
Source
 
<xsl:param name="requestedID">
  <xsl:value-of select="$ID"/>
</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter URLPREFIX
Documentation

Description

A path fragment to put before all internal URLs
Namespace No namespace
Used by
Template
navbar
Source
 
<xsl:param name="URLPREFIX"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputName
Documentation

Description

The name of the output file
Namespace No namespace
Used by
Variable
masterFile
Source
 
<xsl:param name="outputName"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputDir
Documentation

Description

Directory in which to place generated files.
Namespace No namespace
Used by
Template
outputChunkName
Source
 
<xsl:param name="outputDir"/>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputEncoding
Documentation

Description

Encoding of output file(s).
Namespace No namespace
Overriding
Parameter
outputEncoding
Source
 
<xsl:param name="outputEncoding">utf-8</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputNamespace
Namespace No namespace
Used by
Source
 
<xsl:param name="outputNamespace">http://www.w3.org/1999/xhtml</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputMethod
Documentation

Description

Output method for output file(s).
Namespace No namespace
Overriding
Parameter
outputMethod
Source
 
<xsl:param name="outputMethod">xhtml</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter outputSuffix
Documentation

Description

Suffix of output file(s).
Namespace No namespace
Overriding
Parameter
outputSuffix
Source
 
<xsl:param name="outputSuffix">.html</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter doctypePublic
Documentation

Description

Public Doctype of output file(s).
Namespace No namespace
Overriding
Parameter
doctypePublic
Source
 
<xsl:param name="doctypePublic">-//W3C//DTD XHTML 1.0 Transitional//EN</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter doctypeSystem
Documentation

Description

System Doctype of output file(s).
Namespace No namespace
Overriding
Parameter
doctypeSystem
Source
 
<xsl:param name="doctypeSystem">http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter pageLayout
Documentation

Description

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

Namespace No namespace
Used by
Source
 
<xsl:param name="pageLayout">Simple</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter splitBackmatter
Documentation

Description

Break back matter into separate HTML pages (if splitting enabled).
Namespace No namespace
Used by
Source
 
<xsl:param name="splitBackmatter">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter splitFrontmatter
Documentation

Description

Break front matter into separate HTML pages (if splitting enabled).
Namespace No namespace
Used by
Source
 
<xsl:param name="splitFrontmatter">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter splitLevel
Documentation

Description

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.

Namespace No namespace
Overriding
Parameter
splitLevel
Source
 
<xsl:param name="splitLevel">-1</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter standardSuffix
Documentation

Description

Suffix for generated output files.
Namespace No namespace
Used by
References
Parameters
STDOUT;
outputSuffix
Source
 
<xsl:param name="standardSuffix">
  <xsl:choose>
    <xsl:when test="tei:teiCorpus">.html</xsl:when>
    <xsl:when test="$STDOUT='true'"/>
    <xsl:otherwise>
      <xsl:value-of select="$outputSuffix"/>
    </xsl:otherwise>
  </xsl:choose>
</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter topNavigationPanel
Documentation

Description

Display navigation panel at top of pages.
Namespace No namespace
Overriding
Parameter
topNavigationPanel
Source
 
<xsl:param name="topNavigationPanel">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter urlChunkPrefix
Documentation

Description

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.
Namespace No namespace
Used by
Template
*generateLink
Source
 
<xsl:param name="urlChunkPrefix">?ID=</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter useIDs
Documentation

Description

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.

Namespace No namespace
Used by
Template
*ident
Source
 
<xsl:param name="useIDs">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter urlMarkup
Documentation

Description

HTML element to put around visible text of display URLs
Namespace No namespace
Used by
Template
makeExternalLink
Source
 
<xsl:param name="urlMarkup">span</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter autoToc
Documentation

Description

Make an automatic table of contents
Namespace No namespace
Used by
Source
 
<xsl:param name="autoToc">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter class_subtoc
Documentation

Description

CSS class for second-level TOC entries
Namespace No namespace
Used by
Template
subtoc
Source
 
<xsl:param name="class_subtoc">subtoc</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter subTocDepth
Documentation

Description

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.

Namespace No namespace
Overriding
Parameter
subTocDepth
Source
 
<xsl:param name="subTocDepth">-1</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter tocBack
Documentation

Description

Include the back matter in the table of contents.
Namespace No namespace
Used by
Template
mainTOC
Source
 
<xsl:param name="tocBack">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter tocDepth
Documentation

Description

Depth to which table of contents is constructed.
Namespace No namespace
Used by
Template
tei:*maketoc
Source
 
<xsl:param name="tocDepth">5</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter tocFront
Documentation

Description

Include the front matter in the table of contents.
Namespace No namespace
Used by
Template
mainTOC
Source
 
<xsl:param name="tocFront">true</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter tocElement
Documentation

Description

Which HTML element to wrap each TOCs entry in.
Namespace No namespace
Used by
Template
tocEntry
Source
 
<xsl:param name="tocElement">p</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter tocContainerElement
Documentation

Description

Which HTML element to wrap each TOC sections in.
Namespace No namespace
Used by
Template
linkListContents
Source
 
<xsl:param name="tocContainerElement">div</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter refDocFooterText
Documentation

Description

Text to link back to from foot of ODD reference pages
Namespace No namespace
Source
 
<xsl:param name="refDocFooterText">TEI Guidelines</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter refDocFooterURL
Documentation

Description

URL to link back to from foot of ODD reference pages
Namespace No namespace
Source
 
<xsl:param name="refDocFooterURL">index.html</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter autoBlockQuote
Documentation

Description

Whether it should be attempted to make quotes into block quotes if they are over a certain length
Namespace No namespace
Used by
Template
tei:quote
Source
 
<xsl:param name="autoBlockQuote">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter autoBlockQuoteLength
Documentation

Description

Length beyond which a quote is a block quote
Namespace No namespace
Used by
Template
tei:quote
Source
 
<xsl:param name="autoBlockQuoteLength">150</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Parameter mediaoverlay
Namespace No namespace
Used by
Template
rendToClass
Source
 
<xsl:param name="mediaoverlay">false</xsl:param>
Stylesheet location ../xhtml2/tei-param.xsl
Key INDEX
Namespace No namespace
Match tei:index
Use 1
Used by
Source
 
<xsl:key name="INDEX" use="1" match="tei:index"/>
Stylesheet location ../xhtml2/tei-param.xsl
Key PB
Namespace No namespace
Match tei:pb
Use 1
Source
 
<xsl:key name="PB" match="tei:pb" use="1"/>
Stylesheet location ../xhtml2/tei-param.xsl
Key NOTES
Namespace No namespace
Match tei:note[@place='foot' or @place='bottom' or @place='end' and not(parent::tei:bibl or ancestor::tei:teiHeader)]
Use 1
Used by
Template
printNotes
Source
 
<xsl:key name="NOTES" use="1" match="tei:note[@place='foot' or @place='bottom' or @place='end'     and not(parent::tei:bibl or ancestor::tei:teiHeader)]"/>
Stylesheet location ../xhtml2/tei-param.xsl
Key ALLNOTES
Namespace No namespace
Match tei:note[not(@place='margin' or @place='inline' or @place='display') and not(parent::tei:bibl or ancestor::tei:teiHeader)]
Use 1
Used by
Template
printNotes
Source
 
<xsl:key name="ALLNOTES" use="1" match="tei:note[not(@place='margin' or @place='inline' or @place='display')     and not(parent::tei:bibl or  ancestor::tei:teiHeader)]"/>
Stylesheet location ../xhtml2/tei-param.xsl
Key TAGREND
Namespace No namespace
Match tei:tagUsage[@render]
Use @gi
Used by
Templates
rendToClass;
tei:hi
Source
 
<xsl:key name="TAGREND" match="tei:tagUsage[@render]" use="@gi"/>
Stylesheet location ../xhtml2/tei-param.xsl
Stylesheet documentation generated by ® XML Editor.