DocBook documentation stub added

[stg.git] / doc / help / xslt / params / process.source.toc.xml

diff --git a/doc/help/xslt/params/process.source.toc.xml b/doc/help/xslt/params/process.source.toc.xml
new file mode 100644 (file)
index 0000000..b91657a
--- /dev/null
+++ b/doc/help/xslt/params/process.source.toc.xml
@@ -0,0 +1,39 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="process.source.toc">
+<refmeta>
+<refentrytitle>process.source.toc</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>process.source.toc</refname>
+<refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source document?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="process.source.toc.frag"><xsl:param name="process.source.toc" select="0"/></src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>Specifies that the contents of a non-empty "hard-coded"
+<tag>toc</tag> element in a source document are processed to
+generate a TOC in output.
+<note>
+  <para>This parameter has no effect on automated generation of
+  TOCs. An automated TOC may still be generated along with the
+  "hard-coded" TOC. To suppress automated TOC generation, adjust the
+  value of the <parameter>generate.toc</parameter> paramameter.</para>
+
+  <para>The <tag>process.source.toc</tag> parameter also has
+  no effect if the <tag>toc</tag> element is empty; handling
+  for empty <tag>toc</tag> is controlled by the
+  <parameter>process.empty.source.toc</parameter> parameter.</para>
+</note>
+</para>
+
+</refsection>
+</refentry>