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

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

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2003-11-12 02:39:50 CET

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

I want a table of contents that lists each svn command individually.

Your patch puts tables of contents in subsections as well as at the beginning of each chapter, and this seems to force the generation of a table of svn commands as a side effect, but I do not much like having so many tables of contents.

So my vote is +0 for this patch.

The problem is that it is hard to find a particular subcommand. One reason for this is the lack of a table of contents for them, and another is that the name of each subcommand is displayed as normal text, although the word "Name" is in a large font. It would be better if the actual command name could be displayed in a more visible style, which might be achieved by making it a <sect3> or whatever. I would prefer that, if there is some way that that can be done while remaining compatible with O'Reilly's rules. Maybe O'Reilly is aware of the problem and has a work-around or updated rules.

- Julian

> 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.)

> 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

I see that this second variable is not used, so I have just deleted it.

>
> # 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 Wed Nov 12 02:38:44 2003

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