]> git.stg.codes - stg.git/blobdiff - doc/help/xslt/params/index.prefer.titleabbrev.xml
DocBook documentation stub added
[stg.git] / doc / help / xslt / params / index.prefer.titleabbrev.xml
diff --git a/doc/help/xslt/params/index.prefer.titleabbrev.xml b/doc/help/xslt/params/index.prefer.titleabbrev.xml
new file mode 100644 (file)
index 0000000..3f010ae
--- /dev/null
@@ -0,0 +1,29 @@
+<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="index.prefer.titleabbrev">
+<refmeta>
+<refentrytitle>index.prefer.titleabbrev</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>index.prefer.titleabbrev</refname>
+<refpurpose>Should abbreviated titles be used as back references?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="index.prefer.titleabbrev.frag">
+<xsl:param name="index.prefer.titleabbrev" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated title
+is used as the link text of a back reference in the index.
+</para>
+
+</refsection>
+</refentry>