wiki:TocMacro

Version 1 (modified by athomas, 9 years ago) (diff)

New hack TocMacro, created by athomas

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)]]

The following control arguments change the default behaviour of the TOC macro1:

Argument Meaning
heading=<x> Override the default heading of "Table of Contents"
noheading Suppress display of the heading.
depth=<n> Display headings of subsequent pages to a maximum depth of <n>.
inline Display headings inline rather than as a side-bar.
titleindex2 Only display the page name and title of each page, similar to TitleIndex.


  1. 1. Supported from [22]
  2. 2. Supported since [37]

Bugs/Feature Requests

Existing bugs and feature requests for TocMacro are here.

If you have any issues, create a new ticket.

Download

TocMacro for 0.8.

Source

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

Example

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

Author/Contributors

Author: athomas
Contributors:

TagIt(macro,athomas,0.8)?