summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdoctools/docbook/xsl/params/component.label.includes.part.label.xml
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdoctools/docbook/xsl/params/component.label.includes.part.label.xml')
-rw-r--r--kdoctools/docbook/xsl/params/component.label.includes.part.label.xml33
1 files changed, 33 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml b/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml
new file mode 100644
index 000000000..eef3eae10
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/component.label.includes.part.label.xml
@@ -0,0 +1,33 @@
+<refentry id="component.label.includes.part.label">
+<refmeta>
+<refentrytitle>component.label.includes.part.label</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>component.label.includes.part.label</refname>
+<refpurpose>Do section labels include the component label?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='component.label.includes.part.label.frag'><xsl:param name="component.label.includes.part.label" select="0"/></src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If true (non-zero), labels for chapters, appendices, and other component
+elements are prefixed with the label of the
+part element that contains them.
+Also, the labels for formal elements such as table and figure 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
+<literal>label.from.part</literal> parameter is turned on.
+In that case, there would be more than one chapter
+<quote>1</quote>, and the extra part label prefix will identify
+each chapter unambiguously.
+</para>
+
+</refsect1>
+</refentry>