stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/index.on.type.xml

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