Version 28 (modified by Odd Simon Simonsen, 9 years ago) (diff)

Updated installation information for latest version for 0.10 and 0.11.

Table of Contents Macro


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:


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.


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   # 0.10
easy_install   # 0.11

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



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


You can check out the source for TocMacro from Subversion at


[[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

15937 by rjollos on 2016-10-27 22:44:36 Skip permission check on resource containing the TOC

Permission must have already been granted on this resource
if the macro is being executed. An effect of this change is that
TOC can be used in resources other than wiki pages, such as
blog posts, as long as the TOC is only created for the post
containing the TOC macro.

Fixes #12914.

15935 by rjollos on 2016-10-26 21:25:12 Cleanup whitespace
14544 by rjollos on 2015-04-20 16:03:19 tag_svn_revision is not supported in setuptools ≥ 10.


Authors: athomas, jouvin, coderanger, cboos, osimons