Next: PAGEREF   Previous: L   Contents: Contents

LOCALTOC

inserts a list of current subchapters, which means a list of the plain subchapter titles. This is especially useful at the beginning of a fine structured document section, or on an introduction page where you want to preview what the audience can expect in the following talk section.

Using this tag relieves you from writing and maintaining such a list manually.

Syntax

\LOCALTOC{options}

Options

This tag supports various options. All options are optional and default to values mentioned in their descriptions.

depth
Subchapters may have subchapters as well. By default, the whole tree is displayed, but this can be limited by this option. Pass the number of sublevels that shall be included. The lowest possible value is 1. Invalid option values will cause syntax errors.

             Consider you are in a level 1 headline
             with these subchapters:

             ==Details 1

             ==Details 2

             ===Details 2 explained

             ===Details 2 furtherly explained

             ==Conclusion

             Depth 1 will result in listing "Details 1",
             "Details 2" and "Conclusion". Depth 2 or
             greater will add the explanation subchapters
             of level 3.

Note that the option expects an offset value. The list depth is independend of the absolute levels of subchapters. This way, your settings will remain valid even if absolute levels change (which might happen when the document is included, for example).

format
This setting configures what kind of list will be generated. The following values are specified:
settingresult
bulletsproduces an unordered list
enumeratedproduces an ordered list
numbersproduces a list where each chapter is preceeded by its chapter number, according to the documents hierarchy (1.1.5, 2.3. etc.)

If this option is omitted, the setting defaults to bullets.

type: linked makes each listed subchapter title a link to the related chapter. Note that this feature depends on the target formats link support, so results may vary.

By default, titles are displayed as plain text - plain can be used to specify this explicitly.

Body

No body is allowed. A used body will not be recognized as a body of this tag.

Notes

\LOCALTOC is part of the basic tag set supported by all PerlPoint translators. The results may vary depening on the target format capabilities.

Example

When this tag is used in


  =Parent chapter

  In this chapter:

  \LOCALTOC{depth=1}

  ==Subchapter 1

  ===Subchapter 1.1

  ==Subchapter 2

, a converter will produce results according to this source:


  =Parent chapter

  In this chapter:

  * Subchapter 1

  * Subchapter 2

  ==Subchapter 1

  ==Subchapter 2

See also

More basic set tags: B, C, EMBED, FORMAT, HIDE, I, IMAGE, INCLUDE, READY, REF, SEQ, STOP and TABLE.

Next: PAGEREF   Previous: L   Contents: Contents