blob: 81d65ddba880f8580a648f9609333f6c439cef90 [file] [log] [blame]
<refentry xmlns=""
version="5.0" xml:id="index.on.role">
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
<refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
<src:fragment xml:id="index.on.role.frag">
<xsl:param name="index.on.role" select="0"/>
If non-zero,
then an <tag>index</tag> element that has a
<tag class="attribute">role</tag> attribute
value will contain only those <tag>indexterm</tag>
elements with a matching role value.
If an <tag>index</tag> has no <tag class="attribute">role</tag>
attribute or it is blank, then the index will contain
all <tag>indexterm</tag>s in the current scope.
If <literal>index.on.role</literal> is zero, then the
<tag class="attribute">role</tag> attribute has no effect
on selecting indexterms for an index.
<para>If you are using DocBook version 4.3 or later, you should
use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
on <tag>indexterm</tag> and <tag>index</tag>,
and set the <parameter>index.on.type</parameter> to a nonzero