| 6.1 Primary TOC |
| 6.2 Secondary TOC |
| 6.3 Navigation Icons |
| 6.4 Document Index |
| ↩︎ | ↖︎ | ↑︎ | ↘︎ | ↪︎ |
wasDOC provides a variety of navigation mechanisms.
Each of these is described in the following sections.
The tags |1 through to |4 divides the document into titled sections and and generates a hierarchical primary table of content (TOC). Each generates a corresponding (HTML) heading containing the section title.
|0 tags do not generate primary TOC entries. Optionally these can be included in secondary TOCs.
Any heading tag can be prefixed with a zero to suppress the primary TOC entry while inserting that style heading.
The primary TOC is presented in two columns. This may be reduced to a single column or increased to three or four using |set|toc=cols=integer|.
The table of content is inserted wherever the |toc| tag is placed. If not included then no primary TOC is generated.
By default the Table of Content is numbered as section and subsections (see 2.1 Document Sections). Using the setting |set|toc=format=0| this can be disabled, resulting in no section numbering. Explicitly (re)enable using |set|toc=format=1|.
In addition, a numeric TOC can have a separator inserted after the section number up to the section heading, making a TOC entry look something like the next (faux) heading.
The syntax |set|toc=format=1....................| will introduce a space filled with the specified text between the entry number and title. Just make sure there is enough of the separator characters to span the space between the section number and text (hint: a ragged edge at the right indicates too few). While simple characters such as periods and hyphens are obvious choices some HTML entities are more aesthetically pleasing. The following seem to work well; ‥ ‥ ⋯ ⋯ … … (used in this document) • • ∘ ∘ ‐ ‐ _ _ and . . — just remember to have enough entities to fill that intervening space!
Alternatively, it can be set to a literal string which is prefixed to the heading title. This is intended to allow an HTML entity to delineate the headings, as in |set|toc=format=• |.
A secondary table of content can be placed at the beginning of each major section providing navigation to the |2 and |4 headings within that section. This document has secondary TOC enabled.
The secondary TOC is enabled using the |set|toc2=integer| setting. The integer speicifes the level of inclusion. Using |set|toc2=1| includes the primary TOC entries, |set|toc2=2| includes all headings.
Navigation icons provide the ↩︎ ↖︎ ↑︎ ↘︎ ↪︎ which left to right represent; history backward, previous major section, start of document (often primary TOC), next major section, history forward. Navigation items are enabled using |set|navigate=1|. This document has navigation items enabled as can be seen below the 6. Document Navigation (this) heading.
This provides an alphabetically arranged set of links into various parts of the document, collated on the first character of the reference description. Any and all headings are included (|0, |1 … |4 and |9).
The index is presented in two columns. This may be reduced to a single column or increased to three or four using |set|idx=cols=integer|.
The Index is inserted wherever the |index| tag is placed (usually towards the end of the document as with this one). If not included then no Index is generated.
| ↩︎ | ↖︎ | ↑︎ | ↘︎ | ↪︎ |