trac-ticketlinks / wiki-macros / TracGuideToc.py

# -*- coding: utf-8 -*-
"""
This macro shows a quick and dirty way to make a table-of-contents for a set
of wiki pages.
"""

TOC = [('TracGuide',                    'Index'),
       ('TracInstall',                  'Installation'),
       ('TracUpgrade',                  'Upgrading'),
       ('TracIni',                      'Configuration'),
       ('TracAdmin',                    'Administration'),
       ('TracBackup',                   'Backup'),
       ('TracLogging',                  'Logging'),
       ('TracPermissions' ,             'Permissions'),
       ('TracWiki',                     'The Wiki'),
       ('WikiFormatting',               'Wiki Formatting'),
       ('TracTimeline',                 'Timeline'),
       ('TracBrowser',                  'Repository Browser'),
       ('TracChangeset',                'Changesets'),
       ('TracRoadmap',                  'Roadmap'),
       ('TracTickets',                  'Tickets'),
       ('TracQuery',                    'Ticket Queries'),
       ('TracReports',                  'Reports'),
       ('TracRss',                      'RSS Support'),
       ('TracNotification',             'Notification'),
       ('TracInterfaceCustomization',   'Customization'),
       ('TracPlugins',                  'Plugins'),
       ]

def execute(hdf, args, env):
    html = '<div class="wiki-toc">' \
           '<h4>Table of Contents</h4>' \
           '<ul>'
    curpage = '%s' % hdf.getValue('wiki.page_name', '')
    lang, page = '/' in curpage and curpage.split('/', 1) or ('', curpage)
    for ref, title in TOC:
        if page == ref:
            cls =  ' class="active"'
        else:
            cls = ''
        html += '<li%s><a href="%s">%s</a></li>' \
                % (cls, env.href.wiki(lang+ref), title)
    return html + '</ul></div>'
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.