Tree Browser Plugin

Page contents

• Acknowledgment
• Syntax Rules
  • Bullets
• CSS classes
  • Constant class
  • Variable classes
• Examples
  • Basic
  • Menu
    • autotoggle example
    • nodeactions example
    • Pop-up example
    • Pop-up menu opacity example
• Plugin Settings
• Plugin Installation Instructions
• Known issues
• Planned Enhancements
• Plugin Info

Renders a bullet list or numbered list as a collapsible/expandable tree of nodes.

Acknowledgment

This plugin leverages the dTree JavaScript tree menu by Geir Landrö as well as code borrowed from TWiki:Plugins.RenderListPlugin.

Syntax Rules

Place the tag %TREEBROWSER{ parameters }% immediately before a bulleted or numbered list. The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch. The list will be rendered in a tree-like fashion (similar to the explorer folder list). Whenever a new indentation level is started, the subsequent nodes at this or a lower indentation level are shown as descendents of the preceding node. The following parameters can be used to configure the appearance of the tree:

Parameter	Description	Default
nodeactions	Defines node functionality in a comma separated list of HTML event and dTree function. Typically used for menu style tree along with noindent. Format: <event> <function>[,...] event is an HTML event e.g. onclick, ondblclick, onmouseover, onmouseout... function is one of the three dTree functions: open, close, toggle	none
openAll	If on, the tree is shown fully expanded.	off
closesamelevel	If true only one node within a parent can be expanded at the same time. openAll() and closeAll() functions do not work when this is enabled.	false
shared	Must be a string. If present, the state of the tree is shared across all trees using this string. For example, if the tree is used in the WebLeftBar, the state will hold at all topics with this WebLeftBar. It's basically the name of the JavaScript object representing your tree.	none
openTo	Must be an integer. If present, the tree is expanded to the given node, as numbered from the root.	0
style	Name of the CSS file to include without the .css extension. The CSS file must be attached to this topic.	dtree
closepopupdelay	Pop-up mode only. Delay in millisecond before all popup close once the mouse cursor has left the menu structure.	1000
noroot	Prevents rendering of the title line. Useful if you don't want to show any title.	false
firstpopupoffset	Provides x and y offset for first level pop-up menus. Introduce as a workaround for PatternSkin issues.	0,0
popupoffset	Provides x and y offset from parent node for pop-up menus. Allows for fine tunning of pop-up position.	0,0
title	Required. This text serves as the root of the tree	none
"name" or theme="name"	Select a rendering theme	none
useplusminus	Set to false if you don't want to show '-' and '+' signs. One can use something like onclick='javascript: tree.o($index);' in the tree item to trigger opening/closing of a node.	true
uselines	Set to false if you don't want to show lines linking nodes and leafs in the tree	true
popup	Set to on to enable pop-up menu mode. Typically used with closesamelevel. See pop-up menu example.	off
autotoggle	Set to on will enable node open/close when clicking the node item. Typically used for menu style tree along with noindent.	off
nocss	Set to true to prevent inclusion of dtree.css.	false
noindent	Set to true to show children at the level of their parent. It suppresses children indentation. Enabling noindent will disable uselines and useplusminus.	false
warn	Text to be displayed if no tree was found.	none
useopacity	Used to generate extra dtreeTransluscentBackground div. Enables popup with translucent background and opaque text.	off

Rendering themes can be defined by <name>_THEME Plugin settings

• Each theme is defined by a comma separated list containing the render type and parameters required by that render type
• There are different render types; currently this Plugin supports tree and icon render types
• Format of the tree render type:
  • Set < name >_THEME = tree
• Format of the icon render type:
  • Set < name >_THEME = icon, [< root icon image >], [< icon image >], [< folder icon image >], [< open folder icon image >]
  • The root icon image is shown at the root of the tree, the icon image is shown at every leaf node, the folder icon image is shown at every collapsed internal node, and the open folder icon image is shown at every expanded internal node. The icon images point to files attached to TWiki topics and are referenced in the standard manner. If no path is given, the images are taken from TWikiDocGraphics.
  • If an icon image is omitted, the following defaults are chosen: , , ,

If JavaScript is not enabled, the list is rendered as usual, and the %TREEBROWSER% tag is omitted.

Bullets

• Use regular * bullets
• Start with level one
  • Increase indentation only one level at a time
    • Like this
• Decreasing indentation many levels at a time is OK
• Keep labels short as text does not wrap.
• You can specify an icon for a bullet of render type tree or icon:
  • Use any of the TWikiDocGraphics icons:
    • icon:name Followed by normal bullet text
  • Use any TreeBrowserPlugin icon:
    • icon:name.gif Followed by normal bullet text
    • Available icons: icon:globe.gif, icon:home.gif, icon:virtualhome.gif, icon:group.gif, icon:persons.gif, virtualpersons.gif, icon:person.gif, icon:virtualperson.gif, icon:email.gif, icon:trend.gif, icon:folder.gif, icon:file.gif, icon:doc.gif, icon:image.gif, icon:pdf.gif, icon:ppt.gif, icon:sound.gif, icon:xls.gif, icon:zip.gif, icon:see.gif
  • Attach the icon to the topic and refer to it, such as:
    • icon:%ATTACHURL%/myicon.gif Followed by normal bullet text
  • Refer to any icon at the beginning of the bullet using a full path or URL:
    • icon:https://wiki.planta.de/pub/TWiki/TWikiDocGraphics/xls.gif Followed by normal bullet text

CSS classes

A number of classes are used to facilitate look and feel customizations through CSS.

Constant class

This class won't change from one tree to the other:

• treeBrowserPlugin: given to the div element encapsulating the whole tree and javascript.

Variable classes

Those classes are prefixed with the style parameter. For clarity of the documentation we used the default dtree prefix. Variable classes allow for multiple tree style support on one page.

• dtree: given to the div element encapsulating the whole tree. Since v0.1.
• dtreeRoot: given to the div element encapsulating the root or title of the tree. Introduced in v1.1.
• dtreeLeaf: given to the div element encapsulating a tree item without children. Introduced in v0.9.
• dtreeNodeOpened: given to the div element encapsulating a tree item that is showing children. Introduced in v0.9.
• dtreeNodeClosed: given to the div element encapsulating a tree item that is hiding children. Introduced in v0.9.
• dtreeChildren: given to the div element encapsulating the children of a tree item. Changed in v0.9. Formerly clip.
• dtreeLevel0: given to the div element encapsulating the children of the tree root item. Introduced in v0.9.
• dtreeLevel1: given to the div element encapsulating the children of level 0 items. Introduced in v0.9.
• dtreeLevel2: given to the div element encapsulating the children of level 1 items. Introduced in v0.9.
• dtreeLeveln: given to the div element encapsulating the children of level n-1 items. Introduced in v0.9.
• dtreeTransluscentBackground: given to the div element used for popup translucent background. Introduced in v1.5.
• dtreeFakeItem: given to the div element simulating nodes and leaf in dtreeTransluscentBackground. It guarantees same size for the translucent background and actual dtreeChildren div. Typically you should give dtreeFakeItem the same margin and padding properties as for dtreeLeaf, dtreeNodeOpened and dtreeNodeclosed. Introduced in v1.5.

Examples

Basic

%TREEBROWSER{"file" title="[[%HOMETOPIC%][%INCLUDINGWEB% Web Home]]" shared="left"}%
   * [[WebChanges][Changes]] 
   * [[WebIndex][Index]]
   * [[WebSearch][Search]]
   * this is a very very very long text
   * Folder
      * Leaf1
      * Subfolder
         * Leaf3
      * Leaf2
   * *Webs*
%WEBLIST{"      * [[$name.%HOMETOPIC%][$name]]" }%

generates

If installed		Simulated
open all | close all

This tree could be used in the WebLeftBar, for example. Clicking on the plus icon next to Webs will expand the subtree below that node.

To add "collapse/expand all nodes" functionalities do something like:

<a href="javascript: tree.openAll();">open all</a> | <a href="javascript: tree.closeAll();">close all</a>
%TREEBROWSER{"file" title="[[%HOMETOPIC%][%INCLUDINGWEB% Web Home]]" shared="tree"}%
...

Menu

autotoggle example

Code

