data/TWiki/VarTOPICLIST.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 head	1.2;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.2
     9 date	2008.01.22.03.21.25;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	1.1;
    12 
    13 1.1
    14 date	2006.06.25.16.26.29;	author TWikiContributor;	state Exp;
    15 branches;
    16 next	;
    17 
    18 
    19 desc
    20 @buildrelease
    21 @
    22 
    23 
    24 1.2
    25 log
    26 @buildrelease
    27 @
    28 text
    29 @%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="2"}%
    30 %META:TOPICPARENT{name="TWikiVariables"}%
    31 #VarTOPICLIST
    32 ---+++ TOPICLIST{"format"} -- topic index of a web
    33    * 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.
    34    * Syntax: =%<nop>TOPICLIST{"format" ...}%=
    35    * Supported parameters:
    36      | *Parameter:* | *Description:* | *Default:* |
    37      | ="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"= |
    38      | =format="format"= | (Alternative to above) | ="$topic"= |
    39      | =separator=", "= | line separator | ="$n"= (new line) |
    40      | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
    41      | =selection="TopicA, !TopicB"= | Current value to be selected in list | =(none)= |
    42      | =web="Name"= | Name of web | Current web |
    43    * Example: =%<nop>TOPICLIST{"   * $web.$topic"}%= creates a bullet list of all topics
    44    * Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
    45    * Example: =%<nop>TOPICLIST{" &lt;option&gt;$topic&lt;/option&gt;"}%= creates an option list (for drop down menus)
    46    * 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
    47    * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]]
    48 
    49 @
    50 
    51 
    52 1.1
    53 log
    54 @buildrelease
    55 @
    56 text
    57 @d1 1
    58 a1 1
    59 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
    60 a3 1
    61 
    62 d5 1
    63 a5 1
    64    * 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.
    65 d9 2
    66 a10 2
    67      | ="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"= |
    68      | =format="format"= | (Alternative to above) | ="$name"= |
    69 d15 1
    70 a15 1
    71    * Example: =%<nop>TOPICLIST{"   * $web.$name"}%= creates a bullet list of all topics
    72 d17 3
    73 a19 3
    74    * Example: =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus)
    75    * 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
    76    * Related: [[#VarSEARCH][SEARCH]], [[#VarWEBLIST][WEBLIST]]
    77 @