[publican-list] [Bug 616123] New: RFE: more fine-grained control over main and division TOC levels

[Douglas Silas]

https://bugzilla.redhat.com/show_bug.cgi?id=616123

Description of problem: Two settings controlling TOC creation are:

generate_section_toc_level: 0
#    controls the section depth at which Publican will generate a 
table of
contents. At the default value of 0, Publican will generate tables 
of contents
at the start of the document and in parts, chapters, and appendixes, 
but not in
sections. If (for example) the value is set to 1, tables of contents 
also
appear in each "level 1" section, such as sections 1.1, 1.2, 2.1, 
and 2.2. If
set to 2, tables of contents also appear in "level 2" sections, such as
sections 1.1.1, 1.1.2, and 1.2.1.

toc_section_depth: 2
#    controls the depth of sections that Publican includes in the 
main table of
contents. By default, this value is set to 2. With the default setting,
sections 1.1 and 1.1.1 will appear in the main table of contents, 
but section
1.1.1.1 will not. (Note that the first digit in these examples 
represents a
chapter, not a section).

Note that the combination of these does not, for example, allow for 
setting the
main TOC to have a level of 1, while chapters/sections have a level 
of 2. It
would be both logical and useful for a (large, long) book's TOC to 
have a
shallow section depth (, while the chapter or section's TOC is more 
detailed.

My proposal is to have separate "main_toc_section_depth" and
"division_toc_section_depth" directives that control the initial and 
all later
TOC section depths, respectively, thus allowing for more 
fine-grained control
over navigation, appearance and organization.

Note: the description for toc_section_depth reads "controls the depth of
sections that Publican includes in the main table of contents". Is 
there a
(hidden) option to control the TOC depth of other divisions, or does 
this need
to be revised? toc_section_depth affects all TOCs.

Version-Release number of selected component (if applicable):
version=2.1

-- 
Douglas Silas
Technical Writer | Red Hat, Inc.
Purkyňova 99 | Brno, Czech Republic
Office Direct Dial—62116
Brno Office—(+420) 532 294 111 ext. 10718