|Version 29 (modified by anonymous, 9 years ago) (diff)|
Table of Contents
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 ):
[[TOC(Trac*, WikiFormatting, WikiMacros)]]
For 'titleindex' argument, an empty pagelist will evaluate to all pages (Since ):
[[TOC(titleindex, notitle, heading=All pages)]]
The following control arguments change the default behaviour of the TOC macro (Since ):
|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 ).|
|notitle||Supress display of page title (Since ).|
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 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.
[[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
- 14544 by rjollos on 2015-04-20 16:03:19
22.214.171.124: tag_svn_revision is not supported in setuptools ≥ 10.
- 14509 by rjollos on 2015-03-29 00:47:54
126.96.36.199: Avoid traceback by ensuring that resource.id is a string. Fixes #12254.
- 13602 by rjollos on 2014-01-21 07:53:51
188.8.131.52: Indicate in documentation when reverse argument was added. Refs #11513.