]> git.stg.codes - stg.git/blob - doc/xslt/params/process.source.toc.xml
Ticket 37. The ChangePolicyToString() and StringToChangePolicy()
[stg.git] / doc / xslt / params / process.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.source.toc">
7 <refmeta>
8 <refentrytitle>process.source.toc</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>process.source.toc</refname>
13 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"/></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>Specifies that the contents of a non-empty "hard-coded"
23 <tag>toc</tag> element in a source document are processed to
24 generate a TOC in output.
25 <note>
26   <para>This parameter has no effect on automated generation of
27   TOCs. An automated TOC may still be generated along with the
28   "hard-coded" TOC. To suppress automated TOC generation, adjust the
29   value of the <parameter>generate.toc</parameter> paramameter.</para>
30
31   <para>The <tag>process.source.toc</tag> parameter also has
32   no effect if the <tag>toc</tag> element is empty; handling
33   for empty <tag>toc</tag> is controlled by the
34   <parameter>process.empty.source.toc</parameter> parameter.</para>
35 </note>
36 </para>
37
38 </refsection>
39 </refentry>