diff options
Diffstat (limited to '3rdParty/DocBook/XSL/params/index.on.type.xml')
-rw-r--r-- | 3rdParty/DocBook/XSL/params/index.on.type.xml | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/3rdParty/DocBook/XSL/params/index.on.type.xml b/3rdParty/DocBook/XSL/params/index.on.type.xml new file mode 100644 index 0000000..a5189c7 --- /dev/null +++ b/3rdParty/DocBook/XSL/params/index.on.type.xml @@ -0,0 +1,52 @@ +<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.on.type"> +<refmeta> +<refentrytitle>index.on.type</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>index.on.type</refname> +<refpurpose>Select indexterms based on <tag class="attribute">type</tag> +attribute value</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="index.on.type.frag"> +<xsl:param name="index.on.type" select="0"/> +</src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para> +If non-zero, +then an <tag>index</tag> element that has a +<tag class="attribute">type</tag> attribute +value will contain only those <tag>indexterm</tag> +elements with a matching <tag class="attribute">type</tag> attribute value. +If an <tag>index</tag> has no <tag class="attribute">type</tag> +attribute or it is blank, then the index will contain +all <tag>indexterm</tag>s in the current scope. +</para> + +<para> +If <literal>index.on.type</literal> is zero, then the +<tag class="attribute">type</tag> attribute has no effect +on selecting indexterms for an index. +</para> + +<para>For those using DocBook version 4.2 or earlier, +the <tag class="attribute">type</tag> attribute is not available +for index terms. However, you can achieve the same +effect by using the <tag class="attribute">role</tag> attribute +in the same manner on <tag>indexterm</tag> +and <tag>index</tag>, and setting the stylesheet parameter +<parameter>index.on.role</parameter> to a nonzero value. +</para> + +</refsection> +</refentry> |