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.

No params (almost)

%FLEXWEBLIST{separator=", " subheader=", "}%

Decision, Main, Public, Sandbox, System, TCAO, TCAO/Installs, TWiki, Projects, Projects/TimeLog

Influencing order

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

Decision, Main, Public, Sandbox, System, TCAO, TCAO/Installs, TWiki, Projects, Projects/TimeLog

Controlling subwebs

No subwebs

%FLEXWEBLIST{subwebs="none" separator=", " subheader=", "}%

Decision, Main, Public, Sandbox, System, TCAO, TWiki, Projects

Only subwebs

%FLEXWEBLIST{subwebs="only" separator=", " subheader=", "}%

, TCAO/Installs, , Projects/TimeLog

Subwebs of "Sandbox"

%FLEXWEBLIST{subwebs="Sandbox" separator=", " subheader=", "}%

Using include and exclude

Exclude TestCases and Trash webs

%FLEXWEBLIST{exclude="(TestCases|Trash).*" subwebs="none" separator=", " subheader=", "}%

Decision, Main, Public, Sandbox, System, TCAO, TWiki, Projects

Include Sandbox web and all of its subwebs

%FLEXWEBLIST{include="Sandbox(\.\w+)?" separator=", " subheader=", "}%

Sandbox

Creating lists

Simple nested list

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

• Decision
• Main
• Public
• Sandbox
• System
• TCAO
  • Installs
• TWiki
• Projects
  • TimeLog

Nested list using HTML

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

• Decision
• Main
• Public
• Sandbox
• System
• TCAO
  • Installs
• TWiki
• Projects
  • TimeLog

Nested calls to FLEXWEBLIST

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

• Decision
• Main
• Public
• Sandbox
• System
• TCAO
• TWiki
• Projects

Twisty weblist

needs the Foswiki:Extensions/TwistyPlugin

%FLEXWEBLIST{
   header="<ul><li>" 
   format="
     $percntTWISTY{
       link=\"$name $percntIF{\"$nrsubwebs > 0\" then=\"($nrsubwebs)\"}$percnt\"
     }$percnt"
   separator="$percntENDTWISTY$percnt</li><li>"
   footer="</li></ul>" 
}%

• Decision Decision
• Main Main
• Public Public
• Sandbox Sandbox
• System System
• TCAO (1)TCAO (1)
  • Installs Installs
• TWiki TWiki
• Projects (1)Projects (1)
  • TimeLog TimeLog

Sitemap

Mapping names

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

• Decision
• Users
• Public
• Sandbox
• Documentation
• TCAO
  • Installs
• TWiki
• Projects
  • TimeLog

Marking a selection

Using marker

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

• Decision
• Main
• Public
• Sandbox
• System
• TCAO
  • TCAO/Installs
• TWiki
• Projects
  • Projects/TimeLog

Using markerformat

%FLEXWEBLIST{
   exclude="(TestCases|Trash).*"
   format="$indent   * [[$web.%HOMETOPIC%][$name]]$n"
   markerformat="$indent   * 
     [[$web.%HOMETOPIC%][<span class=\"foswikiAlert\">$name</span>]]$n"
   selection="%BASEWEB%"
}%

• Decision
• Main
• Public
• Sandbox
• System
• TCAO
  • Installs
• TWiki
• Projects
  • TimeLog