TOC Macro

Last modified by Admin on 2017/10/05 15:23

cogGenerates a Table Of Content for titles (headings)
TypeJAR
Developed by

XWiki Development Team

Active Installs0
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Installable with the Extension Manager

Description

Each title has an anchor associated to it.

Usage

{{toc start=2 depth=6 numbered=false scope=page /}}

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
startyes1 - 62an initial level where the TOC generation should start at (the default is level 2 because level 1 is considered as a document title)
depthyes1 - 66maximum level the TOC is generated for
numberedyestrue/falsefalseif should generate numbering for titles (see examples below)
scopeyespage/localpageIf local, only section in the current scope will be listed. For example if the macro is written in a section, only subsections of this section will be listed. Not used if a reference is specified (since in this case the scope is always page)
referenceyesReference to a pageCurrent pageThe page for which to generate the TOC for. If not specified, generate a TOC for the current page. Since 9.6RC1

Example 1: Simple

{{toc /}}

= Level 1

Hello

== Level 2

Result

toc1.png

Example 2: Floating

{{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}}

= Level 1

Hello

== Level 2

Result

toc2.png

Example 3: Different numbering of sub lists

With a bit of CSS you can change the numbering of subitems. For example add a StyleSheetExtension Object to your page and put the following content (select Always on this page):

ol { list-style-type: none; counter-reset: say; }
ol li:before { counter-increment: say; content: counters(say,".") ". "; }

With this extension, the following content will have, for example, Level 2 displayed as 1.1 (see Result below):

{{toc numbered="true"/}}

= Level 1
== Level 2
== Level 3
= Level 4
== Level 5

Result

toc3.png

Example 4: TOC numbering corresponding at Numbered Headings

(Proposed by Pascal B)

If you use Numbered Headings and TOC macro to display a floating TOC, you can use the same numerotation.
You must install Numbered+Headings, Box macro and of course TOC Macro.
Then add a StyleSheetExtension Object to your page and put the following content (you can select Always on this wiki):

div.box.floatinginfobox ol { list-style-type: none; counter-reset: say; }
div.box.floatinginfobox ol li:before { counter-increment: say; content: counters(say,".") " "; }

With this extension, the following content will have, for example, Level 2 displayed as 1.1 (see Result below):

{{numberedheadings/}}

{{box cssClass="floatinginfobox" title="**Nice TOC**"}}
{{toc numbered="true" depth="3"/}}
{{/box}}

= Level 1
== Level 2
== Level 3
= Level 4
== Level 5

Result

toc4.png

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
6.1XWiki Enterprise 6.1

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.rendering:xwiki-rendering-macro-toc 9.8.1):

Tags:
Created by Thomas Mortagne on 2008/09/30 11:44
    

Get Connected