~~CLOSETOC~~ Let the TOC box initially closed ~~TOC 2-3~~ Headlines within level 2 to 3 will appear in the TOC box ~~NOTEC 2-3~~ No TOC box on the page, but set headline level parameter ~~TOC 2-3 wide~~ Widen the TOC box by assigning "wide" css class ~~TOC_HERE 2-3~~ Locate the TOC box where the macro is placed in the page
~~TOC_HERE~~
” will be ignored.TocTweak plugin provides following syntax to render toc block in pages where it is located in source. These are implemented as variants of basic METATOC syntax, and can be used multiple times in a page.
{{METATOC}}
: Headline list with hierarchical numbers{{TOC}}
: similar looks of DW built-in TOC box without open/close feasure.{{INLINETOC}}
: Headline list in rounded box{{SIDETOC}}
: dedicated to use in sidebar pageMETATOC syntax family can render headline list of other page. It is also possible to specify starting section title, headline level range, and TOC box title.
{{METATOC 3-3 >:wiki:syntax#Text Conversions | Text Conversions}} {{METATOC 3-3 >:wiki:syntax#Text Conversions |}} {{METATOC 2-3 >#section title}} {{METATOC 2-3}}
~~CLOSETOC~~
~~TOC 2-4 ~~
~~TOC 2~~ ~~TOC -3~~
{{TOC}}
{{TOC}}
in the Wiki text is to be rendered as same as original TOC html. Maybe useful if you want to place the TOC box after the second heading in order to avoid confliction with the tags line. {{TOC wide}}
#dw__toc
. Above example will apply class name “wide” to the TOC box, which is then identified as #dw__toc.wide
, and the TOC will be displayed with 100% width in the page. “wide” class is defined in style.css of this plugin.{{TOC 2-3 wide}}
{{INLINETOC width18 3-4}}
The plugin can be configured with the Configuration Manager in the admin menu.
tocAllHeads | Store all headlines to page metadata |
---|---|
tocPosition | Change always auto-TOC position for normal pages |
0: default (top-right) | |
1: after the First Level 1 headline | |
2: after the First Level 2 headline | |
6: after the First headline | |
9: disable auto-TOC. | |
toptoclevel | Upper level of headline which can appear in table of contents |
maxtoclevel | Lower level of headline which can appear in table of contents |
tocminheads | Minimum amount of headlines that determins whether the TOC is built |
TocTweak plugin supersedes global config settings toptoclevel, maxtoclevel and tocminheads. Especially when tocAllHeads is on, global toptoclevel and maxtoclevel values are set to 1 and 5 respectively.
ver.2 (2018-01-08)
{{TOC}}
syntax was available to move DokuWiki Auto-TOC box from top right corner to other place inside the page. Since version 2.x, it has changed to render METATOC instead of Auto-TOC. Alternative ~~TOC_HERE~~
macro is available.~~TOC_HERE~~
macro is restricted to once in a page.Please refer to the issue tracker (link button found at near page top) for reporting issues.