diff options
Diffstat (limited to 'params/component.label.includes.part.label.xml')
| -rw-r--r-- | params/component.label.includes.part.label.xml | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/params/component.label.includes.part.label.xml b/params/component.label.includes.part.label.xml new file mode 100644 index 0000000..6dd7a68 --- /dev/null +++ b/params/component.label.includes.part.label.xml @@ -0,0 +1,39 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="5.0" xml:id="component.label.includes.part.label"> +<refmeta> +<refentrytitle>component.label.includes.part.label</refentrytitle> +<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> +</refmeta> +<refnamediv> +<refname>component.label.includes.part.label</refname> +<refpurpose>Do component labels include the part label?</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<src:fragment xml:id="component.label.includes.part.label.frag"><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment> +</refsynopsisdiv> + +<refsection><info><title>Description</title></info> + +<para>If non-zero, number labels for <tag>chapter</tag>, +<tag>appendix</tag>, and other component elements are prefixed with +the label of the part element that contains them. So you might see +Chapter II.3 instead of Chapter 3. Also, the labels for formal +elements such as <tag>table</tag> and <tag>figure</tag> will include +the part label. If there is no part element container, then no prefix +is generated. +</para> +<para> +This feature is most useful when the +<parameter>label.from.part</parameter> parameter is turned on. +In that case, there would be more than one <tag>chapter</tag> +<quote>1</quote>, and the extra part label prefix will identify +each chapter unambiguously. +</para> + +</refsection> +</refentry> |