TWiki > FlexWebListPlugin > FlexWebListExamples	Daya Bay webs: Public | 中文 | Internal | Help
			Log In or Register

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%

Influencing order

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

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

• Main
• Public
  • Chinese
  • Public
    • Chinese
• Sandbox
  • Sandbox
• TWiki

Nested list using HTML

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

• Main
• Public
  • Chinese
  • Public
    • Chinese
• Sandbox
  • Sandbox
• 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"
~~~ }%

• Main
• Public
• Sandbox
• TWiki

Twisty weblist

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

• Main (0) Main (0)
• Public (2) Public (2)
  • Chinese (0) Chinese (0)
  • Public (1) Public (1)
    • Chinese (0) Chinese (0)
• Sandbox (1) Sandbox (1)
  • Sandbox (0) Sandbox (0)
• TWiki (0) TWiki (0)

Twisty navigation

TWiki:Plugins/TwistyPlugin

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

• Public  %IFDEFINEDTHEN{"2 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
  • Chinese  %IFDEFINEDTHEN{"0 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
  • Public  %IFDEFINEDTHEN{"1 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
    • Chinese  %IFDEFINEDTHEN{"0 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
• Main  %IFDEFINEDTHEN{"0 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
• Sandbox  %IFDEFINEDTHEN{"1 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
  • Sandbox  %IFDEFINEDTHEN{"0 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%
• TWiki  %IFDEFINEDTHEN{"0 " as="0 "}% %ELSEDEFINED% More... Close %FIDEFINED%

Sitemap

Mapping names

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

• Main
• Home
  • Chinese
  • Home
    • Chinese
• Sandbox
  • Sandbox
• System

Marking a selection

Using marker

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

• Main
• Public
  • Public/Chinese
  • Public/Public
    • Public/Public/Chinese
• Sandbox
  • Sandbox/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%"
~~~ }%

• Main
• Public
  • Chinese
  • Public
    • Chinese
• Sandbox
  • Sandbox
• TWiki