data/TWiki/VarWEBLIST.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1172787018" format="1.1" version="4"}%
colas@0
     2
%META:TOPICPARENT{name="TWikiVariables"}%
colas@0
     3
#VarWEBLIST
colas@0
     4
---+++ WEBLIST{"format"} -- index of all webs
colas@0
     5
   * List of all webs. Obfusticated webs are excluded, e.g. webs with a =NOSEARCHALL = on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
colas@0
     6
   * Syntax: =%<nop>WEBLIST{"format" ...}%=
colas@0
     7
   * Supported parameters:
colas@0
     8
     | *Parameter:* | *Description:* | *Default:* |
colas@0
     9
     | ="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"= |
colas@0
    10
     | =format="format"= | (Alternative to above) | ="$name"= |
colas@0
    11
     | =separator=", "= | Line separator | ="$n"= (new line) |
colas@0
    12
     | =web=""= | if you specify =$web= in format, it will be replaced with this  | =""= |
colas@0
    13
     | =webs="public"=   | Comma separated list of webs, =public= expands to all non-hidden.%BR% __NOTE:__ Administrators will see all webs, not just the public ones | ="public"= |
colas@0
    14
     | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
colas@0
    15
     | =selection="%<nop>WEB%"= | Current value to be selected in list | =selection="%<nop>WEB%"= |
colas@0
    16
     | =subwebs="Sandbox"=   | show webs that are a sub-web of this one (recursivly) | =""= |
colas@0
    17
   * Example: =%<nop>WEBLIST{"   * [<nop>[$name.%HOMETOPIC%]]"}%= - creates a bullet list of all webs.
colas@0
    18
   * Example: =&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;= - creates a dropdown of all public webs + Trash web, with the current web highlighted.
colas@0
    19
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]]