]> git.stg.codes - stg.git/blob - doc/help/xslt/params/footnote.number.symbols.xml
--stringparam base.path replaces with -o
[stg.git] / doc / help / xslt / params / footnote.number.symbols.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="footnote.number.symbols">
7 <refmeta>
8 <refentrytitle>footnote.number.symbols</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype"/>
10 </refmeta>
11 <refnamediv>
12 <refname>footnote.number.symbols</refname>
13 <refpurpose>Special characters to use as footnote markers</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="footnote.number.symbols.frag">
18 <xsl:param name="footnote.number.symbols"></xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
25 footnotes will use the characters it contains as footnote symbols. For example,
26 <quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
27 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>,
28 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes
29 than symbols, the stylesheets will fall back to numbered footnotes using
30 <parameter>footnote.number.format</parameter>.</para>
31
32 <para>The use of symbols for footnotes depends on the ability of your
33 processor (or browser) to render the symbols you select. Not all systems are
34 capable of displaying the full range of Unicode characters. If the quoted characters
35 in the preceding paragraph are not displayed properly, that's a good indicator
36 that you may have trouble using those symbols for footnotes.</para>
37
38 </refsection>
39 </refentry>