Skip to topic | Skip to bottom
TWiki
TWiki.TreePluginr1.1 - 06 Nov 2006 - 20:16 - Main.guesttopic end

Start of topic | Skip to actions

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
  • 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).
Contents:

File: Description:
data/Plugins/TreePlugin.txt Plugin topic
data/Plugins/TreePlugin.txt,v Version file of Plugin topic
data/Plugins/TreePluginSamples.txt Plugin Samples
data/Plugins/TreePluginSamples.txt,v Version file of Plugin Samples
data/Plugins/HeadingOutlineSample.txt Heading Outline Sample
data/Plugins/HeadingOutlineSample.txt,v Version file of Heading Outline Sample
data/Plugins/TreeBookviewOutlineSample.txt Tree Bookview Outline Sample
data/Plugins/TreeBookviewOutlineSample.txt,v Version file of Tree Bookview Outline Sample
lib/TWiki/Plugins/TreePlugin.pm Plugin Perl module
lib/TWiki/Plugins/TreePlugin/ColorNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/FormatHelper.pm Library component
lib/TWiki/Plugins/TreePlugin/FormatOutlineNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/HOutlineNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/ImgNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/ListNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/TreePlugin/Node.pm Library component
lib/TWiki/Plugins/TreePlugin/NodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/OutlineNodeFormatter.pm Library component
lib/TWiki/Plugins/TreePlugin/TWikiNode.pm Library component
lib/TWiki/Plugins/TreePlugin/test.tar.gz Test files
pub/TWiki/TreePlugin/I.gif tree icon
pub/TWiki/TreePlugin/L.gif tree icon
pub/TWiki/TreePlugin/oL.gif tree icon
pub/TWiki/TreePlugin/oT.gif tree icon
pub/TWiki/TreePlugin/pL.gif tree icon
pub/TWiki/TreePlugin/pT.gif tree icon
pub/TWiki/TreePlugin/T.gif tree icon
pub/TWiki/TreePlugin/white.gif tree icon
templates/booktree.tmpl Template for bookview mode

  • 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:

Descendancy Chart for 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

One Line Description: View Twiki topics as nodes in a tree
Plugin Author: SlavaKozlov?
Plugin Version: 0.2
Change History: 08 Feb 2002 Internal (0.1) release
  15 Feb 2002 Alpha (0.2) release
CPAN Dependencies: none (test package relies on PerlUnit?)
Other Dependencies: none
Perl Version: 5.0 (only tested on 5.6.1 so far)
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/TreePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/TreePluginDev

Related Topics: TWikiPreferences, TWikiPlugins

Copyright

This code is protected by the following copyrights:
  • Copyright (C) 2002 Slava Kozlov. All Rights Reserved.

License

As required for the publication of all extensions to TWiki, this software is published under the terms of the GNU General Public 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
to top


You are here: TWiki > TreePlugin

to top

Copyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback