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

%FLEXWEBLIST{separator=", "}%

Influencing order

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

%FLEXWEBLIST{webs="Main,public,System" separator=", "}%

Controlling subwebs

No subwebs

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

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

Only subwebs

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

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

Subwebs of "Sandbox"

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

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

Using include and exclude

Exclude TestCases and Trash webs

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

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

Include Sandbox web and all of its subwebs

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

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

Creating lists

Simple nested list

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

%FLEXWEBLIST{format="$indent * $name$n"}%

Nested list using HTML

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

%FLEXWEBLIST{header="

" format="
• $name" separator="
" footer="

"}%

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

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

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

%FLEXWEBLIST{ header="

• " format=" $percntTWISTY{ link=\"$name $percntIF{\"$nrsubwebs > 0\" then=\"($nrsubwebs)\"}$percnt\" }$percnt" separator="$percntENDTWISTY$percnt
• " footer="

" }%

Sitemap

%FLEXWEBLIST{ webs="sitemap" header="" }%

Mapping names

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

%FLEXWEBLIST{ map="TestCases=Tests,System=Documentation,Main=Users" format="$indent * $name$n" }%

Marking a selection

Using marker

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

%FLEXWEBLIST{ exclude="(TestCases|Trash).*" format="$indent * $web $n" marker="foswikiAlert" selection="System" }%

Using markerformat

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

%FLEXWEBLIST{ exclude="(TestCases|Trash).*" format="$indent * $name$n" markerformat="$indent * $name$n" selection="System" }%