[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

[PATCH] Re: Suggestion for book TOC: one level deeper

From: Brian Denny <brian_at_briandenny.net>
Date: 2003-11-08 18:36:37 CET

[Reposting with PATCH in the subject line. I'd commit this but would
prefer a +1 from a book author first.]

On Thu, Nov 06, 2003 at 11:01:01AM -0600, B. W. Fitzpatrick wrote:
> "Schrom.Brian" <Brian.Schrom@IGT.com> writes:
> >
> > Use the toc.section.depth parameter to indicate how many levels of section
> > titles should appear in the TOCs. If you set it to a value of 3, for
> > example, then TOCs will include up to sect3 titles. The default value is 2.
>
> Well, the problem is that all the subcommands are 'refentry's and not
> 'sect3's... Is there anything that will help there? Or do we have to
> wrap every refentry in a sect3?

I did some testing... toc.section.depth doesn't appear to help.

Setting generate.section.toc.level to 2, though, causes section-specific
TOCs to appear under the headings for individual sections -- and in this
case, a TOC for the refentries does appear under "svn Subcommands",
although it still doesn't appear in the main TOC.

Try the following patch and see if you like the result. (Make sure to
observe that TOCs now appear under *all* sect1 and sect2 headers.)

The patch is also attached, in case of mailer line-wrapping.

Log:
Add section-specific TOCs under individual section headers.

Index: doc/book/Makefile
===================================================================
--- doc/book/Makefile (revision 7659)
+++ doc/book/Makefile (working copy)
@@ -37,8 +37,8 @@
 RUN_FOP = ${BOOK_TOP}/tools/bin/run-fop.sh
 
 # Book xsltproc options for HTML output
-BOOK_HTML_XSLTPROC_OPTS = --stringparam html.stylesheet styles.css
-BOOK_CHUNK_HTML_XSLTPROC_OPTS = stringparam html.stylesheet styles.css
+BOOK_HTML_XSLTPROC_OPTS = --stringparam html.stylesheet styles.css --stringparam generate.section.toc.level 2
+BOOK_CHUNK_HTML_XSLTPROC_OPTS = stringparam html.stylesheet styles.css --stringparam generate.section.toc.level 2
 
 # Book xsltproc options for PDF and PostScript output
 # BOOK_PDF_XSLTPROC_OPTS = --stringparam page.height 9in --stringparam page.width 6.4in

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Received on Sat Nov 8 18:27:19 2003

This is an archived mail posted to the Subversion Dev mailing list.