Flex Web-List Examples
These are some simple examples to show how to use the basic features of the
FlexWebListPlugin. Please create some sub-webs in the Sandbox web for a better illustration of the examples below.
No params
%FLEXWEBLIST%
CM CM/Public Main PP PP/Public Public
ShowCase Students Students/PostGraduates Students/UnderGraduates TWiki
Influencing order
%FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%"}%
Public CM CM/Public Main PP PP/Public
ShowCase Students Students/PostGraduates Students/UnderGraduates TWiki
Controlling subwebs
No subwebs
%FLEXWEBLIST{subwebs="none"}%
CM Main PP Public
ShowCase Students TWiki
Only subwebs
%FLEXWEBLIST{subwebs="only"}%
CM/Public PP/Public Students/PostGraduates Students/UnderGraduates
Subwebs of "Sandbox"
%FLEXWEBLIST{subwebs="Sandbox"}%
Using include and exclude
Exclude TestCases and Trash webs
%FLEXWEBLIST{exclude="TestCases|Trash.*" subwebs="none"}%
CM Main PP Public
ShowCase Students TWiki
Include Sandbox web and all of its subwebs
%FLEXWEBLIST{include="Sandbox(/\w+)?"}%
Creating lists
Simple nested list
%FLEXWEBLIST{format="$indent * [[$web.%HOMETOPIC%][$name]]$n"}%
Nested list using HTML
%FLEXWEBLIST{
header="<ul>"
format="<li>[[$web.%HOMETOPIC%][$name]]"
separator="</li>"
footer="</li></ul>"
}%
Nested calls to FLEXWEBLIST
%FLEXWEBLIST{
exclude="TestCases|Trash.*"
subwebs="none"
selection="Sandbox"
format="$indent * [[$web.%HOMETOPIC%][$name]]$n"
markerformat="$percntFLEXWEBLIST{ webs=\"$web\" format=\"$dollarindent * [[$dollarweb.%HOMETOPIC%][$dollarname]]$dollarn\" }$percnt"
}%
Twisty weblist
needs the
TWiki:Plugins/TwistyPlugin
%FLEXWEBLIST{
header="<ul>"
format="<li> $percntTWISTYBUTTON{ id=\"twisty_weblist_$web\" link=\"$name ($nrsubwebs)\" }$percnt"
separator="</li>"
subheader="$percntTWISTYTOGGLE{ id=\"twisty_weblist_$web\" mode=\"div\" }$percnt<ul>"
subfooter="</li></ul>$percntENDTWISTY$percnt"
footer="</li></ul>"
}%
Twisty navigation
needs the
TWiki:Plugins/TwistyPlugin
and the
TWiki:Plugins/IfDefinedPlugin
%FLEXWEBLIST{
webs="%USERSWEB%,public,%SYSTEMWEB%"
exclude="TestCases|Trash.*"
header="<ul>"
format="<li>[[$web.%HOMETOPIC%][$name]] $percntIFDEFINEDTHEN{\"$nrsubwebs \" as=\"0 \"}$percnt $percntELSEDEFINED$percnt $percntTWISTYBUTTON{ id=\"sitemap_$web\" buttonmode=\"span\" showimg=\"$percntICONURLPATH{\"toggleopenleft\"}$percnt\" hideimg=\"$percntICONURLPATH{\"toggleclose\"}$percnt\" }$percnt $percntFIDEFINED$percnt"
separator="</li>$n"
subheader="$percntTWISTYTOGGLE{id=\"sitemap_$web\"}$percnt<ul>"
subfooter="</li></ul>$percntENDTWISTY$percnt"
footer="</ul>"
}%
Sitemap
Mapping names
%FLEXWEBLIST{
map="TestCases=Tests,%SYSTEMWEB%=System,%USERSWEB%=Home"
format="$indent * [[$web.%HOMETOPIC%][$name]]$n"
}%
Marking a selection
Using marker
%FLEXWEBLIST{
exclude="TestCases|Trash.*"
format="$indent * <span class=\"$marker\"> $web </span>$n"
marker="twikiAlert"
selection="%BASEWEB%"
}%
- CM
- Main
- PP
- Public
- ShowCase
- Students
- Students/PostGraduates
- Students/UnderGraduates
- TWiki
Using markerformat
%FLEXWEBLIST{
exclude="TestCases|Trash.*"
format="$indent * [[$web.%HOMETOPIC%][$name]]$n"
markerformat="$indent * [[$web.%HOMETOPIC%][<span class=\"twikiAlert\">$name</span>]]$n"
selection="%BASEWEB%"
}%
Related Topics: FlexWebListNavi,
FlexWebListPlugin,
FlexWebListTree