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