mapnik/scons/scons-local-4.1.0/SCons/Tool/docbook/docbook-xsl-1.76.1/params/use.role.as.xrefstyle.xml

94 lines
3.2 KiB
XML
Raw Normal View History

2021-03-05 10:18:26 +00:00
<refentry xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="5.0" xml:id="use.role.as.xrefstyle">
<refmeta>
<refentrytitle>use.role.as.xrefstyle</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
</refmeta>
<refnamediv>
<refname>use.role.as.xrefstyle</refname>
<refpurpose>Use <tag class="attribute">role</tag> attribute for
<tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose>
</refnamediv>
<refsynopsisdiv>
<src:fragment xml:id="use.role.as.xrefstyle.frag">
<xsl:param name="use.role.as.xrefstyle" select="1"/>
</src:fragment>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>In DocBook documents that conform to a schema older than V4.3, this parameter allows
<tag class="attribute">role</tag> to serve the purpose of specifying the cross reference style.</para>
<para>If non-zero, the <tag class="attribute">role</tag> attribute on
<tag>xref</tag> will be used to select the cross reference style.
In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added for this purpose.
If the <tag class="attribute">xrefstyle</tag> attribute is present,
<tag class="attribute">role</tag> will be ignored, regardless of the setting
of this parameter.</para>
</refsection>
<refsection><info><title>Example</title></info>
<para>The following small stylesheet shows how to configure the
stylesheets to make use of the cross reference style:</para>
<programlisting>&lt;?xml version="1.0"?&gt;
&lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0"&gt;
&lt;xsl:import href="../xsl/html/docbook.xsl"/&gt;
&lt;xsl:output method="html"/&gt;
&lt;xsl:param name="local.l10n.xml" select="document('')"/&gt;
&lt;l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"&gt;
&lt;l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="en"&gt;
&lt;l:context name="xref"&gt;
&lt;l:template name="chapter" style="title" text="Chapter %n, %t"/&gt;
&lt;l:template name="chapter" text="Chapter %n"/&gt;
&lt;/l:context&gt;
&lt;/l:l10n&gt;
&lt;/l:i18n&gt;
&lt;/xsl:stylesheet&gt;</programlisting>
<para>With this stylesheet, the cross references in the following document:</para>
<programlisting>&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
&lt;book id="book"&gt;&lt;title&gt;Book&lt;/title&gt;
&lt;preface&gt;
&lt;title&gt;Preface&lt;/title&gt;
&lt;para&gt;Normal: &lt;xref linkend="ch1"/&gt;.&lt;/para&gt;
&lt;para&gt;Title: &lt;xref xrefstyle="title" linkend="ch1"/&gt;.&lt;/para&gt;
&lt;/preface&gt;
&lt;chapter id="ch1"&gt;
&lt;title&gt;First Chapter&lt;/title&gt;
&lt;para&gt;Irrelevant.&lt;/para&gt;
&lt;/chapter&gt;
&lt;/book&gt;</programlisting>
<para>will appear as:</para>
<informalexample>
<para>Normal: Chapter 1.</para>
<para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para>
</informalexample>
</refsection>
</refentry>