none

1 files changed, 79 insertions, 12 deletions

diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn
index 062898fe..bc7aa01c 100644
--- a/TWiki/TWikiVariables.mdwn
+++ b/TWiki/TWikiVariables.mdwn
@@ -95,11 +95,58 @@
   </tr>
   <tr>
     <td><code>%<nop>TOPICLIST{"format"}%</nop></code></td>
-    <td> Topic index of a web. Parameter is composed of the format, followed by an optional <code>web="Name"</code>. The <code>"format"</code> defines the format of one topic item; use it to create any formatting you need. The <code>$name</code> variable is expanded to the topic name; the <code>$web</code> variable is expanded to the name of the web. Examples: <br /><code>%<nop>TOPICLIST{"   * $web.$name"}%</nop></code> creates a bullet list of all topics. <br /><code>%<nop>TOPICLIST{" &amp;lt;option&amp;gt;$name&amp;lt;/option&amp;gt;"}%</nop></code> creates an option list (for drop down menus). </td>
+    <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The <code>$name</code> variable gets expanded to the topic name; the <code>$web</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="1" cellspacing="0">
+        <tr>
+          <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Description:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Default:</strong></th>
+        </tr>
+        <tr>
+          <td><code>"format"</code></td>
+          <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
+          <td><code>"$name"</code></td>
+        </tr>
+        <tr>
+          <td><code>format="format"</code></td>
+          <td> (Alternative to above) </td>
+          <td><code>"$name"</code></td>
+        </tr>
+        <tr>
+          <td><code>separator=", "</code></td>
+          <td> line separator </td>
+          <td><code>"\n"</code> (new line) </td>
+        </tr>
+        <tr>
+          <td><code>web="Name"</code></td>
+          <td> Name of web </td>
+          <td> Current web </td>
+        </tr>
+      </table> Examples: <br /><code>%<nop>TOPICLIST{"   * $web.$name"}%</nop></code> creates a bullet list of all topics. <br /><code>%<nop>TOPICLIST{separator=", "}%</nop></code> creates a comma separated list of all topics. <br /><code>%<nop>TOPICLIST{" &amp;lt;option&amp;gt;$name&amp;lt;/option&amp;gt;"}%</nop></code> creates an option list (for drop down menus). </td>
   </tr>
   <tr>
     <td><code>%<nop>WEBLIST{"format"}%</nop></code></td>
-    <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable is expanded to the name of the web. Example: <br /><code>%<nop>WEBLIST{"   * [<nop>[$name.%HOMETOPIC%]]"}%</nop></nop></code> creates a bullet list of all webs. </td>
+    <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="1" cellspacing="0">
+        <tr>
+          <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Description:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Default:</strong></th>
+        </tr>
+        <tr>
+          <td><code>"format"</code></td>
+          <td> Format of one line, may include <code>$name</code> variable </td>
+          <td><code>"$name"</code></td>
+        </tr>
+        <tr>
+          <td><code>format="format"</code></td>
+          <td> (Alternative to above) </td>
+          <td><code>"$name"</code></td>
+        </tr>
+        <tr>
+          <td><code>separator=", "</code></td>
+          <td> line separator </td>
+          <td><code>"\n"</code> (new line) </td>
+        </tr>
+      </table> Example: <br /><code>%<nop>WEBLIST{"   * [<nop>[$name.%HOMETOPIC%]]"}%</nop></nop></code> creates a bullet list of all webs. </td>
   </tr>
   <tr>
     <td><code>%<nop>GMTIME%</nop></code></td>
@@ -181,7 +228,7 @@
   </tr>
   <tr>
     <td><code>%<nop>INCLUDE{"page" ...}%</nop></code></td>
-    <td> Server side include to <span style="background:"><font color="">Include Topics And Web Pages</font></span><a href="http://LOCATION/IncludeTopicsAndWebPages">?</a>. The parameter is composed of the page name, followed by an optional <code>pattern="(reg-exp)"</code> pair. The page name is: <table border="1" cellpadding="1" cellspacing="0">
+    <td> Server side include to <span style="background:"><font color="">Include Topics And Web Pages</font></span><a href="http://LOCATION/IncludeTopicsAndWebPages">?</a>. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="1" cellspacing="0">
         <tr>
           <td><code>"SomeTopic"</code></td>
           <td> The name of a topic located in the current web, i.e. <code>%<nop>INCLUDE{"WebNotify"}%</nop></code></td>
