+++ /dev/null
-<refentry xmlns="http://docbook.org/ns/docbook"\r
- xmlns:xlink="http://www.w3.org/1999/xlink"\r
- xmlns:xi="http://www.w3.org/2001/XInclude"\r
- xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
- version="5.0" xml:id="generate.toc">\r
-<refmeta>\r
-<refentrytitle>generate.toc</refentrytitle>\r
-<refmiscinfo class="other" otherclass="datatype">table</refmiscinfo>\r
-</refmeta>\r
-<refnamediv>\r
-<refname>generate.toc</refname>\r
-<refpurpose>Control generation of ToCs and LoTs</refpurpose>\r
-</refnamediv>\r
-\r
-<refsynopsisdiv>\r
-<src:fragment xml:id="generate.toc.frag">\r
-<xsl:param condition="html" name="generate.toc">\r
-appendix toc,title\r
-article/appendix nop\r
-article toc,title\r
-book toc,title,figure,table,example,equation\r
-chapter toc,title\r
-part toc,title\r
-preface toc,title\r
-qandadiv toc\r
-qandaset toc\r
-reference toc,title\r
-sect1 toc\r
-sect2 toc\r
-sect3 toc\r
-sect4 toc\r
-sect5 toc\r
-section toc\r
-set toc,title\r
-</xsl:param>\r
-<xsl:param condition="fo" name="generate.toc">\r
-/appendix toc,title\r
-article/appendix nop\r
-/article toc,title\r
-book toc,title,figure,table,example,equation\r
-/chapter toc,title\r
-part toc,title\r
-/preface toc,title\r
-reference toc,title\r
-/sect1 toc\r
-/sect2 toc\r
-/sect3 toc\r
-/sect4 toc\r
-/sect5 toc\r
-/section toc\r
-set toc,title\r
-</xsl:param>\r
-</src:fragment>\r
-</refsynopsisdiv>\r
-\r
-<refsection><info><title>Description</title></info>\r
-\r
-<para>This parameter has a structured value. It is a table of space-delimited\r
-path/value pairs. Each path identifies some element in the source document\r
-using a restricted subset of XPath (only the implicit child axis, no wildcards,\r
-no predicates). Paths can be either relative or absolute.</para>\r
-\r
-<para>When processing a particular element, the stylesheets consult this table to\r
-determine if a ToC (or LoT(s)) should be generated.</para>\r
-\r
-<para>For example, consider the entry:</para>\r
-\r
-<screen>book toc,figure</screen>\r
-\r
-<para>This indicates that whenever a <tag>book</tag> is formatted, a\r
-Table Of Contents and a List of Figures should be generated. Similarly,</para>\r
-\r
-<screen>/chapter toc</screen>\r
-\r
-<para>indicates that whenever a document <emphasis>that has a root\r
-of</emphasis> <tag>chapter</tag> is formatted, a Table of\r
-Contents should be generated. The entry <literal>chapter</literal> would match\r
-all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag>\r
-document elements.</para>\r
-\r
-<para>Generally, the longest match wins. So, for example, if you want to distinguish\r
-articles in books from articles in parts, you could use these two entries:</para>\r
-\r
-<screen>book/article toc,figure\r
-part/article toc</screen>\r
-\r
-<para>Note that an article in a part can never match a <literal>book/article</literal>,\r
-so if you want nothing to be generated for articles in parts, you can simply leave\r
-that rule out.</para>\r
-\r
-<para>If you want to leave the rule in, to make it explicit that you're turning\r
-something off, use the value <quote>nop</quote>. For example, the following\r
-entry disables ToCs and LoTs for articles:</para>\r
-\r
-<screen>article nop</screen>\r
-\r
-<para>Do not simply leave the word <quote>article</quote> in the file\r
-without a matching value. That'd be just begging the silly little\r
-path/value parser to get confused.</para>\r
-\r
-<para>Section ToCs are further controlled by the\r
-<parameter>generate.section.toc.level</parameter> parameter.\r
-For a given section level to have a ToC, it must have both an entry in \r
-<parameter>generate.toc</parameter> and be within the range enabled by\r
-<parameter>generate.section.toc.level</parameter>.</para>\r
-</refsection>\r
-</refentry>\r
projects / Evergreen-DocBook.git / blobdiff