Version 10 (modified by 18 years ago) (diff) | ,
---|
Table of Contents
- The Trac User and Administration Guide
- Trac Installation Guide for 1.2
- Upgrade Instructions
- Instructions
- 1. Bring your server off-line
- 2. Update the Trac Code
- 3. Upgrade the Trac Environment
- 4. Update the Trac Documentation
- 5. Refresh static resources
- 6. Steps specific to a given Trac version
- 7. Restart the Web Server
- Known Issues
- Related topics
- Instructions
- The Trac Configuration File
- TracAdmin
- Trac Backup
- Trac Logging
- Trac Permissions
- The Trac Wiki System
- WikiFormatting
- The Trac Repository Browser
- The Trac Roadmap
- Trac Changeset Module
- The Trac Ticket System
- Trac Reports
- Trac Ticket Queries
- The Trac Timeline
- Using RSS with Trac
- Email Notification of Ticket Changes
Table of Contents Macro
Notice: This plugin is unmaintained and available for adoption.
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 TOC inline rather than as a side-bar. |
titleindex 2 | Only display the page name and title of each page, similar to TitleIndex. |
Bugs/Feature Requests
Existing bugs and feature requests for TocMacro are here.
If you have any issues, create a new ticket.
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.swapoff.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.