NOTE: This is a
DistributionDocument.
- Please help maintain high quality documentation:
This is a wiki, please
fix the documentation if you find errors or incomplete content.
Put questions and suggestions concerning the documentation of this topic in the comments section below.
Use the Support web for problems you are having using TWiki.
Use the Sandbox web to evaluate & test TWiki.
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
$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.
- Syntax:
%TOPICLIST{"format" ...}%
- Supported parameters:
Parameter: | Description: | Default: |
"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" |
format="format" | (Alternative to above) | "$topic" |
separator=", " | line separator | "$n" (new line) |
marker="selected" | Text for $marker if the item matches selection | "selected" |
selection="TopicA, TopicB" | Topic(s) to show selected with $marker ; specify a comma-space list of full topic names | (none) |
web="Name" | Name of web | Current web |
- Example:
%TOPICLIST{" * $web.$topic"}%
creates a bullet list of all topics
- Example:
%TOPICLIST{separator=", "}%
creates a comma separated list of all topics
- Example:
%TOPICLIST{" <option>$topic</option>"}%
creates an option list (for drop down menus)
- Example:
<select>%TOPICLIST{" <option $marker value='$topic'>$topic</option>" separator=" " selection="%TOPIC%"}%</select>
creates an option list of web topics with the current topic selected
- Category: SearchingAndListingVariables, SystemInformationVariables
- Related: SEARCH, WEBLIST
Comments & Questions about this Distribution Document Topic
Please provide a link to more information about how the selection parameter can be used, e.g. are negation, wildcards, and regex available? (selection="-TopicA,Topic?, topic0*")
--
TWiki Guest - 2016-07-26
Thank you guest for pointing this out. I updated the docs accordingly.
--
Peter Thoeny - 2016-07-27
Can I use TOPICLIST to simply provide a list of topics selected using negation, wildcards, or regex?
e.g. %TOPICLIST {topic="-Web*" format="$topic" separator="<br />"}%
--
TWiki Guest - 2016-07-27
Not with the API this variable provides. You can however filter the resulting list using the
SpreadSheetPlugin. Best to ask support questions in the
Support web.
--
Peter Thoeny - 2016-08-02