FlexWebListExamples

20 December 2024 - 05:44 | Version 1 |

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=", "}%
adminwebs, exclude, footer, format="
  • Home
      Home<ul class, separator, subwebs, webs, }

      Influencing order

      %FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%" separator=", " subheader=", "}%
      
      adminwebs, exclude, footer, format="
    • Home
        Home<ul class, separator, subwebs, webs, }

        Controlling subwebs

        No subwebs

        %FLEXWEBLIST{subwebs="none" separator=", " subheader=", "}%
        
        adminwebs, exclude, footer, format="
      • <a href, separator, subwebs, webs, }

        Only subwebs

        %FLEXWEBLIST{subwebs="only" separator=", " subheader=", "}%
        
        header="
      • Home
          Home<ul class

          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=", "}%
          
          adminwebs, exclude, footer, format="
        • <a href, separator, subwebs, webs, }

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

          Nested list using HTML

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

    [[ header="
  • Home<ul class.WebHome][WebHome][Home]]<ul class]]
  • [[ header="
  • Home<ul class.WebHome][WebHome][Home]]<ul class]]
  • }

    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%"
    }%
    
    • adminwebs
    • exclude
    • footer
    • format="
    • <a href
      • header="
      • Home<ul class
      • header="
      • Home<ul class
    • separator
    • subwebs
    • webs
    • }

    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