TOC



The TOC standard function 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.


##TOC (bool {alphabetized})


  • Name: alphabetized {Optional}
    • Type: bool
    • Default: false
    • Description: Whether the table of contents is alphabetized or ordinal based.




Code:
##TOC

##TOC(true)



Function Calling Convention
Scope Function
Instruction Function
Standard Function


Wiki Help :: Scope Function
Scope functions apply a function over a defined scope of wiki text.
Wiki Help :: SearchCloud
Create a cloud of pages from a search of wiki body contents.
Wiki Help :: SearchList
Create a list from a search of wiki body contents.
Wiki Help :: Seq
Automatically create a numbered sequence on a page.
Wiki Help :: Set
Set wiki page variable value.
Wiki Help :: Similar
Create a list of similar pages based on tag similarities.
Wiki Help :: SiteName
Displays the name of the configured site.
Wiki Help :: Snippet
Injects the value of a previously defined snippet variable.
Wiki Help :: Standard Function
Standard functions are general use functions used by contributors to build a page and make it dynamic.
Wiki Help :: StripedTable
The StripedTable scope function allows you to create tables with columns and alternating colored rows.