]> git.stg.codes - stg.git/blob - doc/xslt/params/generate.section.toc.level.xml
More clear plugin API
[stg.git] / doc / xslt / params / generate.section.toc.level.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="generate.section.toc.level">
7 <refmeta>
8 <refentrytitle>generate.section.toc.level</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>generate.section.toc.level</refname>
13 <refpurpose>Control depth of TOC generation in sections</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="generate.section.toc.level.frag">
18 <xsl:param name="generate.section.toc.level" select="0"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>The <parameter>generate.section.toc.level</parameter> parameter
25 controls the depth of <tag>section</tag> in which TOCs will be generated. Note
26 that this is related to, but not the same as
27 <parameter>toc.section.depth</parameter>, which controls the depth to
28 which TOC entries will be generated in a given TOC.</para>
29 <para>If, for example, <parameter>generate.section.toc.level</parameter>
30 is <literal>3</literal>, TOCs will be generated in first, second, and third
31 level sections, but not in fourth level sections.
32 </para>
33
34 </refsection>
35 </refentry>