Skip to main content

A Trac macro that displays the bodies of wiki pages inside other wiki pages

Project description

Overview

TracSubPages is a Trac plugin that supplies a macro allowing full wiki pages to be displayed inside of other wiki pages. This is useful if there is a piece of content (such as a contact table or log) that needs to be displayed in multiple places, as it eliminates the need for each instance of this content to be maintained.

Usage

The syntax for the subpage macro is simple:

[[subpage(wiki_page[, show_link])]]

Where wiki_page is the wiki page (No url is needed here, nor ‘wiki/’, just the page). The macro supports pages that aren’t top-level, too (‘BigCategory/SpecificSubject’). The second argument, showlink is an optional argument (true or false) that determines whether or not a link to edit the rendered page will be shown at the bottom of the subpage section (The link reads ‘Edit Section’ and provides a link directly to the edit page of the referenced wiki page).

Limitations

  • A wiki page needs to exist before you link to it with a subpage macro. This may seem obvious, but the error caused by a broken link isn’t very descriptive (yet).

  • Please use only wiki formatting for subpages. The use of macros can (and probably will) cause errors.

Change History

0.2(2009-08-11)

  • Changed macro syntax to not require true/false argument

  • Cleaned up code to better adhere to PEP 8

0.1(2009-08-11)

  • Initial release of plugin

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TracSubPages-0.2.tar.gz (2.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page