data/TWiki/VarTOPICLIST.txt,v
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/VarTOPICLIST.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,77 @@
     1.4 +head	1.2;
     1.5 +access;
     1.6 +symbols;
     1.7 +locks; strict;
     1.8 +comment	@# @;
     1.9 +
    1.10 +
    1.11 +1.2
    1.12 +date	2008.01.22.03.21.25;	author TWikiContributor;	state Exp;
    1.13 +branches;
    1.14 +next	1.1;
    1.15 +
    1.16 +1.1
    1.17 +date	2006.06.25.16.26.29;	author TWikiContributor;	state Exp;
    1.18 +branches;
    1.19 +next	;
    1.20 +
    1.21 +
    1.22 +desc
    1.23 +@buildrelease
    1.24 +@
    1.25 +
    1.26 +
    1.27 +1.2
    1.28 +log
    1.29 +@buildrelease
    1.30 +@
    1.31 +text
    1.32 +@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="2"}%
    1.33 +%META:TOPICPARENT{name="TWikiVariables"}%
    1.34 +#VarTOPICLIST
    1.35 +---+++ TOPICLIST{"format"} -- topic index of a web
    1.36 +   * 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.
    1.37 +   * Syntax: =%<nop>TOPICLIST{"format" ...}%=
    1.38 +   * Supported parameters:
    1.39 +     | *Parameter:* | *Description:* | *Default:* |
    1.40 +     | ="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"= |
    1.41 +     | =format="format"= | (Alternative to above) | ="$topic"= |
    1.42 +     | =separator=", "= | line separator | ="$n"= (new line) |
    1.43 +     | =marker="selected"= | Text for =$marker= if the item matches =selection= | ="selected"= |
    1.44 +     | =selection="TopicA, !TopicB"= | Current value to be selected in list | =(none)= |
    1.45 +     | =web="Name"= | Name of web | Current web |
    1.46 +   * Example: =%<nop>TOPICLIST{"   * $web.$topic"}%= creates a bullet list of all topics
    1.47 +   * Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
    1.48 +   * Example: =%<nop>TOPICLIST{" &lt;option&gt;$topic&lt;/option&gt;"}%= creates an option list (for drop down menus)
    1.49 +   * 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
    1.50 +   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]]
    1.51 +
    1.52 +@
    1.53 +
    1.54 +
    1.55 +1.1
    1.56 +log
    1.57 +@buildrelease
    1.58 +@
    1.59 +text
    1.60 +@d1 1
    1.61 +a1 1
    1.62 +%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.2" version="1"}%
    1.63 +a3 1
    1.64 +
    1.65 +d5 1
    1.66 +a5 1
    1.67 +   * 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.
    1.68 +d9 2
    1.69 +a10 2
    1.70 +     | ="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"= |
    1.71 +     | =format="format"= | (Alternative to above) | ="$name"= |
    1.72 +d15 1
    1.73 +a15 1
    1.74 +   * Example: =%<nop>TOPICLIST{"   * $web.$name"}%= creates a bullet list of all topics
    1.75 +d17 3
    1.76 +a19 3
    1.77 +   * Example: =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus)
    1.78 +   * 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
    1.79 +   * Related: [[#VarSEARCH][SEARCH]], [[#VarWEBLIST][WEBLIST]]
    1.80 +@