Changes between Initial Version and Version 1 of TracSubPagesMacro

Timestamp:

Aug 11, 2009, 5:30:51 PM (15 years ago)

Author:

Jimmy Theis

Comment:

--

TracSubPagesMacro

@@ +1 @@
+= Pages Within Pages =
+
+== 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.
+
+== Install !TracSubPages ==
+
+ * By hand:
+   * 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 trac.ini (create [components] if it does not exist)
+
+{{{
+[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.
+
+== Download ==
+
+Download the zipped source from [http://pypi.python.org/pypi/TracSubPages/ here].
+
+== 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). 
+
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:jetheis Jimmy Theis] [[BR]]
+'''Contributors:''' claytron