index.on.type.xml 1.8 KB

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