wiki-archive/twiki/data/TWiki/VarWEBLIST.txt,v

65 lines
2.4 KiB
Plaintext

head 1.2;
access;
symbols;
locks; strict;
comment @# @;
1.2
date 2007.01.16.04.12.02; author TWikiContributor; state Exp;
branches;
next 1.1;
1.1
date 2006.06.25.16.26.30; author TWikiContributor; state Exp;
branches;
next ;
desc
@buildrelease
@
1.2
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1153506034" format="1.1" version="2"}%
%META:TOPICPARENT{name="TWikiVariables"}%
#VarWEBLIST
---+++ WEBLIST{"format"} -- index of all webs
* 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=.
* 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) |
| =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"= |
| =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
| =selection="%<nop>WEB%"= | Current value to be selected in list | =section="%<nop>WEB%"= |
* Example: =%<nop>WEBLIST{" * [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
* Example: =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash, public" selection="%WEB%" separator=" "}%= creates a dropdown of all public webs + Trash web, with the current web highlighted.
* Related: [[#VarTOPICLIST][TOPICLIST]], [[#VarSEARCH][SEARCH]]
@
1.1
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
d12 2
a13 2
| =separator=", "= | line separator | ="$n"= (new line) |
| =webs="public"= | comma separated list of webs, =public= expands to all non-hidden | ="public"= |
a18 1
@