buildrelease

[openafs-wiki.git] / TWiki / VarTOPICLIST.mdwn

diff --git a/TWiki/VarTOPICLIST.mdwn b/TWiki/VarTOPICLIST.mdwn
index bddfb78..4478339 100644 (file)
--- a/TWiki/VarTOPICLIST.mdwn
+++ b/TWiki/VarTOPICLIST.mdwn
@@ -2,7 +2,7 @@
 
 ### <a name="TOPICLIST{&quot;format&quot;} -- topic ind"></a> 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 `$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.
+- 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: <table border="1" cellpadding="0" cellspacing="0">
   <tr>
@@ -12,13 +12,13 @@
   </tr>
   <tr>
     <td><code>"format"</code></td>
-    <td> Format of one line, may include <code>$web</code> (name of web), <code>$name</code> (name of the topic), <code>$qname</code> (name of topic in double quotes), <code>$marker</code> (which expands to <code>marker</code> for the item matching <code>selection</code> only) </td>
-    <td><code>"$name"</code></td>
+    <td> Format of one line, may include <code>$web</code> (name of web), <code>$topic</code> (name of the topic), <code>$marker</code> (which expands to <code>marker</code> for the item matching <code>selection</code> only) </td>
+    <td><code>"$topic"</code></td>
   </tr>
   <tr>
     <td><code>format="format"</code></td>
     <td> (Alternative to above) </td>
-    <td><code>"$name"</code></td>
+    <td><code>"$topic"</code></td>
   </tr>
   <tr>
     <td><code>separator=", "</code></td>
@@ -41,8 +41,8 @@
     <td> Current web </td>
   </tr>
 </table>
-- Example: `%TOPICLIST{"   * $web.$name"}%` creates a bullet list of all topics
+- 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>$name</option>"}%` creates an option list (for drop down menus)
-- Example: `<select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select>` creates an option list of web topics with the current topic selected
-- Related: [[SEARCH|Main/WebHome#VarSEARCH]], [[WEBLIST|Main/WebHome#VarWEBLIST]]
+- 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
+- Related: [[SEARCH|Main/VarSEARCH]], [[WEBLIST|Main/VarWEBLIST]]