Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Item13634: Doc updates, add VarTREEVIEW topic
- Loading branch information
Showing
3 changed files
with
43 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| %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{"treeview_attributes"}% | ||
| ---++ Parameters | ||
| * The following standard attributes are recognized | ||
| %TABLE{sort="off"}% | ||
| | *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 <br /> =ullist= is a <ul>-list, see [[TreePluginSamples#UlList][sample UL lists]] <br /> =ollist= is a <ol>-list, see [[TreePluginSamples#OlList][sample OL lists]] <br /> =outline= is an outline list, see [[TreePluginSamples#SampleOutlines][sample Outlines]] <br /> =hlist= is a <h _n_ >-list of section heads, see [[TreePluginSamples#SampleHList][sample Headlines]] <br /> =coloroutline:colorlist= is an outline formatting with level values turned into colors, see [[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 [[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:<img src=\"$image\" border=\"0\">"=. | =outline= | | ||
| | =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= | | ||
| | =header= | Output the value within a =<div>= of class =treePluginHeader=. Suppressed if the tree is empty. | none | | ||
| | =footer= | Output the value within a =<div>= of class =treePluginFooter=. Suppressed if the tree is empty. | none | | ||
| | =zero= | Output the value within a =<div>= 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 %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 [[Foswiki:Extensions.TreeBrowserPlugin][TreeBrowserPlugin]] <br /> =$outnum= - outline number for the topic (eg, 1.3.4.2) <br /> =$url= - the current topic's URL %RED%Not supported. Use =%<nop>SCRIPTURL{view}%/$web/$topic= instead. %ENDCOLOR% <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 Foswiki bullet list syntax thus enabling usage of !TreePlugin [[#Combination_with_TreeBrowserPlug][in combination with TreeBrowserPlugin]]. | none | | ||
| | =nodiv= | Suppress the =<div>= around the tree. Set to =2= to suppress =div= around =header=, =footer= and =zero=. Allows for trees concatenation. | none | | ||
| | =separator= | Character string used to separate items in the tree | =\n= | | ||
| | =nocache= | Set to 1 to disable caching mechanism for that specific tree. Really a developer setting. | 0 | | ||
| %ENDSECTION{"treeview_attributes"}% | ||
|
|
||
| ---++ Examples | ||
| See the following page for sample usage and output: | ||
| * [[TreePluginSamples]] | ||
| * [[TreePluginHeadingOutlineSample]] | ||
| * [[TreePluginBookviewOutlineSample]] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters