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%

Influencing order

%FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%"}%

Controlling subwebs

No subwebs

%FLEXWEBLIST{subwebs="none"}%

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

Include Sandbox web and all of its subwebs

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

Creating lists

Simple nested list

%FLEXWEBLIST{format="$indent   * [[$web.%HOMETOPIC%][$name]]$n"}%

• CM
  • Public
• Main
• PP
  • Public
• Public
• ShowCase
• Students
  • PostGraduates
  • UnderGraduates
• TWiki

Nested list using HTML

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

• CM
  • Public
• Main
• PP
  • Public
• Public
• ShowCase
• Students
  • PostGraduates
  • UnderGraduates
• TWiki

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

• CM
• Main
• PP
• Public
• ShowCase
• Students
• 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>" 
}%

• CM (7) CM (7)

  <--/twistyPlugin twikiMakeVisibleInline-->

  • Public (0) Public (0)

    <--/twistyPlugin twikiMakeVisibleInline-->

  <--/twistyPlugin-->

• Main (0) Main (0)

  <--/twistyPlugin twikiMakeVisibleInline-->

• PP (11) PP (11)

  <--/twistyPlugin twikiMakeVisibleInline-->

  • Public (0) Public (0)

    <--/twistyPlugin twikiMakeVisibleInline-->

  <--/twistyPlugin-->

• Public (0) Public (0)

  <--/twistyPlugin twikiMakeVisibleInline-->

• ShowCase (0) ShowCase (0)

  <--/twistyPlugin twikiMakeVisibleInline-->

• Students (2) Students (2)

  <--/twistyPlugin twikiMakeVisibleInline-->

  • PostGraduates (0) PostGraduates (0)

    <--/twistyPlugin twikiMakeVisibleInline-->

  • UnderGraduates (0) UnderGraduates (0)

    <--/twistyPlugin twikiMakeVisibleInline-->

  <--/twistyPlugin-->

• TWiki (0) TWiki (0)

  <--/twistyPlugin twikiMakeVisibleInline-->

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

• Public 
• CM  More... Close

  <--/twistyPlugin twikiMakeVisibleInline-->

  • Public 

  <--/twistyPlugin-->

• Main 
• PP  More... Close

  <--/twistyPlugin twikiMakeVisibleInline-->

  • Public 

  <--/twistyPlugin-->

• ShowCase 
• Students  More... Close

  <--/twistyPlugin twikiMakeVisibleInline-->

  • PostGraduates 
  • UnderGraduates 

  <--/twistyPlugin-->

• TWiki 

Sitemap

Mapping names

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

• CM
  • Home
• Main
• PP
  • Home
• Home
• ShowCase
• Students
  • PostGraduates
  • UnderGraduates
• System

Marking a selection

Using marker

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

• CM
  • CM/Public
• Main
• PP
  • PP/Public
• 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%"
}%

• CM
  • Public
• Main
• PP
  • Public
• Public
• ShowCase
• Students
  • PostGraduates
  • UnderGraduates
• TWiki

Related Topics: FlexWebListNavi, FlexWebListPlugin, FlexWebListTree