Skip to content

Commit

Permalink
Item4192: Add VarTREEBROWSER topic
Browse files Browse the repository at this point in the history
  • Loading branch information
gac410 committed Sep 1, 2015
1 parent ae96665 commit bb28273
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 67 deletions.
23 changes: 1 addition & 22 deletions data/System/TreeBrowserPlugin.txt
Expand Up @@ -11,28 +11,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 %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 |
| =openAll= | If =on=, the tree is shown fully expanded. | =off= |
| =openTo= | Must be an integer. If present, the tree is expanded to the given node, as numbered from the root. | =0= |
| =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 |
| =uselines= | Set to =false= if you don't want to show lines linking nodes and leafs in the tree | =true= |
| =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= |
| =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= |
| =nocss= | Set to =true= to prevent inclusion of =dtree.css=. | =false= |
| =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= |
| =noroot= | Prevents rendering of the title line. Useful if you don't want to show any title. | =false= |
| =warn= | Text to be displayed if no tree was found. | none |
| =style= | Name of the CSS file to include without the =.css= extension. The CSS file must be attached to this topic. | =dtree= |
| =autotoggle= | Set to =on= will enable node open/close when clicking the node item. Typically used for menu style tree along with =noindent=. | =off= |
| =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: <verbatim><event> <function>[,...]</verbatim> =event= is an HTML event e.g. =onclick=, =ondblclick=, =onmouseover=, =onmouseout=... %BR% =function= is one of the three dTree functions: =open=, =close=, =toggle= | none |
| =popup= | Set to =on= to enable pop-up menu mode. Typically used with =closesamelevel=. See [[%TOPIC%#Pop_up_example][pop-up menu example]]. | =off= |
| =closepopupdelay= | Pop-up mode only. Delay in millisecond before all popup close once the mouse cursor has left the menu structure. | =1000= |
| =popupoffset= | Provides x and y offset from parent node for pop-up menus. Allows for fine tunning of pop-up position. | =0,0= |
| =firstpopupoffset= | Provides x and y offset for first level pop-up menus. Introduce as a workaround for PatternSkin issues. | =0,0= |
| =useopacity= | Used to generate extra =dtreeTransluscentBackground= =div=. Enables popup with translucent background and opaque text. | =off= |
%INCLUDE{"VarTREEBROWSER" section="treebrowser_attributes"}%

Rendering themes can be defined by =&lt;name&gt;_THEME= Plugin settings
* Each theme is defined by a comma separated list containing the render type and parameters required by that render type
Expand Down
33 changes: 33 additions & 0 deletions data/System/VarTREEBROWSER.txt
@@ -0,0 +1,33 @@
%META:TOPICINFO{author="ProjectContributor" date="1434650530" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ =%<nop>TREEVIEW{}%= displays topic children in a hierarchical tree <br /> =%<nop>TREE{}%= synonym of =%<nop>TREEVIEW{}%=
%STARTSECTION{"treebrowser_attributes"}%
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:
---++ Parameters
* The following standard attributes are recognized
%TABLE{sort="off"}%
| *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 |
| =openAll= | If =on=, the tree is shown fully expanded. | =off= |
| =openTo= | Must be an integer. If present, the tree is expanded to the given node, as numbered from the root. | =0= |
| =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 |
| =uselines= | Set to =false= if you don't want to show lines linking nodes and leafs in the tree | =true= |
| =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= |
| =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= |
| =nocss= | Set to =true= to prevent inclusion of =dtree.css=. | =false= |
| =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= |
| =noroot= | Prevents rendering of the title line. Useful if you don't want to show any title. | =false= |
| =warn= | Text to be displayed if no tree was found. | none |
| =style= | Name of the CSS file to include without the =.css= extension. The CSS file must be attached to this topic. | =dtree= |
| =autotoggle= | Set to =on= will enable node open/close when clicking the node item. Typically used for menu style tree along with =noindent=. | =off= |
| =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: <verbatim><event> <function>[,...]</verbatim> =event= is an HTML event e.g. =onclick=, =ondblclick=, =onmouseover=, =onmouseout=... %BR% =function= is one of the three dTree functions: =open=, =close=, =toggle= | none |
| =popup= | Set to =on= to enable pop-up menu mode. Typically used with =closesamelevel=. See [[%TOPIC%#Pop_up_example][pop-up menu example]]. | =off= |
| =closepopupdelay= | Pop-up mode only. Delay in millisecond before all popup close once the mouse cursor has left the menu structure. | =1000= |
| =popupoffset= | Provides x and y offset from parent node for pop-up menus. Allows for fine tunning of pop-up position. | =0,0= |
| =firstpopupoffset= | Provides x and y offset for first level pop-up menus. Introduce as a workaround for PatternSkin issues. | =0,0= |
| =useopacity= | Used to generate extra =dtreeTransluscentBackground= =div=. Enables popup with translucent background and opaque text. | =off= |
%ENDSECTION{"treebrowser_attributes"}%

---++ Related
[[TreeBrowserPlugin]]
91 changes: 46 additions & 45 deletions lib/Foswiki/Plugins/TreeBrowserPlugin/MANIFEST
@@ -1,45 +1,46 @@
data/System/TreeBrowserPlugin.txt NEW
lib/Foswiki/Plugins/TreeBrowserPlugin.pm NEW
pub/System/TreeBrowserPlugin/base.gif NEW
pub/System/TreeBrowserPlugin/cd.gif NEW
pub/System/TreeBrowserPlugin/doc.gif NEW
pub/System/TreeBrowserPlugin/dtree.css NEW
pub/System/TreeBrowserPlugin/dmenu.css NEW
pub/System/TreeBrowserPlugin/smenu.css NEW
pub/System/TreeBrowserPlugin/dtree.js NEW
pub/System/TreeBrowserPlugin/email.gif NEW
pub/System/TreeBrowserPlugin/empty.gif NEW
pub/System/TreeBrowserPlugin/file.gif NEW
pub/System/TreeBrowserPlugin/folder.gif NEW
pub/System/TreeBrowserPlugin/folderopen.gif NEW
pub/System/TreeBrowserPlugin/globe.gif NEW
pub/System/TreeBrowserPlugin/group.gif NEW
pub/System/TreeBrowserPlugin/home.gif NEW
pub/System/TreeBrowserPlugin/image.gif NEW
pub/System/TreeBrowserPlugin/imgfolder.gif NEW
pub/System/TreeBrowserPlugin/join.gif NEW
pub/System/TreeBrowserPlugin/joinbottom.gif NEW
pub/System/TreeBrowserPlugin/line.gif NEW
pub/System/TreeBrowserPlugin/minus.gif NEW
pub/System/TreeBrowserPlugin/minusbottom.gif NEW
pub/System/TreeBrowserPlugin/musicfolder.gif NEW
pub/System/TreeBrowserPlugin/nolines_minus.gif NEW
pub/System/TreeBrowserPlugin/nolines_plus.gif NEW
pub/System/TreeBrowserPlugin/page.gif NEW
pub/System/TreeBrowserPlugin/pdf.gif NEW
pub/System/TreeBrowserPlugin/person.gif NEW
pub/System/TreeBrowserPlugin/persons.gif NEW
pub/System/TreeBrowserPlugin/plus.gif NEW
pub/System/TreeBrowserPlugin/plusbottom.gif NEW
pub/System/TreeBrowserPlugin/ppt.gif NEW
pub/System/TreeBrowserPlugin/question.gif NEW
pub/System/TreeBrowserPlugin/see.gif NEW
pub/System/TreeBrowserPlugin/sound.gif NEW
pub/System/TreeBrowserPlugin/trash.gif NEW
pub/System/TreeBrowserPlugin/tree.jpg NEW
pub/System/TreeBrowserPlugin/trend.gif NEW
pub/System/TreeBrowserPlugin/virtualhome.gif NEW
pub/System/TreeBrowserPlugin/virtualperson.gif NEW
pub/System/TreeBrowserPlugin/virtualpersons.gif NEW
pub/System/TreeBrowserPlugin/xls.gif NEW
pub/System/TreeBrowserPlugin/zip.gif NEW
data/System/TreeBrowserPlugin.txt 0664
data/System/VarTREEBROWSER.txt 0664
lib/Foswiki/Plugins/TreeBrowserPlugin.pm 0664
pub/System/TreeBrowserPlugin/base.gif 0664
pub/System/TreeBrowserPlugin/cd.gif 0664
pub/System/TreeBrowserPlugin/dmenu.css 0664
pub/System/TreeBrowserPlugin/doc.gif 0664
pub/System/TreeBrowserPlugin/dtree.css 0664
pub/System/TreeBrowserPlugin/dtree.js 0664
pub/System/TreeBrowserPlugin/email.gif 0664
pub/System/TreeBrowserPlugin/empty.gif 0664
pub/System/TreeBrowserPlugin/file.gif 0664
pub/System/TreeBrowserPlugin/folder.gif 0664
pub/System/TreeBrowserPlugin/folderopen.gif 0664
pub/System/TreeBrowserPlugin/globe.gif 0664
pub/System/TreeBrowserPlugin/group.gif 0664
pub/System/TreeBrowserPlugin/home.gif 0664
pub/System/TreeBrowserPlugin/image.gif 0664
pub/System/TreeBrowserPlugin/imgfolder.gif 0664
pub/System/TreeBrowserPlugin/join.gif 0664
pub/System/TreeBrowserPlugin/joinbottom.gif 0664
pub/System/TreeBrowserPlugin/line.gif 0664
pub/System/TreeBrowserPlugin/minus.gif 0664
pub/System/TreeBrowserPlugin/minusbottom.gif 0664
pub/System/TreeBrowserPlugin/musicfolder.gif 0664
pub/System/TreeBrowserPlugin/nolines_minus.gif 0664
pub/System/TreeBrowserPlugin/nolines_plus.gif 0664
pub/System/TreeBrowserPlugin/page.gif 0664
pub/System/TreeBrowserPlugin/pdf.gif 0664
pub/System/TreeBrowserPlugin/person.gif 0664
pub/System/TreeBrowserPlugin/persons.gif 0664
pub/System/TreeBrowserPlugin/plus.gif 0664
pub/System/TreeBrowserPlugin/plusbottom.gif 0664
pub/System/TreeBrowserPlugin/ppt.gif 0664
pub/System/TreeBrowserPlugin/question.gif 0664
pub/System/TreeBrowserPlugin/see.gif 0664
pub/System/TreeBrowserPlugin/smenu.css 0664
pub/System/TreeBrowserPlugin/sound.gif 0664
pub/System/TreeBrowserPlugin/trash.gif 0664
pub/System/TreeBrowserPlugin/tree.jpg 0664
pub/System/TreeBrowserPlugin/trend.gif 0664
pub/System/TreeBrowserPlugin/virtualhome.gif 0664
pub/System/TreeBrowserPlugin/virtualperson.gif 0664
pub/System/TreeBrowserPlugin/virtualpersons.gif 0664
pub/System/TreeBrowserPlugin/xls.gif 0664
pub/System/TreeBrowserPlugin/zip.gif 0664

0 comments on commit bb28273

Please sign in to comment.