wiki:TracSubPagesMacro

Display another wiki page within a wiki page

Description

This plugin allows full Trac wiki pages to be displayed inside other Trac 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.

The syntax for the subpage macro is as follows:

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

Where wiki_page is the wiki page. No url is needed here, nor a wiki/ prefix, 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.

See also: IncludeMacro

Download

Download the zipped source from here.

Installation

  • Manually:
    • Download and untar the source directory.
    • Drop the compiled egg into the plugins directory of your Trac instance:
      $ python setup.py bdist_egg
      $ cp dist/CustomSelectAdmin<ADDITIONAL-INFO>.egg <PATH-TO-TRAC-INSTANCE>/plugins
      
  • Globally:
    • easy_install the egg so it will apply to all Trac instances:
      $ easy_install TracSubPages
      

Add the following lines to your trac.ini file:

[components]
TracSubPages.* = enabled

Or, if you you don't have access to trac.ini but do have the TRAC_ADMIN permission (the Admin panel shows up in the main nav when you're logged in), you can go to the Plugins section within the Admin area and check 'Enabled' next to CustomSelectAdmin.

Author/Contributors

Author: Jimmy Theis
Maintainer: Component "TracSubPagesMacro" does not exist
Contributors: claytron

Last modified 3 months ago Last modified on Sep 23, 2016, 9:35:02 AM