WEBLIST{"format"} -- index of all webs

  • List of all webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on 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: %WEBLIST{"format" ...}%
  • Supported parameters:
    Parameter: Description:Sorted descending Default:
    marker="selected" Text for $marker if the item matches selection selected="selected"
    subwebs="Sandbox" Specifies a single web. If specified, then public and webtemplate (described above) will expand relative to show subwebs below this web only. ""
    separator=", " Line separator $n (new line)
    web="" if you specify $web in format, it will be replaced with this value. none
    "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
    selection="%WEB%" Entry to be selected in list. If one of the webs matches this selection, then $marker in the format will be expanded selection=%WEB%
    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.
    *NOTE: Administrators will see all webs, not just the public ones
    public
    format="format" (Alternative to above) $name
  • Example, creates a bullet list of all webs:
    %WEBLIST{"   * [[$name.%HOMETOPIC%]]"}%
  • Example, creates a dropdown of all public webs + Trash web, with the current web highlighted:
    <form><select name="web">%WEBLIST{
          "<option $marker value='$qname'>$name</option>"
          webs="Trash, public"
          selection="%WEB%"
          separator=" "
       }% </select></form>
    ALERT! WEBLIST will not show a web called 'TWiki' even if it exists in the file system unless the TWikiCompatibilityPlugin is installed and activated in configure. This is done to ensure that the TWiki compatibility components such as the TWiki web are only visible and active when needed
  • Related: TOPICLIST, SEARCH

This topic: SystemFoswiki > WebHome > Macros > VarWEBLIST
Topic revision: 19 Sep 2010, 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 Foswiki? Send feedback