Class Contents
Transform --+
|
Contents
This transform generates a table of contents from the entire document tree
or from a single branch. It locates "section" elements and builds them
into a nested bullet list, which is placed within a "topic". A title is
either explicitly specified, taken from the appropriate language module,
or omitted (local table of contents). The depth may be specified.
Two-way references between the table of contents and section titles are
generated (requires Writer support).
This transform requires a startnode, which which contains generation
options and provides the location for the generated table of contents (the
startnode is replaced by the table of contents "topic").
| Method Summary |
| |
apply(self)
Override to apply the transform to the document tree. |
| |
build_contents(self,
node,
level)
|
| |
copy_and_filter(self,
node)
Return a copy of a title, with references, images, etc. |
| Inherited from Transform |
| |
__init__(self,
document,
startnode)
Initial setup for in-place document transforms. |
copy_and_filter(self,
node)
Return a copy of a title, with references, images, etc. removed. -
|
default_priority
-
- Type:
-
int
- Value:
|