DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:toctweak

TocTweak Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes

plugin Show tailored table of contents (TOC) of specified page/section in the page content

Last updated on
2018-01-08
Provides
Syntax, Action
Repository
Source
Conflicts with
inlinetoc, toc, tocafterheadline

Similar to inlinetoc, toc, tocafterheadline

Tagged with toc

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Current development work in progress under Version 2.x series. In case you want to get older plugin version, please visit:

Feature

Implement different mechanism for table of contents (TOC). TocTweak plugin (version 2) will store all headlines in the page to metadata (even if some of them are not shown in toc box), and provide METATOC syntax variants that render tailored TOC block inside the page content using metadata.

Examples/Usage v2

Control macro for DokuWiki built-in TOC

~~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
Note
  • Headlines level parameter must be “n-m”, “n” or “-m” format.
  • The built-in toc box (or auto-TOC) should be one per page, therefore more than once “~~TOC_HERE~~” will be ignored.

METATOC: Another method to show TOC (in different looks/design)

METATOC variants

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.

  1. {{METATOC}} : Headline list with hierarchical numbers
  2. {{TOC}}: similar looks of DW built-in TOC box without open/close feasure.
  3. {{INLINETOC}} : Headline list in rounded box
  4. {{SIDETOC}} : dedicated to use in sidebar page

METATOC 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}}
Note
  • The section title may contains spaces, therefore headline level parameter must be given before “>”.
  • set TOC title blank (given after “|”) to remove default title – “Table of Contents”.
  • SIDETOC ignores n-m parameter, which will be retrieved from metadata of current page.

Examples/Usage v1

1. Set the TOC initially closed

~~CLOSETOC~~
  • The TOC box will be initially closed state (in case the TOC is displayed in the page). This is a kind of control macro without creating any output itself.

2. Set top and max level of headings displayed in the TOC

~~TOC 2-4 ~~
  • Control the content of the TOC for the page. There are two numeric parameters: toptoclevel and maxtoclevel repectively.
  • Above example will exclude the page title (i.e. the first level 1 heading) from the TOC. Headings from level 2 to 4 included in the automatically generated Table of Contents.
  • You can tweak either top or max level of headings, for example:
    ~~TOC 2~~
    ~~TOC -3~~

3. move TOC position

{{TOC}}
  • Move/slide the TOC box placed at top right corner to anywhere in the page. Exactly, the TOC position is changeable only vertically in the page because the macro {{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}}
  • You can add css class to the TOC div box identifed with #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}}
  • You may give both class and heading levels parameter in this syntax.

4. inline TOC

{{INLINETOC width18 3-4}} 
  • This syntax renders TOC of a page inside the page content. “width18” class is defined in all.css of this plugin.

Configuration and Settings

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.


Development

Backward incompatible changes

ver.2 (2018-01-08)

  1. Previously in version 1.x, {{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.
  2. DokuWiki Auto-TOC must exist only one per page whenever it should be shown. Use of ~~TOC_HERE~~ macro is restricted to once in a page.

Change Log from github repository

Bug reports and feature requests

Please refer to the issue tracker (link button found at near page top) for reporting issues.


Discussion

Here are obsoleted topics of TocTweak plugin Version 1.x


Awesome plugin! I have one problem though… It seems like the {{INLINETOC:width18}} wont work. I look at the element in the source code and the css class is not applied to the inline-toc. Have I missed some vital information or is this a nasty bug? — fnadde42fnadde42

2015-05-19 16:53

If you put {{INLINETOC:width18}} and {{INLINETOC}} in the same page (for example at page top and bottom), the css class will not apply for both inline-toc block. — s.saharas.sahara

2015-05-26 12:06

Very nice plugin !
I think there is mistake in this page in chapter 3 and 4 : the css class and max level is not in the same order between {{TOC:2-3 wide}} and {{INLINETOC:width18 3-4}}.
In my situation, when using {{INLINETOC:width18 3-4}}, the 3-4 or whatever I put in is ignored. I just installed it (22/07/2014). What am I doing wrong ?

Thanks for comment and reporting. I confirmed that ignored level values after class name parameter. I will update plugin code in sometime soon. — s.saharas.sahara

2014-07-24 10:13
New release 2014-07-24! I hope the parameter order issue now fixed. — s.saharas.sahara

2014-07-24 11:37

The inlineToc doesn't work well for RTL screens. The bullets are placed out of the TOC box. Also there is no indent shown for lower headers. <05/06/2014>
→ RTL styles added in all.css since 2014-05-07 release. Please check and comment here if it is enough for RTL languages, with those the plugin author is not familiar.


Feature Request

Enable users to call table of content via namespace as well. E.g.

{{TOC:2-3 ns:animals:dog#habits}}

This displays the TOC for heading 2-3 for page-section id(#habits) in page(dog) in namespace (animals) into any page that calls this syntax.

- James 26/8/2014


Enable a TOC per section on a page that can be inserted under a header rather than a TOC for the entire page.

-Justin 25/6/2016

plugin/toctweak.txt · Last modified: 2018-05-28 22:04 by Klap-in