Skip to content

Commit

Permalink
Item9894: partial rebranding from 'TWiki' in TreeBrowserPlugin
Browse files Browse the repository at this point in the history 
git-svn-id: http://svn.foswiki.org/trunk/TreeBrowserPlugin@9764 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
DanDascalescu authored and DanDascalescu committed Oct 27, 2010
1 parent 7965ccf commit 0525638
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 51 deletions.
101 changes: 51 additions & 50 deletions data/System/TreeBrowserPlugin.txt
View file
Expand Up @@ -12,7 +12,7 @@ This plugin leverages the [[http://www.destroydrop.com/javascripts/tree/][dTree]

---++ Syntax Rules

Place the tag =%<nop>TREEBROWSER{= _parameters_ =}%= immediately before a bulleted or numbered list. The lists can be handcrafted, generated by another Plugin, a =%<nop>TOC%=, or the result of a %TWIKIWEB%.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:
Place the tag =%<nop>TREEBROWSER{= _parameters_ =}%= immediately before a bulleted or numbered list. The lists can be handcrafted, generated by another Plugin, a =%<nop>TOC%=, or the result of a %SYSTEMWEB%.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* |
| ="name"= or%BR% =theme="name"= | Select a rendering theme | none |
| =title= | Required. This text serves as the root of the tree | none |
Expand Down Expand Up @@ -42,7 +42,7 @@ Rendering themes can be defined by =&lt;name&gt;_THEME= Plugin settings
* =Set &lt; _name_ &gt;_THEME = tree=
* Format of the *icon* render type:
* =Set &lt; _name_ &gt;_THEME = icon, [&lt; _root icon image_ &gt;], [&lt; _icon image_ &gt;], [&lt; _folder icon image_ &gt;], [&lt; _open folder icon image_ &gt;]=
* 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 TWiki.TWikiDocGraphics.
* 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 wiki topics and are referenced in the standard manner. If no path is given, the images are taken from TWiki.TWikiDocGraphics.
* If an icon image is omitted, the following defaults are chosen: %ATTACHURL%/empty.gif, %ATTACHURL%/page.gif, %ATTACHURL%/folder.gif, %ATTACHURL%/folderopen.gif

If !JavaScript is not enabled, the list is rendered as usual, and the =%<nop>TREEBROWSER% tag is omitted.
Expand Down Expand Up @@ -159,7 +159,7 @@ document.write(left);

</td></tr></table>

This tree could be used in the TWiki.WebLeftBar, for example. Clicking on the plus icon next to =Webs= will expand the subtree below that node.
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:
<verbatim><a href="javascript: tree.openAll();">open all</a> | <a href="javascript: tree.closeAll();">close all</a>
Expand Down Expand Up @@ -398,8 +398,8 @@ document.write(opacitydemo);
Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>TREEBROWSERPLUGIN_SHORTDESCRIPTION%==

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

* Debug plugin: (See output in =data/debug.txt=)
* Set DEBUG = 0
Expand All @@ -418,52 +418,52 @@ a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>T
---++ Plugin Installation Instructions

0 Download the zip file.
0 Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
0 Unzip ==%TOPIC%.zip== in your Foswiki installation directory. Content:
| *File:* | *Description:* |
| ==data/TWiki/%TOPIC%.txt== | Plugin topic |
| ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
| ==pub/TWiki/%TOPIC%/dtree.css== | part of dtree |
| ==pub/TWiki/%TOPIC%/dmenu.css== | Menu CSS |
| ==pub/TWiki/%TOPIC%/smenu.css== | Nicer menu CSS |
| ==pub/TWiki/%TOPIC%/dtree.js== | part of dtree |
| ==pub/TWiki/%TOPIC%/base.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/cd.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/empty.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/folder.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/folderopen.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/globe.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/imgfolder.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/join.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/joinbottom.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/line.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/minus.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/minusbottom.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/musicfolder.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/nolines_minus.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/nolines_plus.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/page.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/plus.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/plusbottom.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/question.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/trash.gif== | part of dtree |
| ==pub/TWiki/%TOPIC%/doc.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/email.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/file.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/group.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/home.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/image.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/pdf.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/person.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/persons.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/ppt.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/see.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/sound.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/trend.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/virtualhome.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/virtualperson.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/virtualpersons.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/xls.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/TWiki/%TOPIC%/zip.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==data/%SYSTEMWEB%/%TOPIC%.txt== | Plugin topic |
| ==lib/Foswiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
| ==pub/%SYSTEMWEB%/%TOPIC%/dtree.css== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/dmenu.css== | Menu CSS |
| ==pub/%SYSTEMWEB%/%TOPIC%/smenu.css== | Nicer menu CSS |
| ==pub/%SYSTEMWEB%/%TOPIC%/dtree.js== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/base.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/cd.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/empty.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/folder.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/folderopen.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/globe.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/imgfolder.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/join.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/joinbottom.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/line.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/minus.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/minusbottom.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/musicfolder.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/nolines_minus.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/nolines_plus.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/page.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/plus.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/plusbottom.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/question.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/trash.gif== | part of dtree |
| ==pub/%SYSTEMWEB%/%TOPIC%/doc.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/email.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/file.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/group.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/home.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/image.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/pdf.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/person.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/persons.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/ppt.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/see.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/sound.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/trend.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/virtualhome.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/virtualperson.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/virtualpersons.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/xls.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |
| ==pub/%SYSTEMWEB%/%TOPIC%/zip.gif== | icons from [[TWiki:Plugins.RenderListPlugin][RenderListPlugin]] |

---++ Known issues

Expand All @@ -482,6 +482,7 @@ See TWiki:Plugins.TreeBrowserPluginDev.
| Version: | %$VERSION% |
| Release: | %$RELEASE% |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
| 27 Oct 2010: | (v2.1) - Minor rebranding from 'TWiki'. By [[Foswiki:Main.DanDascalescu][Dan Dascalescu]]. |
| 10 Nov 2009: | (v2.0) - Fixed version numbering for configure. By [[Foswiki:Main.IngoKappler][Ingo Kappler]]. |
| 20 Feb 2009: | (v1.9) - Foswiki port. By [[Foswiki:Main.StephaneLenclud][St�phane Lenclud]]. |
| 29 Mar 2007: | (v1.8) - Improved =smenu= CSS and fixing warning. By [[TWiki:Main.StephaneLenclud][St�phane Lenclud]]. |
Expand Down
2 changes: 1 addition & 1 deletion lib/Foswiki/Plugins/TreeBrowserPlugin.pm
View file
Expand Up @@ -40,7 +40,7 @@ use vars qw(
);

$VERSION = '$Rev$';
$RELEASE = 'v2.0';
$RELEASE = '2.1';
$pluginName = 'TreeBrowserPlugin';

# =========================
Expand Down

0 comments on commit 0525638

Please sign in to comment.