VarWEBLIST < System < BACCHUS Wiki

#VarWEBLIST
---+++ WEBLIST{"format"} -- index of all webs
   * List of all webs. Obfuscated webs are excluded, e.g. webs with a =NOSEARCHALL = on= [[PreferenceSettings][preference setting]]. The ="format"= defines the format of one web item. The =$name= gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=. Subwebs are listed recursively.
   * Syntax: =%<nop>WEBLIST{"format" ...}%=
   * Supported parameters:
     | *Parameter:* | *Description:* | *Default:* |
     | ="format"= | Format of one line, may include =$name= (the name of the web), $qname (the name of the web in double quotes), =$indentedname= (the name of the web with parent web names replaced by indents, for use in indented lists), and =$marker= (which expands to =marker= for the item matching =selection= only) | =$name= |
     | =format="format"= | (Alternative to above) | =$name= |
     | =separator=", "= | Line separator | =$n= (new line) |
     | =web=""= | if you specify =$web= in format, it will be replaced with this value. | none |
     | =webs="public"=   | Comma separated list of webs to consider. This list can include two pseudo-webs, =public= which expands to all non-hidden and =webtemplate= which expands to the names of all template webs.%BR% *NOTE:* Administrators will see all webs, not just the public ones | =public= |
     | =subwebs="%SANDBOXWEB%"=   | Specifies a single web. If specified, then =public= and =webtemplate= (described above) will expand relative to show subwebs *below this web only. | =""= |
     | =selection="%<nop>WEB%"= | Entry to be selected in list. If one of the webs matches this selection, then =$marker= in the =format= will be expanded | =selection=%<nop>WEB%= |
     | =marker="selected"= | Text for =$marker= if the item matches =selection= | =selected="selected"= |
   * Example, creates a bullet list of all webs: <verbatim class="tml">%WEBLIST{"   * [[$name.%HOMETOPIC%]]"}%</verbatim>
   * Example, creates a dropdown of all public webs + Trash web, with the current web highlighted: <pre class="tml">&lt;form&gt;&lt;select name="web"&gt;%<nop>WEBLIST{
      "&lt;option $marker value='$qname'&gt;$name&lt;/option&gt;"
      webs="Trash, public"
      selection="%<nop>WEB%"
      separator=" "
   }% &lt;/select&gt;&lt;/form&gt;</pre>
   <blockquote class="foswikiHelp">%X% =WEBLIST= will not show a web called 'TWiki' even if it exists in the file system unless the =TWikiCompatibilityPlugin= is installed and activated in [[%SCRIPTURLPATH{"configure"}%][configure]]. This is done to ensure that the TWiki compatibility components such as the TWiki web are only visible and active when needed</blockquote>
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]]
<!--%JQREQUIRE{"chili"}%-->
This topic: System > WebHome > Macros > VarWEBLIST
Topic revision: revision 1 (raw view)
Copyright &© by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding BACCHUS Wiki? Send feedback