(r3) VarWEBLIST < TWiki

You are here: TWiki>

TWiki Web>TWikiVariables>VarWEBLIST (revision 3)

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: %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. *NOTE:* Administrators will see all webs, not just the public ones	`"public"`
`marker="selected"`	Text for `$marker` if the item matches `selection`	`"selected"`
`selection="%WEB%"`	Current value to be selected in list	`section="%WEB%"`

Example: %WEBLIST{" * [[$name.WebHome]]"}% - creates a bullet list of all webs.
Example: <form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form> - creates a dropdown of all public webs + Trash web, with the current web highlighted.
Related: TOPICLIST, SEARCH

Topic revision: r3 - 2007-03-01 - 22:10:18 - TWikiContributor

TWIKI.NET

TWiki

~~Edit~~

~~Attach~~

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarWEBLIST