Changes between Version 6 and Version 7 of TracSubPagesMacro


Ignore:
Timestamp:
Jul 20, 2015, 12:46:41 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracSubPagesMacro

    v6 v7  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Display another wiki page within a wiki page =
    32
    4 == Overview ==
     3= Display another wiki page within a wiki page
    54
    6 !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.
     5== Description
     6
     7This plugin allows full wiki pages to be displayed inside 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.
    78
    89See also: IncludeMacro
    910
    10 == Install ==
     11== Download
     12
     13Download the zipped source from [http://pypi.python.org/pypi/TracSubPages/ here].
     14
     15== Installation
    1116
    1217 * Manually:
     
    2328     }}}
    2429
    25 Add the following lines to trac.ini (create [components] if it does not exist)
    26 
    27 {{{
     30Add the following lines to your `trac.ini` file:
     31{{{#!ini
    2832[components]
    2933TracSubPages.* = enabled
    3034}}}
    3135
    32 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
     36or, 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
    3337when you're logged in), you can go to the Plugins section within the Admin area and check 'Enabled' next to !CustomSelectAdmin.
    3438
    35 == Download ==
     39== Usage
    3640
    37 Download the zipped source from [http://pypi.python.org/pypi/TracSubPages/ here].
    38 
    39 == Usage ==
    40 
    41 The syntax for the subpage macro is simple:
     41The syntax for the subpage macro is as follows:
    4242
    4343{{{
     
    4545}}}
    4646
    47 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).
     47Where `wiki_page` is the wiki page. No url is needed here, nor a `wiki/` prefix, just the page.
    4848
    49 == Author/Contributors ==
     49The 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.
     50
     51== Author/Contributors
    5052
    5153'''Author:''' [wiki:jetheis Jimmy Theis] [[BR]]
    52 '''Maintainer:''' [wiki:jetheis Jimmy Theis] [[BR]]
     54'''Maintainer:''' [[Maintainer]] [[BR]]
    5355'''Contributors:''' claytron