FlexWebListExamples

These are some simple examples to show how to use the basic features of the FlexWebListPlugin. Please create some subwebs in the Sandbox web for a better illustration of the examples below. Some of the examples are displayed using the "glue" syntax of the TWiki:Plugins.GluePlugin to ease reading multiline TML expressions and arguments.

No params

%FLEXWEBLIST%

Applications Applications/BlogUp Applications/ClassificationApp Applications/DashboardApp Applications/DiscussionApp Applications/EmployeePortalApp Applications/MessageApp Applications/MovieApp Blog Main Sandbox TWiki

Influencing order

%FLEXWEBLIST{webs="%MAINWEB%,public,%TWIKIWEB%"}%

Main Applications Applications/BlogUp Applications/ClassificationApp Applications/DashboardApp Applications/DiscussionApp Applications/EmployeePortalApp Applications/MessageApp Applications/MovieApp Blog Sandbox TWiki

Controlling subwebs

No subwebs

%FLEXWEBLIST{subwebs="none"}%

Applications Blog Main Sandbox TWiki

Only subwebs

%FLEXWEBLIST{subwebs="only"}%

Applications/BlogUp Applications/ClassificationApp Applications/DashboardApp Applications/DiscussionApp Applications/EmployeePortalApp Applications/MessageApp Applications/MovieApp

Subwebs of "Sandbox"

%FLEXWEBLIST{subwebs="Sandbox"}%

Using include and exclude

Exclude TestCases and Trash webs

%FLEXWEBLIST{exclude="TestCases|Trash.*" subwebs="none"}%

Applications Blog Main Sandbox TWiki

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

• Applications
  • BlogUp
  • ClassificationApp
  • DashboardApp
  • DiscussionApp
  • EmployeePortalApp
  • MessageApp
  • MovieApp
• Blog
• Main
• Sandbox
• TWiki

Nested list using HTML

%~~ FLEXWEBLIST{
~~~   header="<ul>" 
~~~   format="<li>[[$web.%HOMETOPIC%][$name]]" 
~~~   separator="</li>"
~~~   footer="</li></ul>" 
~~~ }%

• Applications
  • BlogUp
  • ClassificationApp
  • DashboardApp
  • DiscussionApp
  • EmployeePortalApp
  • MessageApp
  • MovieApp
• Blog
• Main
• Sandbox
• TWiki

Nested calls to FLEXWEBLIST

%~~ FLEXWEBLIST{
~~~   exclude="TestCases|Trash.*" 
~~~   subwebs="none"
~~~   selection="Applications"
~~~   format="$indent   * [[$web.%HOMETOPIC%][$name]]$n"
~~~   markerformat="$percntFLEXWEBLIST{
~~~     webs=\"$web\"
~~~     format=\"$dollarindent   * [[$dollarweb.%HOMETOPIC%][$dollarname]]$dollarn\"
~~~   }$percnt"
~~~ }%

• Applications
• Blog
• Main
• Sandbox
• TWiki

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

• Applications (8) Applications (8)
  • BlogUp (0) BlogUp (0)
  • ClassificationApp (0) ClassificationApp (0)
  • DashboardApp (0) DashboardApp (0)
  • DiscussionApp (0) DiscussionApp (0)
  • EmployeePortalApp (0) EmployeePortalApp (0)
  • MessageApp (0) MessageApp (0)
  • MovieApp (0) MovieApp (0)
• Blog (0) Blog (0)
• Main (1) Main (1)
• Sandbox (0) Sandbox (0)
• TWiki (0) TWiki (0)

Twisty navigation

needs the TWiki:Plugins/TwistyPlugin and the TWiki:Plugins/IfDefinedPlugin

%~~ FLEXWEBLIST{
~~~   webs="%MAINWEB%,public,%TWIKIWEB%"
~~~   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>" 
~~~ }%

• Main  More... Close
• Applications  More... Close
  • BlogUp 
  • ClassificationApp 
  • DashboardApp 
  • DiscussionApp 
  • EmployeePortalApp 
  • MessageApp 
  • MovieApp 
• Blog 
• Sandbox 
• TWiki 

Sitemap

Mapping names

%~~ FLEXWEBLIST{
~~~    map="TestCases=Tests,%TWIKIWEB%=System,%MAINWEB%=Home"
~~~    format="$indent   * [[$web.%HOMETOPIC%][$name]]$n"
~~~ }%

• Applications
  • BlogUp
  • ClassificationApp
  • DashboardApp
  • DiscussionApp
  • EmployeePortalApp
  • MessageApp
  • MovieApp
• Blog
• Home
• Sandbox
• System

Marking a selection

Using marker

%~~ FLEXWEBLIST{
~~~   exclude="TestCases|Trash.*"
~~~   format="$indent   * <span class=\"$marker\"> $web </span>$n"
~~~   marker="twikiAlert"
~~~   selection="%BASEWEB%"
~~~ }%

• Applications
  • Applications/BlogUp
  • Applications/ClassificationApp
  • Applications/DashboardApp
  • Applications/DiscussionApp
  • Applications/EmployeePortalApp
  • Applications/MessageApp
  • Applications/MovieApp
• Blog
• Main
• Sandbox
• 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%"
~~~ }%

• Applications
  • BlogUp
  • ClassificationApp
  • DashboardApp
  • DiscussionApp
  • EmployeePortalApp
  • MessageApp
  • MovieApp
• Blog
• Main
• Sandbox
• TWiki