3.3 Skribe User Manual -- Table of contents

The production of table of contains.

prototype
(toc [:ident] [:class "toc"] [:chapter #t] [:section #t] [:subsection] handle)
optionenginesdescription
identhtml latex xml The node identifier.
classhtml latex xml The node class.
chapterhtml A boolean. The value #t forces the inclusion of chapters in the table of contents.
sectionhtml A boolean controlling sections.
subsectionhtml A boolean controlling subsections.
argumentdescription
handleAn optional handle pointing to the node from which the table of contents if computed.
See also
document chapter section [?mark resolve: skr/api.skr:15566] [?mark handle: skr/api.skr:15566]
Example:
(toc :chapter #t :section #f :subsection #f)
Ex. 5: The toc markup

Produces:

1Getting Started
2Syntax & Values
3Standard Markups
4References and Hyperlinks
5Indexes
6Bibliographies
7Computer programs
8Standard Library
9Engines
10Editing Skribe Programs
11Skribe compiler
12Slide Package
13Standard Packages
14Getting Skribe configuration information
15List of examples

The second example only displays the table of contents of the current chapter.

Example:
(resolve (lambda (n e env)
            (toc :chapter #t :section #t :subsection #t 
                 (handle (ast-chapter n)))))
Ex. 6: A restricted table of contents

Produces:

Markup index
3.1Building documents
3.1.1Document
3.1.2Author
3.2Sectioning
3.2.1Chapter
3.2.2Sections
3.2.3Paragraph
3.2.4Blockquote
3.3Table of contents
3.4Ornaments
3.5Line breaks
3.5.1Linebreak
3.5.2Horizontal rule
3.6Font
3.7Justification
3.8Enumeration
3.9Frame and color
3.9.1Frame
3.9.2Color
3.10Figure
3.10.1List of figures
3.11Image
3.11.1Image formats
3.12Table
3.12.1Table row
3.12.2Table cell
3.12.3Example
3.13Footnote
3.14Characters, Strings and Symbols
3.14.1Characters
3.14.2Strings
3.14.3Symbols

This Html page has been produced by Skribe.
Last update Tue Jun 29 09:37:13 2010.