Loading...
 
Skip to main content

History: Auto TOC

Source of version: 15 (current)

Copy to clipboard
            {syntax type="markdown"  editor="wysiwyg"} # {{page}}

Starting in ((Tiki12)), a new feature to allow adding an automatic Table Of Contents ("Auto TOC") has been added to the Wiki. And starting in ((Tiki23)), you can have more options via ((PluginAutoTOC))

## Enable it

Auto-toc can be enabled as admin through the admin panel in "**Admin home > Wiki > General Preferences (Tab) > Section *Automatic table of contents* (*Page Display* before Tiki 15) > Wiki auto-toc**"

You can also choose:

- the default for each page (which can be overridden per page)
- If the top TOC should be inserted into the page content or not
- Position left or right
- Offset from the top


{img src="display1767" link="display1767" width="400" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"}

Auto TOC is not included in the print view of the page.

## Usage

Auto-toc will add the TOC in two places.

1. A static TOC located at the top of the page. The TOC is inserted into the page content at runtime. 
    - Example: 
         {img src="display857" link="display857" width="600" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"}
2. A floating TOC, located at the top of the browser window. This TOC is only visible when you scroll down past the top of the page. 
    - Example: 
         {img src="display858" link="display858" width="600" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"}



Additionally, you can also see it in action in the screencast below.

{CENTER()}{flash type="url" movie="https://dev.tiki.org/display372" width="550" height="500"}{CENTER}

## Disable it in some pages

You can disable it in some wiki pages. In order to do so, edit the page, go to the properties tab, and set "**Page display options > Automatic Table of Contents generation**" to "**off**":

{img src="display962" link="display962" width="500" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"}

## Related pages

- ((PluginToc))
- ((PluginMaketoc)) - makes a table of contents from the headings on a page

## Aliases

- (alias(Autotoc))
- (alias(Auto-toc))