summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/generate.section.toc.level.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/generate.section.toc.level.xml')
-rw-r--r--kdoctools/docbook/xsl/params/generate.section.toc.level.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/generate.section.toc.level.xml b/kdoctools/docbook/xsl/params/generate.section.toc.level.xml
new file mode 100644
index 000000000..ba9bf294d
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/generate.section.toc.level.xml
@@ -0,0 +1,30 @@
+<refentry id="generate.section.toc.level">
+<refmeta>
+<refentrytitle>generate.section.toc.level</refentrytitle>
+<refmiscinfo role="type">integer</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>generate.section.toc.level</refname>
+<refpurpose>Control depth of TOC generation in sections</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='generate.section.toc.level.frag'>
+<xsl:param name="generate.section.toc.level" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>The <parameter>generate.section.toc.level</parameter> parameter
+controls the depth of section in which TOCs will be generated. Note
+that this is related to, but not the same as
+<parameter>toc.section.depth</parameter>, which controls the depth to
+which TOC entries will be generated in a given TOC.</para>
+<para>If, for example, <parameter>generate.section.toc.level</parameter>
+is <literal>3</literal>, TOCs will be generated in first, second, and third
+level sections, but not in fourth level sections.
+</para>
+
+</refsect1>
+</refentry>