@@ -211,13 +258,18 @@
   </tr>
   <tr>
     <td><code>%<nop>TOC{"SomeTopic" ...}%</nop></code></td>
-    <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a> (<code>"---++ text"</code>) and HTML (<code>"&amp;lt;h2&amp;gt;text&amp;lt;h2&amp;gt;"</code>) are taken into account. Parameter is composed of the topic name, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="1" cellspacing="0">
+    <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a> (<code>"---++ text"</code>) and HTML (<code>"&amp;lt;h2&amp;gt;text&amp;lt;h2&amp;gt;"</code>) are taken into account. Parameters are topic name, web and depth: <table border="1" cellpadding="1" cellspacing="0">
         <tr>
-          <th bgcolor="#99CCCC"><strong>Pair:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
           <th bgcolor="#99CCCC"><strong>Description:</strong></th>
           <th bgcolor="#99CCCC"><strong>Default:</strong></th>
         </tr>
         <tr>
+          <td><code>"TopicName"</code></td>
+          <td> topic name </td>
+          <td> Current topic </td>
+        </tr>
+        <tr>
           <td><code>web="Name"</code></td>
           <td> Name of web </td>
           <td> Current web </td>
@@ -230,17 +282,22 @@
       </table> Examples: <code><b>%<nop>TOC{depth="2"}%</nop></b></code>, <code><b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%"}%</nop></b></code></td>
   </tr>
   <tr>
-    <td><code>%<nop>SEARCH{"str" ...}%</nop></code></td>
-    <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional <code>name="value"</code> pairs: [1] <table border="1" cellpadding="1" cellspacing="0">
+    <td><code>%<nop>SEARCH{"text" ...}%</nop></code></td>
+    <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] <table border="1" cellpadding="1" cellspacing="0">
         <tr>
-          <th bgcolor="#99CCCC"><strong>Pair:</strong></th>
+          <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
           <th bgcolor="#99CCCC"><strong>Description:</strong></th>
           <th bgcolor="#99CCCC"><strong>Default:</strong></th>
         </tr>
         <tr>
-          <td><code>search="food"</code></td>
-          <td> Search term, (either regex or literal, depending on the <code>regex</code> parameter) </td>
-          <td> (used if initial search term is missing) </td>
+          <td><code>"text"</code></td>
+          <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
+          <td> required </td>
+        </tr>
+        <tr>
+          <td><code>search="text"</code></td>
+          <td> (Alternative to above) </td>
+          <td> N/A </td>
         </tr>
         <tr>
           <td><code>web="Name"</code><br /><code>web="%MAINWEB% Know"</code><br /><code>web="all"</code></td>
@@ -379,6 +436,16 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
   </tr>
   <tr>
+    <td><code>%<nop>RELEASEEDITLOCKCHECKBOX%</nop></code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> Default state of the "Release edit lock" (<span style="background:"><font color="">Unlock Topic</font></span><a href="http://LOCATION/UnlockTopic">?</a>) check box in preview. Checkbox is initially checked if <code>Set RELEASEEDITLOCKCHECKBOX = checked="checked"</code>, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do <strong>not</strong> go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: <b><code>%RELEASEEDITLOCKCHECKBOX%</code></b></td>
+  </tr>
+  <tr>
+    <td><code>%<nop>DONTNOTIFYCHECKBOX%</nop></code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> Default state of the "Minor Changes, Don't Notify" (<span style="background:"><font color="">Dont Notify</font></span><a href="http://LOCATION/DontNotify">?</a>) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b></td>
+  </tr>
+  <tr>
     <td><code>%<nop>ATTACHLINKBOX%</nop></code></td>
     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
     <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to <code>CHECKED</code> , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: <b><code>%ATTACHLINKBOX%</code></b></td>
@@ -432,4 +499,4 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
 * Additional preferences variables can be defined on all three level as needed. Example:
   * <code>Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif</code>
 
--- [[PeterThoeny]] - 25 Jun 2001 <br />
+-- [[PeterThoeny]] - 14 Jul 2001 <br />