View topic | Edit | WYSIWYGAttachPrintable
r14 - 07 Apr 2007 - 10:46:22 - StephaneLenclud?You are here: Astrophysics Wiki >  TWiki Web  > TreePlugin

Tree Plugin

Renders topics' parent-child relationships as hierarchical tree view. Useful for dynamic site maps and threads.

Syntax Rules

%TREEVIEW{}% displays topic children in a hierarchical tree
%TREE{}% synonym of %TREEVIEW{}%

Parameter Description Default
web The web to search. current web
topic Specify tree's root topic. If none the entire web topics' tree is generated none
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:colorlist is an outline formatting with level values turned into colors, see sample Nested tables. Example: formatting="coloroutline:#ffeeff,#eeffee,#ffffee,#eeeeff,#ffeeee,#eeffff"
imageoutline:mode is a way to incorporate images into the outline format, specifically to display thread-like and folder views, see sample Image Trees. The general format is: imageoutline: mode : images : imageformat. Example: formatting="imageoutline:thread" or formatting="imageoutline:thread:I.gif,white.gif,T.gif,L.gif:<img src=\"$image\" border=\"0\">".
excludetopic Same meaning as VarSEARCH excludetopic. Topics with excluded parent or processed like topic without parent. none
includetopic Same meaning as VarSEARCH topic. Can improve processing time. none
startlevel The depth of the tree to start showing nodes from. To hide the root node, supply startlevel="1" (root is level 0). The displayed node depths are relative to the root topic. 0 or 1 if topic is not specified
stoplevel The depth of the tree to show, relative to start level. 999
header If specified output the value within a <div> of class treePluginHeader. none
bookview List topics in BookView form none
format Specify the format for each node (outline & coloroutline). The following pseudo-variable are supported on top of the ones described in FormattedSearch:
$spacetopic - the topic with spaces
$level - the tree depth of the topic (in whatever format)
$count - the topic's child position
$index - the index of the topic in the tree. Starts from one. Most useful when used in combination with TreeBrowserPlugin
$onum - outline number for the topic (eg,
$url - the current topic's URL
$author - the topic's last author Not supported from v0.9. Use %AUTHOR% instead.
$modTime - the topic's modification time. Not supported from v0.9
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)
levelprefix Specify a prefix to a node format. The prefix is inserted $level times at the beginning of the rendered node format. It allows generation of trees using TWiki bullet list syntax thus enabling usage of TreePlugin in combination with TreeBrowserPlugin. none
nodiv Suppress the <div> around the tree. Allows for trees concatenation. none


See the following pages for sample usage and output.


%TREE{web="Sandbox" formatting="ullist"}%


%TREE{excludetopic="Web*" formatting="outline" format="* [[$topic][$spacetopic]]" levelprefix="   " startlevel="1"}%

Combination with TreeBrowserPlugin

%TREEBROWSER{"file" title="%WEB%"}%
%TREEVIEW{web="%WEB%" topic="GrandParent" formatting="outline" format="* $topic" levelprefix="   "}%

Performance consideration

For each %TREE% or %TREEVIEW% tag a VarSEARCH at topic scope is performed. To reduce the scope of that search one can use includetopic and excludetopic. Those two parameters should be used by TreePlugin users worried about performance. In fact they can potently greatly reduce the processing time.

For instance if you know that every topic in your tree has a common prefix you can easily make use of includetopic. Also when generating web tree you may want to excludetopic prefixed with Web.

Plugin Settings

Specify plug-in settings on TWikiPreferences using:


Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip in your ($TWIKI_ROOT) directory.
  • Alternatively,
    • Manually resolve the dependencies listed below. None

Plugin Info

Authors: TWiki:Main.SlavaKozlov (alpha release), TWiki:Main.StephaneLenclud (2006-2007)
Copyright ©: Copyright (C) 2002 Slava Kozlov. All Rights Reserved.
License: GPL
Dependencies: None
CPAN Dependencies: none (test package relies on Wiki:PerlUnit)
Perl Version: 5.0, 5.6.1, 5.8.7
Change History:  
7 Apr 2007 1.2 - Documentation improvement. Adding includetopic parameter. By TWiki:Main.StephaneLenclud
6 Apr 2007 1.1 - Even more code cleaning. Rewrote tree building algorithm. Orphaned topics are now sorted as if child of the web root. No more blank line in the middle of the tree. Adding nodiv parameter. By TWiki:Main.StephaneLenclud
6 Apr 2007 1.0 - More code cleaning. Testing most formatting. Better support for web="all". By TWiki:Main.StephaneLenclud
6 Apr 2007 0.9 - Support for FormattedSearch pseudo-variables. Code cleaning in Removed some dead code. Improved documentation. By TWiki:Main.StephaneLenclud
4 Apr 2007 0.8 - Adding excludetopic parameter. Adding %TREE% as synonym tag. Code cleaning in Fix root issue when no topic specified. By TWiki:Main.StephaneLenclud
14 Mar 2007 0.7.1 - Arthur Clemens: Made startlevel and stoplevel relative to the root topic.
14 Mar 2007 0.7 - Arthur Clemens: web parameter is now actually used. Added parameter startlevel.
01 Oct 2006 0.6 - TWiki:Main.StephaneLenclud: adding $index format subsitution. Useful when used in combination with TWiki:Plugins/TreeBrowserPlugin. Also attempting to restore compatibility with Cairo, but still waiting for someone to test it.
16 Sep 2006 0.5 - TWiki:Main.StephaneLenclud: adding levelprefix parameter to unable usage in combination with TWiki:Plugins/TreeBrowserPlugin.
26 Jul 2006: 0.4 - TWiki:Main.SteffenPoulsen: Ported to TWiki 4 (Dakar). Leading text removed, less warnings, no double bracket links, CSS classnames around output.
15 Feb 2002 Alpha (0.2) release
08 Feb 2002 Internal (0.1) release

Related Topics: TWikiPreferences, TWikiPlugins

toggleopenShow attachmentstogglecloseHide attachments
Topic attachments
I Attachment Action Size Date Who Comment
elsebak pT.gif.bak manage 0.9 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak white.gif.bak manage 0.1 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak pL.gif.bak manage 0.9 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak I.gif.bak manage 0.8 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak T.gif.bak manage 0.9 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak oL.gif.bak manage 0.9 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak oT.gif.bak manage 0.9 K 01 Oct 2006 - 20:08 UnknownUser  
elsebak L.gif.bak manage 0.8 K 01 Oct 2006 - 20:08 UnknownUser  
View topic | Edit |  | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r2 < r1 | More topic actions...

key Log In or Register

Main Web Users Groups Index Search Changes Notifications Statistics Preferences

Webs Main Sandbox TWiki Zen Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences

Webs Main Sandbox TWiki Zen

Astrophysics Wiki

Edit Wysiwyg Attach Printable
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Astrophysics Wiki? Send feedback
Note: Please contribute updates to this topic on at TWiki:TWiki.TreePlugin