TOC
Overview
The TOC standard function is displays a table of contents based on the head tags in the page. Each heading will be linked to the header anchors to allow skipping directly to a given section. By default. the table of contents is built in the order that the page headings are found thereby creating a reasonable document outline. However, you can override this behavior by passing true to the alphabetized parameter. When alphabetized, the table retains the basic hierarchy, but the members are order alphabetically.
Prototype
##TOC(bool {alphabetized})
Parameters
- Name: alphabetized {Optional}
- Type: bool
- Default: false
- Description: Whether the table of contents is alphabetized or ordinal based.
Examples
##TOC
##TOC(true)
See Also
Function Calling Convention
Scope Function
Instruction Function
Standard Function
Related