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

46 lines
2.0 KiB
Plaintext
Raw Normal View History

head 1.1;
access;
symbols;
locks; strict;
comment @# @;
1.1
date 2006.06.25.16.26.29; author TWikiContributor; state Exp;
branches;
next ;
desc
@buildrelease
@
1.1
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
%META:TOPICPARENT{name="TWikiVariables"}%
#VarTOPICLIST
---+++ 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: =%<nop>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: =%<nop>TOPICLIST{" * $web.$name"}%= creates a bullet list of all topics
* Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
* Example: =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus)
* Example: =&lt;select&gt;%<nop>TOPICLIST{" &lt;option $marker value='$name'&gt;$name&lt;/option&gt;" separator=" " selection="%<nop>TOPIC%"}%&lt;/select&gt;= creates an option list of web topics with the current topic selected
* Related: [[#VarSEARCH][SEARCH]], [[#VarWEBLIST][WEBLIST]]
@