VarTOPICLIST < TWiki04

This web contains the official documentation of the TWiki Release 4.0.2, code named DakarRelease. It is a read-only web for reference. Please update documentation at TWiki.VarTOPICLIST. -- PeterThoeny - 30 Mar 2007

You are here: TWiki>

TWiki04 Web>TWikiVariables>VarTOPICLIST (2005-03-27, TWikiContributor)

Tags: , view all tags

TOPICLIST{"format"} -- topic index of a web

List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name, $qname to double quoted name, $marker to marker parameter where topic matches selection, and $web to the name of the web.
Syntax: %TOPICLIST{"format" ...}%
Supported parameters:

Parameter:	Description:	Default:
`"format"`	Format of one line, may include `$web` (name of web), `$name` (name of the topic), `$qname` (name of topic in double quotes), `$marker` (which expands to `marker` for the item matching `selection` only)	`"$name"`
`format="format"`	(Alternative to above)	`"$name"`
`separator=", "`	line separator	`"$n"` (new line)
`marker="selected"`	Text for `$marker` if the item matches `selection`	`"selected"`
`selection="TopicA, TopicB"`	Current value to be selected in list	`(none)`
`web="Name"`	Name of web	Current web

Example: %TOPICLIST{" * $web.$name"}% creates a bullet list of all topics
Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
Example: %TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
Example: <select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected
Related: SEARCH, WEBLIST

Topic revision: r0 - 2005-03-27 - 13:14:15 - TWikiContributor

Twiki, Inc.

TWiki04

Edit

Attach