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

ApplicationsApplications/BlogApp, Applications/ClassificationApp, MainMain/WillNorris, PRINCE2PRINCE2/WikiWorkBench, Sandbox, System

Influencing order

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

MainMain/WillNorris, ApplicationsApplications/BlogApp, Applications/ClassificationApp, PRINCE2PRINCE2/WikiWorkBench, Sandbox, System

Controlling subwebs

No subwebs

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

Applications, Main, PRINCE2, Sandbox, System

Only subwebs

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

Applications/BlogApp, Applications/ClassificationApp, Main/WillNorris, PRINCE2/WikiWorkBench

Subwebs of "Sandbox"

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

Using include and exclude

Exclude TestCases and Trash webs

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

Applications, Main, PRINCE2, Sandbox, System

Include Sandbox web and all of its subwebs

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

Sandbox

Creating lists

Simple nested list

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

• Applications
  • BlogApp
  • ClassificationApp
• Main
  • WillNorris
• PRINCE2
  • WikiWorkBench
• Sandbox
• System

Nested list using HTML

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

• Applications
  • BlogApp
  • ClassificationApp
• Main
  • WillNorris
• PRINCE2
  • WikiWorkBench
• Sandbox
• System

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

• Applications
  • BlogApp
  • ClassificationApp
• Main
• PRINCE2
• Sandbox
• System

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

• Applications (2)Applications (2)
  • BlogApp BlogApp
  • ClassificationApp ClassificationApp
• Main (1)Main (1)
  • WillNorris WillNorris
• PRINCE2 (1)PRINCE2 (1)
  • WikiWorkBench WikiWorkBench
• Sandbox Sandbox
• System System

Sitemap

Mapping names

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

• Applications
  • BlogApp
  • ClassificationApp
• Users
  • WillNorris
• PRINCE2
  • WikiWorkBench
• Sandbox
• Documentation

Marking a selection

Using marker

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

• Applications
  • Applications/BlogApp
  • Applications/ClassificationApp
• Main
  • Main/WillNorris
• PRINCE2
  • PRINCE2/WikiWorkBench
• Sandbox
• 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%"
}%

• Applications
  • BlogApp
  • ClassificationApp
• Main
  • WillNorris
• PRINCE2
  • WikiWorkBench
• Sandbox
• System