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

exclude, format, include, marker, selection, separator, webs, }, FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Influencing order

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

exclude, format, include, marker, selection, separator, webs, }, FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Controlling subwebs

No subwebs

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

exclude, format, include, marker, selection, separator, webs, }, FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Only subwebs

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

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

exclude, format, include, marker, selection, separator, webs, }, FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Include Sandbox web and all of its subwebs

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

Creating lists

Simple nested list

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Nested list using HTML

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

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

• exclude exclude
• format format
• include include
• marker marker
• selection selection
• separator separator
• webs webs
• } }
• FLEXWEBLIST{separator=FLEXWEBLIST{separator=

Sitemap

Mapping names

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Marking a selection

Using marker

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader

Using markerformat

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

• exclude
• format
• include
• marker
• selection
• separator
• webs
• }
• FLEXWEBLIST{separator=", " subheader=", "}=FLEXWEBLIST{separator=", " subheader