Posy::Plugin::Toc 0.5501

Posy::Plugin::Toc is a Posy plugin to create a table of contents.

SYNOPSIS

@plugins = qw(Posy::Core Posy::Plugin::Toc));
@actions = qw(header
...
make_page_toc
render_page
...
);
@entry_actions = qw(header
...
parse_entry
make_toc
render_entry
...
);

Creates a table of contents generated from headings.
The table of contents will be generated if the entry (or page) contains the toc_entry_split/toc_page_split or the toc_entry_split_after/toc_page_split_after values, only from headers below the match, OR, if the the toc_entry_at_start/toc_page_at_start value is true, in which case the table of contents will be generated from the whole entry (or page) and placed at the start.

If there are no headers (element $toc_chapter_element), then no table of contents will be generated.

This creates a make_toc entry-action, which will put a table of contents in the entry. This should be placed after parse_entry and before render_entry in the entry_action list. If you are using the Posy::Plugin::ShortBody plugin, this should be placed after short_body in the entry_action list, not before it.
This also creates a make_page_toc action, which will put a table of contents in the whole page body. This should be placed before render_page (so that one can be sure that one has the whole page to process).