You are here: CLASSE Wiki>System Web>FlexWebListPlugin>FlexWebListExamples (28 May 2018, ProjectContributor)Edit Attach
Tags

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=", "}%
ACCACC.ACL, ACC.Bunch, ACC.Private, BusinessOffice, CBBCBB.NSF, CBETA, CESRCESR.Private, CHESSCHESS.FMB, CHESS.Maia, CHESS.XIMG, CHEXS, CLASSECLASSE.Inventory, CLASSE.Private.Communications, CLEOCLEO.PrivateCLEO.Private.AC, CLEO.Private.Administration, CLEO.Private.RunMan, CLEO.Private.SW, CMSPhase2MREFC, ComputingComputing.Blogs, Computing.Newsletter, Computing.Obsolete, Computing.Private, CosmologyCosmology.Private, DarkPhoton, ERLERL.Private, EngineeringDesignDrafting, G2, HEPHEP.DBSWorkshop, HEP.SWIG, HLLHCCMSMREFC, HMF, HumanResourcesHumanResources.Private, ILCILC.Americas, ILC.CesrTAILC.CesrTA.Proposal, ILC.DampingRingsILC.DampingRings.AreaLeaders, ILC.DampingRings.CTA09, ILC.DampingRings.ILCDR06, ILC.DampingRings.ILCDR07_KEK, ILC.DampingRings.ILCDR08, ILC.DampingRings.S3TaskForce, ILC.PrivateILC.Private.CesrTA, ILC.WWS, MacCHESS, Main, People, PhotocathodeBrightBeams, REUREU.Private, SRFSRF.PrivateSRF.Private.Documentation, SRF.Private.PCsrfcn1, SafetySafety.HandbookSafety.Handbook.PrivateSafety.Handbook.Private.ExternalResources, SandboxSandbox.TestWeb, Sandbox.Testauth, System, TheoryTheory.Private, Trash.Communications, Trash.Documents, Trash.Phase2MREFC, WebDevWebDev.Private, XLEAP

Influencing order 

%FLEXWEBLIST{webs="%USERSWEB%,public,%SYSTEMWEB%" separator=", "}%
Main, ACCACC.ACL, ACC.Bunch, ACC.Private, BusinessOffice, CBBCBB.NSF, CBETA, CESRCESR.Private, CHESSCHESS.FMB, CHESS.Maia, CHESS.XIMG, CHEXS, CLASSECLASSE.Inventory, CLASSE.Private.Communications, CLEOCLEO.PrivateCLEO.Private.AC, CLEO.Private.Administration, CLEO.Private.RunMan, CLEO.Private.SW, CMSPhase2MREFC, ComputingComputing.Blogs, Computing.Newsletter, Computing.Obsolete, Computing.Private, CosmologyCosmology.Private, DarkPhoton, ERLERL.Private, EngineeringDesignDrafting, G2, HEPHEP.DBSWorkshop, HEP.SWIG, HLLHCCMSMREFC, HMF, HumanResourcesHumanResources.Private, ILCILC.Americas, ILC.CesrTAILC.CesrTA.Proposal, ILC.DampingRingsILC.DampingRings.AreaLeaders, ILC.DampingRings.CTA09, ILC.DampingRings.ILCDR06, ILC.DampingRings.ILCDR07_KEK, ILC.DampingRings.ILCDR08, ILC.DampingRings.S3TaskForce, ILC.PrivateILC.Private.CesrTA, ILC.WWS, MacCHESS, People, PhotocathodeBrightBeams, REUREU.Private, SRFSRF.PrivateSRF.Private.Documentation, SRF.Private.PCsrfcn1, SafetySafety.HandbookSafety.Handbook.PrivateSafety.Handbook.Private.ExternalResources, SandboxSandbox.TestWeb, Sandbox.Testauth, System, TheoryTheory.Private, Trash.Communications, Trash.Documents, Trash.Phase2MREFC, WebDevWebDev.Private, XLEAP

Controlling subwebs

No subwebs 

%FLEXWEBLIST{subwebs="none" separator=", "}%
ACC, BusinessOffice, CBB, CBETA, CESR, CHESS, CHEXS, CLASSE, CLEO, CMSPhase2MREFC, Computing, Cosmology, DarkPhoton, ERL, EngineeringDesignDrafting, G2, HEP, HLLHCCMSMREFC, HMF, HumanResources, ILC, MacCHESS, Main, People, PhotocathodeBrightBeams, REU, SRF, Safety, Sandbox, System, Theory, WebDev, XLEAP

Only subwebs 

%FLEXWEBLIST{subwebs="only" separator=", "}%
ACC.ACL, ACC.Bunch, ACC.Private, CBB.NSF, CESR.Private, CHESS.FMB, CHESS.Maia, CHESS.XIMG, CLASSE.Inventory, CLASSE.Private.Communications, CLEO.PrivateCLEO.Private.AC, CLEO.Private.Administration, CLEO.Private.RunMan, CLEO.Private.SW, Computing.Blogs, Computing.Newsletter, Computing.Obsolete, Computing.Private, Cosmology.Private, ERL.Private, HEP.DBSWorkshop, HEP.SWIG, HumanResources.Private, ILC.Americas, ILC.CesrTAILC.CesrTA.Proposal, ILC.DampingRingsILC.DampingRings.AreaLeaders, ILC.DampingRings.CTA09, ILC.DampingRings.ILCDR06, ILC.DampingRings.ILCDR07_KEK, ILC.DampingRings.ILCDR08, ILC.DampingRings.S3TaskForce, ILC.PrivateILC.Private.CesrTA, ILC.WWS, REU.Private, SRF.PrivateSRF.Private.Documentation, SRF.Private.PCsrfcn1, Safety.HandbookSafety.Handbook.PrivateSafety.Handbook.Private.ExternalResources, Sandbox.TestWeb, Sandbox.Testauth, Theory.Private, Trash.Communications, Trash.Documents, Trash.Phase2MREFC, WebDev.Private

