EUROVO FC

AVO

EGG

Main

Know

Test

TWiki
WelcomeGuest
TWikiTutorial
WikiSyntax
GoodStyle
TWikiDocumentation
TWikiShorthand

TreePlugin

Enables dynamic generation of TWiki topic trees based on topics' parent-child relationships.

Useful for dynamic sitemaps and threads.

Alpha release. Documentation will be enhanced. More features finalized.

TreePlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Dynamic generation of TWiki topic trees

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

Syntax Rules

Adds the following tags:

• %TREEVIEW% - displays a TWiki topic's children in a hierarchical fashion.

Attributes:

• web - specify web
• topic - specify tree's root topic (if none, will do the entire web)
• formatting - specify the formatting method
  • ullist is a <ul>-list, see sample UL lists
  • ollist is a <ol>-list, see sample OL lists
  • outline is an outline list, see sample Outlines
  • hlist is a <hn>-list of section heads, see sample Headlines
  • coloroutline is an outline formatting with level values turned into colors, see sample Nested tables
  • imageoutline is a way to incorporate images into the outline format, specifically to display thread-like and fodler views, see sample Image Trees
• stoplevel - the depth of the tree to show
• header - header output
• bookview - list topics in BookView form
• format - specify the format for each node (outline & coloroutline). Format variable options:
  • $topic - the topic name
  • $web - the topic's web
  • $spacetopic - the topic with spaces
  • $summary - the topic's summary
  • $text - the topic's text (which will get rendered)
  • $author - the topic's last author
  • $modTime - the topic's modification time
  • $level - the tree depth of the topic (in whatever format)
  • $count - the topic's child position
  • $onum - outline number for the topic (eg, 1.3.4.2)
  • $url - the current topic's URL
• formatbranch - specify the format for a group of children (outline & coloroutline)
  • $parent - the text of a node
  • $children - the text of all the node's children (if any)

See Plugins.TWiki.TreePluginSamples for samples usage and output.

Limitations and Known Issues

• The parameter web does not work correctly. The Tree gets rendered, but the WikiWords of the topics do not contain the web value, but refers to the current web. Since I have limited knowledge of perl OO, I can't repair for now. -- MartinRaabe^? - 16 Jan 2003

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below).
  

• Unzip TreePlugin.zip in your twiki installation directory.
• Add Plugins.TreePlugin to the INSTALLEDPLUGINS variable in TWikiPreferences (or any WebPreferences^? topic).
• If you see a tree of this topic here:

Tree for specific topic TreePlugin TreePlugin
1 TreePluginSamples
1.1 HeadingOutlineSample
1.2 TreeBookviewOutlineSample

then installation was successful.

• If you have Wiki:PerlUnit, you can unzip the test file, chdir to test, and run TestRunner^?.pl.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

Copyright

• Copyright (C) 2002 Slava Kozlov. All Rights Reserved.

License

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details, published at http://www.gnu.org/copyleft/gpl.html

-- SlavaKozlov^? - 16 Feb 2002