%TREEBROWSER{"thread" noroot="on" shared="menudemo" noindent="on" autotoggle="on" style="dmenu"}%
   * Vegetables
      * Carot
      * Leek
      * Tomato
      * Potato 
   * Fruits
      * Banana 
      * Grape fruit       
         * Pink
         * Yellow 
      * Peach

If installed		Simulated

nodeactions example

Code

%TREEBROWSER{"thread" noroot="on" shared="memenudemo" noindent="on" style="dmenu" nodeactions="onmouseover open, onclick close"}%
   * Vegetables
      * Carot
      * Leek
      * Tomato
      * Potato 
   * Fruits
      * Banana
      * Grape fruit       
         * Pink
         * Yellow 
      * Peach

Pop-up example

Code

%TREEBROWSER{"thread" noroot="on" shared="memenudemo" noindent="on" style="dmenu" nodeactions="onmouseover open, onclick close", closesamelevel="on" popup="on" popupoffset="-10,-4" }%
   * Vegetables
      * Carot
      * Leek
      * Tomato
      * Potato 
   * Fruits
      * Banana
      * Grape fruit       
         * Pink
         * Yellow 
      * Peach

Simulated

Pop-up menu opacity example

Code

%TREEBROWSER{"thread" noroot="on" shared="opacitynotabledemo" noindent="on" style="smenu" nodeactions="onmouseover open, onclick close" popup="on" closesamelevel="on" closepopupdelay="100" firstpopupoffset="-60,0" popupoffset="-20,0" useopacity="on"}%
   * <a>Vegetables</a>
      * <a>Carot</a>
      * <a>Leek</a>
      * <a>Tomato</a>
      * <a>Potato</a>
   * <a>Fruits</a>
      * <a>Banana</a>
         * <a>Green</a>
         * <a>Yellow</a> 
      * <a>Grape fruit</a>       
         * <a>Pink</a>
         * <a>Yellow</a> 
      * <a>Peach</a>

Simulated

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %TREEBROWSERPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Renders a list as a collapsable/expandable tree.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Themes are named <SOMETHING>_THEME and contain a comma delimited list of render type with parameters:
  • Set THREAD_THEME = tree
  • Set HOME_THEME = icon,
  • Set ORG_THEME = icon, , , ,
  • Set GROUP_THEME = icon, tip.gif, , ,
  • Set EMAIL_THEME = icon,
  • Set TREND_THEME = icon,
  • Set FILE_THEME = icon,
  • Set DIR_THEME = icon, ,
  • Set FORUM_THEME = icon, group.gif, index.gif, indexlist.gif, indexlist.gif

Plugin Installation Instructions

You do not need to install anything on the browser to use this plugin. These instructions are for the administrator who installs the plugin on the TWiki server.

Known issues

• PatternSkin prevents javascript to determine menu position in topic content. Use firstpopupoffset="-163,0" as a workaround.
• NatSkin CSS natMainContent overflow:hidden causes z-index bug in FireFox. Workaround by removing or overriding overflow:hidden for natMainContent.
• dtreeTranslucentBackground only works for pop-up and not level 0. Sizing issue...
• Pop-up sub-menu won't work on IE for dmenu style. Workaround by using smenu.

Planned Enhancements

See TWiki:Plugins.TreeBrowserPluginDev.

Plugin Info

Plugin Author:	TWiki:Main.ThomasWeigert & TWiki:Main.StephaneLenclud
Copyright:	© 2000-2003 TWiki:Main.AndreaSterbini, © 2001-2004 TWiki:Main.PeterThoeny, © 2004 TWiki:Main.ThomasWeigert, © 2006-2007 TWiki:Main.StephaneLenclud, © 2000-2014 TWiki:TWiki.TWikiContributor
Sponsor:	Wave Systems Corp. for Item7404
License:	GPL (GNU General Public License)
Plugin Version:	2014-09-29

TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005, 5.8.7
License:	GPL (GNU General Public License)
Benchmarks:	GoodStyle n%, FormattedSearch n%, TreeBrowserPlugin n%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/TreeBrowserPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TreeBrowserPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/TreeBrowserPluginAppraisal

Related Topics: TWiki:Plugins.RenderListPlugin, TWiki:Plugins.TreePlugin