From b5260209f0ceee1d577f8447a761bdb7873406ae Mon Sep 17 00:00:00 2001
From: Peter Thoeny <web-hurd@gnu.org>
Date: Fri, 18 Aug 2000 07:12:18 +0000
Subject: none

---
 TWiki/TWikiVariables.mdwn | 58 +++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 51 insertions(+), 7 deletions(-)

(limited to 'TWiki')

diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn
index ca02a36e..aa715b3c 100644
--- a/TWiki/TWikiVariables.mdwn
+++ b/TWiki/TWikiVariables.mdwn
@@ -90,8 +90,8 @@ TWiki expands the following variables enclosed in % percent signs:
     <td> REMOTE_USER environment variable, is <b>%REMOTE_USER%</b></td>
   </tr>
   <tr>
-    <td><code>%<nop>INCLUDE{"file.ext"}%</nop></code></td>
-    <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%<nop>INCLUDE{"../Know/TopicName.txt"}%</nop></b></code></td>
+    <td><code>%<nop>INCLUDE{"SomeTopic"}%</nop></code></td>
+    <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%<nop>INCLUDE{"TWiki.TWikiWebsTable"}%</nop></b></code></td>
   </tr>
   <tr>
     <td><code>%<nop>SEARCH{"str" ...}%</nop></code></td>
@@ -102,20 +102,35 @@ TWiki expands the following variables enclosed in % percent signs:
           <th bgcolor="#99CCCC"><strong>Default:</strong></th>
         </tr>
         <tr>
-          <td><code>web="Name"</code></td>
-          <td> Specify Wiki web to search </td>
+          <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
+          <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[1]</code></td>
           <td> Current web </td>
         </tr>
         <tr>
-          <td><code>scope="topic"</code></td>
-          <td> Search topic name (title) </td>
+          <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
+          <td> Search topic name (title) or in the text (body) of the topic </td>
           <td> Topic text (body) </td>
         </tr>
+        <tr>
+          <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
+          <td> Sort the results of search by the topic names, last modified time, or last editor </td>
+          <td> Sort by topic name </td>
+        </tr>
+        <tr>
+          <td><code>limit="all"</code><br /><code>limit="16"</code></td>
+          <td> Limit the number of results returned </td>
+          <td> All results </td>
+        </tr>
         <tr>
           <td><code>regex="on"</code></td>
           <td><span style="background:"><font color="">Regular Expression</font></span><a href="http://LOCATION/RegularExpression">?</a> search </td>
           <td> Literal search </td>
         </tr>
+        <tr>
+          <td><code>reverse="on"</code></td>
+          <td> Reverse the direction of the search </td>
+          <td> Ascending search </td>
+        </tr>
         <tr>
           <td><code>casesensitive="on"</code></td>
           <td> Case sensitive search </td>
@@ -126,6 +141,11 @@ TWiki expands the following variables enclosed in % percent signs:
           <td> Show topic title only </td>
           <td> Show topic summary </td>
         </tr>
+        <tr>
+          <td><code>bookview="on"</code></td>
+          <td><span style="background:"><font color="">Book View</font></span><a href="http://LOCATION/BookView">?</a> search, e.g. show complete topic text </td>
+          <td> Show topic summary </td>
+        </tr>
         <tr>
           <td><code>nosearch="on"</code></td>
           <td> Suppress search string </td>
@@ -140,6 +160,8 @@ TWiki expands the following variables enclosed in % percent signs:
   </tr>
 </table>
 
+[1] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
+
 Additional variables are defined in the preferences ( site-level ( **_SL_** ) in %TWIKIWEB%.%WIKIPREFSTOPIC%, web-level ( **_WL_** ) in %WEBPREFSTOPIC% of each web, and user level ( **_UL_** ) preferences in individual user topics):
 
 <table border="1">
@@ -173,6 +195,11 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
     <td><strong><em>WL</em></strong></td>
     <td> Background color of web </td>
   </tr>
+  <tr>
+    <td><code>%<nop>NOSEARCHALL%</nop></code></td>
+    <td><strong><em>WL</em></strong></td>
+    <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
+  </tr>
   <tr>
     <td><code>%<nop>EDITBOXWIDTH%</nop></code></td>
     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
@@ -188,6 +215,23 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
     <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>
   </tr>
+  <tr>
+    <td><code>%<nop>HTTP_EQUIV_ON_VIEW%</nop></code></td>
+    <td><strong><em>SL</em></strong></td>
+    <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
+  </tr>
+  <tr>
+    <td><code>%<nop>HTTP_EQUIV_ON_EDIT%</nop></code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> http-equiv meta tags for edit script. </td>
+  </tr>
+  <tr>
+  </tr>
+  <tr>
+    <td><code>%<nop>HTTP_EQUIV_ON_PREVIEW%</nop></code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> http-equiv meta tags for preview script. </td>
+  </tr>
 </table>
 
--- [[Main/PeterThoeny]] - 29 May 2000 <br />
+-- [[Main/PeterThoeny]] - 17 Aug 2000 <br />
-- 
cgit v1.2.3