component.label.includes.part.label.xml 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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="component.label.includes.part.label">
  7. <refmeta>
  8. <refentrytitle>component.label.includes.part.label</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>component.label.includes.part.label</refname>
  13. <refpurpose>Do component labels include the part label?</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment>
  17. </refsynopsisdiv>
  18. <refsection><info><title>Description</title></info>
  19. <para>If non-zero, number labels for <tag>chapter</tag>,
  20. <tag>appendix</tag>, and other component elements are prefixed with
  21. the label of the part element that contains them. So you might see
  22. Chapter II.3 instead of Chapter 3. Also, the labels for formal
  23. elements such as <tag>table</tag> and <tag>figure</tag> will include
  24. the part label. If there is no part element container, then no prefix
  25. is generated.
  26. </para>
  27. <para>
  28. This feature is most useful when the
  29. <parameter>label.from.part</parameter> parameter is turned on.
  30. In that case, there would be more than one <tag>chapter</tag>
  31. <quote>1</quote>, and the extra part label prefix will identify
  32. each chapter unambiguously.
  33. </para>
  34. </refsection>
  35. </refentry>