wiki:TocMacro

Version 28 (modified by osimons, 7 years ago) (diff)

Updated installation information for latest version for 0.10 and 0.11.

Table of Contents Macro

Description

The TocMacro generates a table of contents for the current page or a set of pages.

If no arguments are given, a table of contents is generated for the current page, with the top-level title stripped:

[[TOC]]

To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro. This is the macro call for the table of contents visible on the right side of this page:

[[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup, TracLogging,
TracPermissions, TracWiki, WikiFormatting, TracBrowser, TracRoadmap, TracChangeset,
TracTickets, TracReports, TracQuery, TracTimeline, TracRss, TracNotification)]]

A wildcard '*' can be used to fetch a sorted list of all pages starting with the preceding pagename stub (Since [2801]):

[[TOC(Trac*, WikiFormatting, WikiMacros)]]

For 'titleindex' argument, an empty pagelist will evaluate to all pages (Since [2801]):

[[TOC(titleindex, notitle, heading=All pages)]]

The following control arguments change the default behaviour of the TOC macro (Since [22]):

Argument Meaning
heading=<x> Override the default heading of "Table of Contents" or "Page Index" for titleindex.
noheading Suppress display of the heading.
depth=<n> Display headings of subsequent pages to a maximum depth of <n>.
inline Display TOC inline rather than as a side-bar.
titleindex Only display the page name and title of each page, similar to TitleIndex. (Since [37]).
notitle Supress display of page title (Since [2801]).

Bugs/Feature Requests

Existing bugs and feature requests for TocMacro are here.

If you have any issues, create a new ticket.

Installation

Both 0.10 and 0.11 entries at Python Package Index (pypi) are not up-to-date with latest versions and dependencies. To install the most recent versions, use direct installation from source:

easy_install http://trac-hacks.org/svn/tocmacro/0.10   # 0.10
easy_install http://trac-hacks.org/svn/tocmacro/0.11   # 0.11

...or download / check out the source from repository (see below) and install it in usual manner.

Download

download:tocmacro

TocMacro requires that AnchorPatch be applied to 0.8 Trac. Trac 0.9 already includes this patch.

Source

You can check out the source for TocMacro from Subversion at http://trac-hacks.org/svn/tocmacro.

Example

[[TOC(inline, heading=Trac Table of Contents, TracGuide, TracInstall, depth=2,
 TracLogging, depth=99, TracPermissions)]]

On the right you can see the TOC macro version of the default TracGuideToc macro.

Do not forget to enable the macro in trac.ini (at least with 0.11 and 0.10.4) in the components section like this:

tractoc.* = enabled

Change Log

[13602] by rjollos on 2014-01-21 07:53:51
11.0.0.4: Indicate in documentation when reverse argument was added. Refs #11513.
[13594] by rjollos on 2014-01-21 06:29:24
11.0.0.4: Added parameter for reversing the order in which the pages are sorted. Fixes #11513.

Patch by mitja.jez.

[13593] by rjollos on 2014-01-21 06:29:17
11.0.0.4: Added setup.cfg file.

Author/Contributors

Authors: athomas, jouvin, coderanger, cboos, osimons