Subwebs of "Sandbox" 

%FLEXWEBLIST{subwebs="Sandbox" separator=", "}%
Sandbox.TestWeb, Sandbox.Testauth

Using include and exclude

Exclude TestCases and Trash webs 

%FLEXWEBLIST{exclude="(TestCases|Trash).*" subwebs="none" separator=", "}%
ACC, BusinessOffice, CBB, CBETA, CESR, CHESS, CHEXS, CLASSE, CLEO, CMSPhase2MREFC, Computing, Cosmology, DarkPhoton, ERL, EngineeringDesignDrafting, G2, HEP, HLLHCCMSMREFC, HMF, HumanResources, ILC, MacCHESS, Main, People, PhotocathodeBrightBeams, REU, SRF, Safety, Sandbox, System, Theory, WebDev, XLEAP

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

ACC
ACL
Bunch
Private
BusinessOffice
CBB Center for Bright Beams
NSF
CBETA Cornell-Brookhaven ERL Test Accelerator
CESR
Private
CHESS
FMB
Maia Documentation for the CHESS Maia detector, including GeoPixe, etc.
XIMG
CHEXS
CLASSE
Inventory
Communications
CLEO
Private
AC
Administration
RunMan
SW
CMSPhase2MREFC
Computing
Blogs
Newsletter
Obsolete
Private
Cosmology
Private
DarkPhoton
ERL
Private
EngineeringDesignDrafting
G2
HEP High Energy Physics
DBSWorkshop High Energy Physics
SWIG High Energy Physics
HLLHCCMSMREFC
HMF
HumanResources human resources information for employees
Private human resources information accessible by anyone with a CLASSE ID
ILC
Americas
CesrTA
Proposal
DampingRings
AreaLeaders
CTA09
ILCDR06
ILCDR07_KEK
ILCDR08
S3TaskForce
Private
CesrTA
WWS
MacCHESS MacCHESS
Main Welcome to CLASSE Wiki ... meet people on this site
People
PhotocathodeBrightBeams photocathode development & high brightness electron beams laboratory wiki
REU
Private
SRF
Private
Documentation Documentation information for the SRF group
PCsrfcn1
Safety
Handbook
Private
ExternalResources
Sandbox Sandbox test area to experiment in an unrestricted hands-on web.
TestWeb
Testauth
System Discover the details, and how to start your own site with Foswiki - The Free and Open Source Wiki.
Theory
Private
Communications
Documents Safety Documents
Phase2MREFC
WebDev
Private
XLEAP

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%"
}%
  • ACC
    • ACC.ACL
    • ACC.Bunch
    • ACC.Private
  • BusinessOffice
  • CBB
    • CBB.NSF
  • CBETA
  • CESR
    • CESR.Private
  • CHESS
    • CHESS.FMB
    • CHESS.Maia
    • CHESS.XIMG
  • CHEXS
  • CLASSE
    • CLASSE.Inventory
      • CLASSE.Private.Communications
  • CLEO
    • CLEO.Private
      • CLEO.Private.AC
      • CLEO.Private.Administration
      • CLEO.Private.RunMan
      • CLEO.Private.SW
  • CMSPhase2MREFC
  • Computing
    • Computing.Blogs
    • Computing.Newsletter
    • Computing.Obsolete
    • Computing.Private
  • Cosmology
    • Cosmology.Private
  • DarkPhoton
  • ERL
    • ERL.Private
  • EngineeringDesignDrafting
  • G2
  • HEP
    • HEP.DBSWorkshop
    • HEP.SWIG
  • HLLHCCMSMREFC
  • HMF
  • HumanResources
    • HumanResources.Private
  • ILC
    • ILC.Americas
    • ILC.CesrTA
      • ILC.CesrTA.Proposal
    • ILC.DampingRings
      • ILC.DampingRings.AreaLeaders
      • ILC.DampingRings.CTA09
      • ILC.DampingRings.ILCDR06
      • ILC.DampingRings.ILCDR07_KEK
      • ILC.DampingRings.ILCDR08
      • ILC.DampingRings.S3TaskForce
    • ILC.Private
      • ILC.Private.CesrTA
    • ILC.WWS
  • MacCHESS
  • Main
  • People
  • PhotocathodeBrightBeams
  • REU
    • REU.Private
  • SRF
    • SRF.Private
      • SRF.Private.Documentation
      • SRF.Private.PCsrfcn1
  • Safety
    • Safety.Handbook
      • Safety.Handbook.Private
        • Safety.Handbook.Private.ExternalResources
  • Sandbox
    • Sandbox.TestWeb
    • Sandbox.Testauth
  • System
  • Theory
    • Theory.Private
  • WebDev
    • WebDev.Private
  • XLEAP

Using markerformat 

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

Edit  | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 28 May 2018, ProjectContributor
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 CLASSE Wiki? Send feedback