]> git.stg.codes - stg.git/blob - doc/help/xslt/params/process.empty.source.toc.xml
--stringparam base.path replaces with -o
[stg.git] / doc / help / xslt / params / process.empty.source.toc.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="process.empty.source.toc">
7 <refmeta>
8 <refentrytitle>process.empty.source.toc</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>process.empty.source.toc</refname>
13 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source document?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"/></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>Specifies that if an empty <tag>toc</tag> element is found in a
23 source document, an automated TOC is generated at this point in the
24 document.
25 <note>
26   <para>Depending on what the value of the
27   <parameter>generate.toc</parameter> parameter is, setting this
28   parameter to <literal>1</literal> could result in generation of
29   duplicate automated TOCs. So the
30   <parameter>process.empty.source.toc</parameter> is primarily useful
31   as an "override": by placing an empty <tag>toc</tag> in your
32   document and setting this parameter to <literal>1</literal>, you can
33   force a TOC to be generated even if <tag>generate.toc</tag>
34   says not to.</para>
35 </note>
36 </para>
37
38 </refsection>
39 </refentry>