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=", "}%
Almanac, ApplicationsApplications.ClassificationApp, Applications.LocalApps, CollegeAppCopy, Main, MiddleFork, MiddleForkHaven, OEC, Sandbox, System, TCAOTCAO.Installs

Influencing order

%FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%" separator=", "}%
Main, Almanac, ApplicationsApplications.ClassificationApp, Applications.LocalApps, CollegeAppCopy, MiddleFork, MiddleForkHaven, OEC, Sandbox, System, TCAOTCAO.Installs

Controlling subwebs

No subwebs

%FLEXWEBLIST{subwebs="none" separator=", "}%
Almanac, Applications, CollegeAppCopy, Main, MiddleFork, MiddleForkHaven, OEC, Sandbox, System, TCAO

Only subwebs

%FLEXWEBLIST{subwebs="only" separator=", "}%
Applications.ClassificationApp, Applications.LocalApps, TCAO.Installs

Subwebs of "Sandbox"

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

Using include and exclude

Exclude TestCases and Trash webs

%FLEXWEBLIST{exclude="(TestCases|Trash).*" subwebs="none" separator=", "}%
Almanac, Applications, CollegeAppCopy, Main, MiddleFork, MiddleForkHaven, OEC, Sandbox, System, TCAO

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

Nested list using HTML

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

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

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

Sitemap

Almanac Seasonal knowledge
Applications Applications Library
ClassificationApp Categorization and folksomony application
LocalApps Misc local applications
Main Welcome to Middle Fork Home Wiki … meet people on this site
MiddleFork Our place on Middle Fork Road
MiddleForkHaven Visiter guide for staying at our RV and being our guest in the high country
OEC Outdoor Emergency Care
Sandbox Sandbox test area to experiment in an unrestricted hands-on web.
System Discover the details, and how to start your own site with Foswiki - The Free and Open Source Wiki.

Mapping names

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

Marking a selection

Using marker

%FLEXWEBLIST{
   exclude="(TestCases|Trash).*"
   format="$indent   * <span class=\"$marker\"> $web </span>$n"
   marker="foswikiAlert"
   selection="%BASEWEB%"
}%
  • Almanac
  • Applications
    • Applications.ClassificationApp
    • Applications.LocalApps
  • CollegeAppCopy
  • Main
  • MiddleFork
  • MiddleForkHaven
  • OEC
  • Sandbox
  • System
  • TCAO
    • TCAO.Installs

Using markerformat

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

This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Middle Fork Home Wiki? Send feedback
Syndicate this site RSS