doc/xslt/params/index.on.type.xml

   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.type">
   7 <refmeta>
   8 <refentrytitle>index.on.type</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>index.on.type</refname>
  13 <refpurpose>Select indexterms based on <tag class="attribute">type</tag>
  14 attribute value</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18 <src:fragment xml:id="index.on.type.frag">
  19 <xsl:param name="index.on.type" select="0"/>
  20 </src:fragment>
  21 </refsynopsisdiv>
  22
  23 <refsection><info><title>Description</title></info>
  24
  25 <para>
  26 If non-zero,
  27 then an <tag>index</tag> element that has a
  28 <tag class="attribute">type</tag> attribute
  29 value will contain only those <tag>indexterm</tag>
  30 elements with a matching <tag class="attribute">type</tag> attribute value.
  31 If an <tag>index</tag> has no <tag class="attribute">type</tag>
  32 attribute or it is blank, then the index will contain
  33 all <tag>indexterm</tag>s in the current scope.
  34 </para>
  35
  36 <para>
  37 If <literal>index.on.type</literal> is zero, then the
  38 <tag class="attribute">type</tag> attribute has no effect
  39 on selecting indexterms for an index.
  40 </para>
  41
  42 <para>For those using DocBook version 4.2 or earlier,
  43 the <tag class="attribute">type</tag> attribute is not available
  44 for index terms.  However, you can achieve the same
  45 effect by using the <tag class="attribute">role</tag> attribute
  46 in the same manner on <tag>indexterm</tag>
  47 and <tag>index</tag>, and setting the stylesheet parameter
  48 <parameter>index.on.role</parameter> to a nonzero value.
  49 </para>
  50
  51 </refsection>
  52 </refentry>