Changeset 772 for trunk/TreePlugin/data/TWiki/TreePlugin.txt

Timestamp:

11/18/08 08:44:09 (4 years ago)

Author:

KennethLavrsen

Message:

Item205: Cont. TWiki. to %SYSTEMWEB% conv.

File:

• trunk/TreePlugin/data/TWiki/TreePlugin.txt (modified) (4 diffs)

trunk/TreePlugin/data/TWiki/TreePlugin.txt

@@ -14 +14 @@
 | =topic= | Specify tree's root topic. If none the entire web topics' tree is generated | none |
 | =formatting= | Specify the formatting method <br /> =ullist= is a &lt;ul&gt;-list, see [[Plugins.TreePluginSamples#UlList][sample UL lists]] <br /> =ollist= is a &lt;ol&gt;-list, see [[Plugins.TreePluginSamples#OlList][sample OL lists]] <br /> =outline= is an outline list, see [[Plugins.TreePluginSamples#SampleOutlines][sample Outlines]] <br /> =hlist= is a &lt;h _n_ &gt;-list of section heads, see [[Plugins.TreePluginSamples#SampleHList][sample Headlines]] <br /> =coloroutline:colorlist= is an outline formatting with level values turned into colors, see [[Plugins.TreePluginSamples#SampleNestedTables][sample Nested tables]]. Example: =formatting="coloroutline:#ffeeff,#eeffee,#ffffee,#eeeeff,#ffeeee,#eeffff"= <br /> =imageoutline:mode= is a way to incorporate images into the outline format, specifically to display thread-like and folder views, see [[Plugins.TreePluginSamples#SampleImageTrees][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:&lt;img src=\"$image\" border=\"0\"&gt;"=. | =outline= |
-| =excludetopic= | Same meaning as TWiki.VarSEARCH =excludetopic=. Topics with excluded parent or processed like topic without parent. | none |
-| =includetopic= | Same meaning as TWiki.VarSEARCH =topic=. Can improve processing time. | none |
+| =excludetopic= | Same meaning as %SYSTEMWEB%.VarSEARCH =excludetopic=. Topics with excluded parent or processed like topic without parent. | none |
+| =includetopic= | Same meaning as %SYSTEMWEB%.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= |
@@ -22 +22 @@
 | =zero= | Output the value within a =&lt;div&gt;= of class =treePluginZero= if the tree is empty. | none |
 | =bookview= | List topics in BookView form. %RED%Not supported from v0.9. Instead use something like: %ENDCOLOR% <verbatim>%TREE{topic="GrandParent" formatting="outline" format="$outnum $topic <br /> $summary <hr />"}%</verbatim> | none |
-| =format= | Specify the format for each node ( =outline= & =coloroutline=). The following pseudo-variable are supported on top of the ones described in TWiki.FormattedSearch: <br /> =$spacetopic= - the topic with spaces <br /> =$level= - the tree depth of the topic (in whatever format) <br /> =$count= - the topic's child position <br /> =$index= - the index of the topic in the tree. Starts from one. Most useful when used in combination with [[TWiki:Plugins.TreeBrowserPlugin][TreeBrowserPlugin]] <br /> =$outnum= - outline number for the topic (eg, 1.3.4.2) <br /> =$url= - the current topic's URL <br /> =$author= - the topic's last author %RED%Not supported from v0.9. Use =%<nop>AUTHOR%= instead. %ENDCOLOR% <br /> =$modTime= - the topic's modification time. %RED%Not supported from v0.9. Use =$date= instead. %ENDCOLOR% | none |
+| =format= | Specify the format for each node ( =outline= & =coloroutline=). The following pseudo-variable are supported on top of the ones described in %SYSTEMWEB%.FormattedSearch: <br /> =$spacetopic= - the topic with spaces <br /> =$level= - the tree depth of the topic (in whatever format) <br /> =$count= - the topic's child position <br /> =$index= - the index of the topic in the tree. Starts from one. Most useful when used in combination with [[TWiki:Plugins.TreeBrowserPlugin][TreeBrowserPlugin]] <br /> =$outnum= - outline number for the topic (eg, 1.3.4.2) <br /> =$url= - the current topic's URL <br /> =$author= - the topic's last author %RED%Not supported from v0.9. Use =%<nop>AUTHOR%= instead. %ENDCOLOR% <br /> =$modTime= - the topic's modification time. %RED%Not supported from v0.9. Use =$date= instead. %ENDCOLOR% | none |
 | =formatbranch= | - specify the format for a group of children ( =outline= & =coloroutline=) <br /> =$parent= - the text of a node <br /> =$children= - the text of all the node's children (if any) | none |
 | =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 [[#Combination_with_TreeBrowserPlug][in combination with TreeBrowserPlugin]]. | none |
@@ -55 +55 @@
 ---++ Performance consideration
 
-For each =%<nop>TREE%= or =%<nop>TREEVIEW%= tag a TWiki.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 each =%<nop>TREE%= or =%<nop>TREEVIEW%= tag a %SYSTEMWEB%.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_.
@@ -93 +93 @@
 | 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 TWiki.FormattedSearch pseudo-variables. Code cleaning in =TreePlugin.pm=. Removed some dead code. Improved documentation. By TWiki:Main.StephaneLenclud |
+| 6 Apr 2007 | 0.9 - Support for %SYSTEMWEB%.FormattedSearch pseudo-variables. Code cleaning in =TreePlugin.pm=. Removed some dead code. Improved documentation. By TWiki:Main.StephaneLenclud |
 | 4 Apr 2007 | 0.8 - Adding =excludetopic= parameter. Adding =%<nop>TREE%= as synonym tag. Code cleaning in =TreePlugin.pm=. 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. |