process.empty.source.toc.xml 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="process.empty.source.toc.frag"><xsl:param name="process.empty.source.toc" select="0"/></src:fragment>
  17. </refsynopsisdiv>
  18. <refsection><info><title>Description</title></info>
  19. <para>Specifies that if an empty <tag>toc</tag> element is found in a
  20. source document, an automated TOC is generated at this point in the
  21. document.
  22. <note>
  23. <para>Depending on what the value of the
  24. <parameter>generate.toc</parameter> parameter is, setting this
  25. parameter to <literal>1</literal> could result in generation of
  26. duplicate automated TOCs. So the
  27. <parameter>process.empty.source.toc</parameter> is primarily useful
  28. as an "override": by placing an empty <tag>toc</tag> in your
  29. document and setting this parameter to <literal>1</literal>, you can
  30. force a TOC to be generated even if <tag>generate.toc</tag>
  31. says not to.</para>
  32. </note>
  33. </para>
  34. </refsection>
  35. </refentry>