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