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%
BAULT Clarin FiLT FinCLARIN KitWiki MOLTO Main Nealt NooJ Old Sandbox TWiki Terms

Influencing order

%FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%"}%
Main BAULT Clarin FiLT FinCLARIN KitWiki MOLTO Nealt NooJ Old Sandbox Terms TWiki

Controlling subwebs

No subwebs

%FLEXWEBLIST{subwebs="none"}%
BAULT Clarin FiLT FinCLARIN KitWiki MOLTO Main Nealt NooJ Old Sandbox TWiki Terms

Only subwebs

%FLEXWEBLIST{subwebs="only"}%

Subwebs of "Sandbox"

%FLEXWEBLIST{subwebs="Sandbox"}%

Using include and exclude

Exclude TestCases and Trash webs

%FLEXWEBLIST{exclude="TestCases|Trash.*" subwebs="none"}%
BAULT Clarin FiLT FinCLARIN KitWiki MOLTO Main Nealt NooJ Old Sandbox TWiki Terms

Include Sandbox web and all of its subwebs

%FLEXWEBLIST{include="Sandbox(/\w+)?"}%
Sandbox

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]]&nbsp; $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

Main Welcome to TWiki... Users, Groups
BAULT Research Community for Building and Use of Language Technology
Clarin Working pages of the CLARIN infrastucture project
FiLT This web is the site for the LT Documentation Centre in Finland
FinCLARIN FIN-CLARIN is the Finnish Language Resource Consortium, which is a part of European CLARIN
KitWiki An open area for open scientific collaboration projects
MOLTO Multilingual Online Translation: EU project FP7-ICT-247914
Nealt A wiki for the Northern European Association for Language Technology
NooJ Wiki pages for NooJ, a linguistic development environment
Old A place for holding old topics.
Sandbox Sandbox test area with all features enabled.
Terms Multilingual language technology terminology
TWiki TWiki documentation, welcome, registration and other starting points

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%"
}%

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

Topic revision: r2 - 2012-11-27 - TWikiAdminUser
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.FlexWebListExamples.