1 <refentry xmlns="http://docbook.org/ns/docbook"
\r
2 xmlns:xlink="http://www.w3.org/1999/xlink"
\r
3 xmlns:xi="http://www.w3.org/2001/XInclude"
\r
4 xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
\r
5 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
\r
6 version="5.0" xml:id="index.on.role">
\r
8 <refentrytitle>index.on.role</refentrytitle>
\r
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
\r
12 <refname>index.on.role</refname>
\r
13 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</refpurpose>
\r
17 <src:fragment xml:id="index.on.role.frag">
\r
18 <xsl:param name="index.on.role" select="0"/>
\r
22 <refsection><info><title>Description</title></info>
\r
26 then an <tag>index</tag> element that has a
\r
27 <tag class="attribute">role</tag> attribute
\r
28 value will contain only those <tag>indexterm</tag>
\r
29 elements with a matching role value.
\r
30 If an <tag>index</tag> has no <tag class="attribute">role</tag>
\r
31 attribute or it is blank, then the index will contain
\r
32 all <tag>indexterm</tag>s in the current scope.
\r
35 If <literal>index.on.role</literal> is zero, then the
\r
36 <tag class="attribute">role</tag> attribute has no effect
\r
37 on selecting indexterms for an index.
\r
40 <para>If you are using DocBook version 4.3 or later, you should
\r
41 use the <tag class="attribute">type</tag> attribute instead of <tag class="attribute">role</tag>
\r
42 on <tag>indexterm</tag> and <tag>index</tag>,
\r
43 and set the <parameter>index.on.type</parameter> to a nonzero
\r