generate.section.toc.level.xml 1.4 KB

1234567891011121314151617181920212223242526272829303132333435
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="generate.section.toc.level.frag">
  17. <xsl:param name="generate.section.toc.level" select="0"/>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>The <parameter>generate.section.toc.level</parameter> parameter
  22. controls the depth of <tag>section</tag> in which TOCs will be generated. Note
  23. that this is related to, but not the same as
  24. <parameter>toc.section.depth</parameter>, which controls the depth to
  25. which TOC entries will be generated in a given TOC.</para>
  26. <para>If, for example, <parameter>generate.section.toc.level</parameter>
  27. is <literal>3</literal>, TOCs will be generated in first, second, and third
  28. level sections, but not in fourth level sections.
  29. </para>
  30. </refsection>
  31. </refentry>