]> git.stg.codes - stg.git/blob - doc/xslt/params/component.label.includes.part.label.xml
Ticket 26. The std::string modulePath variable definition moved after
[stg.git] / doc / xslt / params / component.label.includes.part.label.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="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
16 <refsynopsisdiv>
17 <src:fragment xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>If non-zero, number labels for <tag>chapter</tag>,
23 <tag>appendix</tag>, and other component elements are prefixed with
24 the label of the part element that contains them.  So you might see
25 Chapter II.3 instead of Chapter 3.  Also, the labels for formal
26 elements such as <tag>table</tag> and <tag>figure</tag> will include
27 the part label.  If there is no part element container, then no prefix
28 is generated.
29 </para>
30 <para>
31 This feature is most useful when the
32 <parameter>label.from.part</parameter> parameter is turned on.
33 In that case, there would be more than one <tag>chapter</tag>
34 <quote>1</quote>, and the extra part label prefix will identify
35 each chapter unambiguously.
36 </para>
37
38 </refsection>
39 </refentry>