VarTOPICLIST < TWiki

Tags: view all tags

#VarTOPICLIST
---+++ 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: =%<nop>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: =%<nop>TOPICLIST{"   * $web.$topic"}%= creates a bullet list of all topics
   * Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
   * Example: =%<nop>TOPICLIST{" &lt;option&gt;$topic&lt;/option&gt;"}%= creates an option list (for drop down menus)
   * 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
   * Category: SearchingAndListingVariables, SystemInformationVariables
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSEARCH][SEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarWEBLIST][WEBLIST]]

Versão do tópico: r4 - 27 Jul 2016 - TWikiContributor

Account
- Iniciar sessão

Edit
Anexar

Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Idéias, solicitações, problemas com relação ao TWiki? Nos dê um retorno
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarTOPICLIST.