data/TWiki/VarTOPICLIST.txt
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="2"}%
       
     2 %META:TOPICPARENT{name="TWikiVariables"}%
       
     3 #VarTOPICLIST
       
     4 ---+++ TOPICLIST{"format"} -- topic index of a web
       
     5    * List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The =$topic= variable gets expanded to the topic name, =$marker= to =marker= parameter where topic matches =selection=, and =$web= to the name of the web, or any of the standard FormatTokens.
       
     6    * Syntax: =%<nop>TOPICLIST{"format" ...}%=
       
     7    * Supported parameters:
       
     8      | *Parameter:* | *Description:* | *Default:* |
       
     9      | ="format"= | Format of one line, may include =$web= (name of web), =$topic= (name of the topic), =$marker= (which expands to =marker= for the item matching =selection= only) | ="$topic"= |
       
    10      | =format="format"= | (Alternative to above) | ="$topic"= |
       
    11      | =separator=", "= | line separator | ="$n"= (new line) |
       
    12      | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
       
    13      | =selection="TopicA, !TopicB"= | Current value to be selected in list | =(none)= |
       
    14      | =web="Name"= | Name of web | Current web |
       
    15    * Example: =%<nop>TOPICLIST{"   * $web.$topic"}%= creates a bullet list of all topics
       
    16    * Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
       
    17    * Example: =%<nop>TOPICLIST{" &lt;option&gt;$topic&lt;/option&gt;"}%= creates an option list (for drop down menus)
       
    18    * Example: =&lt;select&gt;%<nop>TOPICLIST{" &lt;option $marker value='$topic'&gt;$topic&lt;/option&gt;" separator=" " selection="%<nop>TOPIC%"}%&lt;/select&gt;= creates an option list of web topics with the current topic selected
       
    19    * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]]
       
    20