TracSubPages 0.5

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

For example, if a user had created a wiki pages called ‘Minutes’ and wanted to display it inline in another wiki page without a link to edit it, he or she would add the following entry to the wiki page that is intended to display the extra content:

[[subpage(Minutes, False)]]

If the user later decided that he or she wanted a link to be placed at the bottom of the inline section for quick editing, the entry should be changed as follows:

[[subpage(Minutes)]]

Note that the second boolean argument ‘True’ is not needed, as it is assumed by default.

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.

0.5(2011-03-03)

• Begin using MANIFEST.in in the absence of a Subversion repository

0.4(2010-07-13)

• Fixed unicode bug that caused errors when given non-ASCII characters [jetheis]

0.3(2010-01-10)

• All code adheres to PEP 8 standards [jetheis]

• Added ez_setup.py to package [jetheis]

• Changed license to GPLv3 [jetheis]

0.2(2009-08-11)

• Changed macro syntax to not require true/false argument [jetheis]

• Cleaned up code to better adhere to PEP 8 [jetheis]

0.1(2009-08-11)

• Initial release of plugin [jetheis]