summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/footnote.number.symbols.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/footnote.number.symbols.xml')
-rw-r--r--kdoctools/docbook/xsl/params/footnote.number.symbols.xml34
1 files changed, 34 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/footnote.number.symbols.xml b/kdoctools/docbook/xsl/params/footnote.number.symbols.xml
new file mode 100644
index 000000000..f02351177
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/footnote.number.symbols.xml
@@ -0,0 +1,34 @@
+<refentry id="footnote.number.symbols">
+<refmeta>
+<refentrytitle>footnote.number.symbols</refentrytitle>
+<refmiscinfo role="type"></refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>footnote.number.symbols</refname>
+<refpurpose>Special characters to use as footnote markers</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='footnote.number.symbols.frag'>
+<xsl:param name="footnote.number.symbols" select="''"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If <parameter>footnote.number.symbols</parameter> is not the empty string,
+footnotes will use the characters it contains as footnote symbols. For example,
+<quote>*&amp;#x2020;&amp;#x2021;&amp;#x25CA;&amp;#x2720;</quote> will identify
+footnotes with <quote>*</quote>, <quote>&#x2020;</quote>, <quote>&#x2021;</quote>,
+<quote>&#x25CA;</quote>, and <quote>&#x2720;</quote>. If there are more footnotes
+than symbols, the stylesheets will fall back to numbered footnotes using
+<parameter>footnote.number.format</parameter>.</para>
+
+<para>The use of symbols for footnotes depends on the ability of your
+processor (or browser) to render the symbols you select. Not all systems are
+capable of displaying the full range of Unicode characters. If the quoted characters
+in the preceding paragraph are not displayed properly, that's a good indicator
+that you may have trouble using those symbols for footnotes.</para>
+
+</refsect1>
+</refentry>