blob: 9935214c21e2eacec4ffc8bc9d86c203b75efae9 [file] [log] [blame]
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl=""
exclude-result-prefixes="doc dyn saxon"
<!-- ********************************************************************
This file is part of the XSL DocBook Stylesheet distribution.
See ../README or for
copyright and other information.
******************************************************************** -->
<doc:reference xmlns="" xml:id="charmap">
<title>Common » Character-Map Template Reference</title>
<releaseinfo role="meta">
<!-- * yes, partintro is a valid child of a reference... -->
<partintro xml:id="partintro">
<para>This is technical reference documentation for the
character-map templates in the DocBook XSL Stylesheets.</para>
<para>These templates are defined in a separate file from the set
of “common” templates because some of the common templates
reference DocBook XSL stylesheet parameters, requiring the
entire set of parameters to be imported/included in any
stylesheet that imports/includes the common templates.</para>
<para>The character-map templates don’t import or include
any DocBook XSL stylesheet parameters, so the
character-map templates can be used without importing the
whole set of parameters.</para>
<para>This is not intended to be user documentation. It is
provided for developers writing customization layers for the
<!-- ===================================== -->
<doc:template name="apply-character-map" xmlns="">
<refpurpose>Applies an XSLT character map</refpurpose>
<refdescription id="apply-character-map-desc">
<para>This template applies an <link
>XSLT character map</link>; that is, it causes certain
individual characters to be substituted with strings of one
or more characters. It is useful mainly for replacing
multiple “special” characters or symbols in the same target
content. It uses the value of
<parameter>map.contents</parameter> to do substitution on
<parameter>content</parameter>, and then returns the
modified contents.</para>
<para>This template is a very slightly modified version of
Jeni Tennison’s <function>replace_strings</function>
template in the <link
>multiple string replacements</link> section of Dave Pawson’s
<link xlink:href=""
>XSLT FAQ</link>.</para>
<para>The <function>apply-string-subst-map</function>
template is essentially the same template as the
<function>apply-character-map</function> template; the
only difference is that in the map that
<function>apply-string-subst-map</function> expects, <tag
class="attribute">oldstring</tag> and <tag
class="attribute">newstring</tag> attributes are used
instead of <tag class="attribute">character</tag> and <tag
class="attribute">string</tag> attributes.</para>
<refparameter id="apply-character-map-params">
<para>The content on which to perform the character-map
<para>A node set of elements, with each element having
the following attributes:
<simpara><tag class="attribute">character</tag>, a
character to be replaced</simpara>
<simpara><tag class="attribute">string</tag>, a
string with which to replace <tag
<xsl:template name="apply-character-map">
<xsl:param name="content"/>
<xsl:param name="map.contents"/>
<xsl:variable name="replaced_text">
<xsl:call-template name="string.subst">
<xsl:with-param name="string" select="$content" />
<xsl:with-param name="target"
select="$map.contents[1]/@character" />
<xsl:with-param name="replacement"
select="$map.contents[1]/@string" />
<xsl:when test="$map.contents[2]">
<xsl:call-template name="apply-character-map">
<xsl:with-param name="content" select="$replaced_text" />
<xsl:with-param name="map.contents"
select="$map.contents[position() > 1]" />
<xsl:value-of select="$replaced_text" />
<!-- ===================================== -->
<doc:template name="read-character-map" xmlns="">
<refpurpose>Reads in all or part of an XSLT character map</refpurpose>
<refdescription id="read-character-map-desc">
<para>The XSLT 2.0 specification describes <link
>character maps</link> and explains how they may be used
to allow a specific character appearing in a text or
attribute node in a final result tree to be substituted by
a specified string of characters during serialization. The
<function>read-character-map</function> template provides a
means for reading and using character maps with XSLT
1.0-based tools.</para>
<para>This template reads the character-map contents from
<parameter>uri</parameter> (in full or in part, depending on
the value of the <parameter>use.subset</parameter>
parameter), then passes those contents to the
<function>apply-character-map</function> template, along with
<parameter>content</parameter>, the data on which to perform
the character substitution.</para>
<para>Using the character map “in part” means that it uses only
those <tag>output-character</tag> elements that match the
XPath expression given in the value of the
<parameter>subset.profile</parameter> parameter. The current
implementation of that capability here relies on the
<function>evaluate</function> extension XSLT function.</para>
<refparameter id="read-character-map-params">
<para>Specifies whether to use a subset of the character
map instead of the whole map; boolean
<literal>0</literal> or <literal>1</literal></para>
<para>XPath expression that specifies what subset of the
character map to use</para>
<para>URI for a character map</para>
<xsl:template name="read-character-map">
<xsl:param name="use.subset"/>
<xsl:param name="subset.profile"/>
<xsl:param name="uri"/>
<xsl:when test="$use.subset != 0">
<!-- *use a subset of the character map instead of the full map -->
<!-- * xsltproc and Xalan both support dyn:evaluate() -->
<xsl:when test="function-available('dyn:evaluate')">
<xsl:copy-of select="document($uri)//*[local-name()='output-character']
<!-- * Saxon has its own evaluate() and doesn't support dyn:evaluate() -->
<xsl:when test="function-available('saxon:evaluate')">
<xsl:copy-of select="document($uri)//*[local-name()='output-character']
<xsl:message terminate="yes"
Error: To process character-map subsets, you must use an XSLT engine
that supports the evaluate() XSLT extension function. Your XSLT engine
does not support it.
<!-- *value of $use.subset is non-zero, so use the full map -->
<xsl:copy-of select="document($uri)//*[local-name()='output-character']"/>