none
[openafs-wiki.git] / TWiki / FormattedSearch.mdwn
index 640a5f3..56f82a1 100644 (file)
@@ -1,10 +1,7 @@
-**Formatted Search Using <code>**%SEARCH\{... format="..."\}%**</code> Variable**
-
 <div>
   <ul>
-    <li>
-      <ul>
-        <li><a href="#Preface"> Preface</a></li>
+    <li><a href="#TWiki Formatted Search Results"> TWiki Formatted Search Results</a><ul>
+        <li><a href="#Overview"> Overview</a></li>
         <li><a href="#Syntax"> Syntax</a></li>
         <li><a href="#Examples"> Examples</a><ul>
             <li><a href="#Bullet list showing topic name a"> Bullet list showing topic name and summary</a></li>
   </ul>
 </div>
 
-## <a name="Preface"></a> Preface
+# <a name="TWiki Formatted Search Results"></a> TWiki Formatted Search Results
+
+_Inline search feature allows flexible formatting of search result_
+
+## <a name="Overview"></a> Overview
 
-By default, the format for displaying a search result is fixed, e.g. a table with rows of topic name and topic summary. Use the `format="..."` parameter to specify a customized format of the search result. The string of the format parameter is typically a bullet list or table row containing variables (i.e. `%SEARCH{ "food" format="| $topic | $summary |" }%`).
+The `%SEARCH{...}%` variable documented in [[TWikiVariables]] has a fixed format for the search result, that is, a table consisting of topic names and topic summaries. Use the `format="..."` parameter to specify a customized format of the search result. The string of the format parameter is typically a bullet list or table row containing variables (such as `%SEARCH{ "food" format="| $topic | $summary |" }%`).
 
 ## <a name="Syntax"></a> Syntax
 
@@ -61,16 +62,20 @@ Variables that can be used in the format string:
     <td> Topic name </td>
   </tr>
   <tr>
+    <td><code>$text</code></td>
+    <td> Formatted topic text </td>
+  </tr>
+  <tr>
     <td><code>$locked</code></td>
     <td> LOCKED flag (if any) </td>
   </tr>
   <tr>
     <td><code>$date</code></td>
-    <td> Time stamp of last topic update, i.e. <code>29 Jun 2010 - 15:31</code></td>
+    <td> Time stamp of last topic update, i.e. <code>29 Jun 2010 - 15:34</code></td>
   </tr>
   <tr>
     <td><code>$isodate</code></td>
-    <td> Time stamp of last topic update, i.e. <code>2010-06-29T15:31Z</code></td>
+    <td> Time stamp of last topic update, i.e. <code>2010-06-29T15:34Z</code></td>
   </tr>
   <tr>
     <td><code>$rev</code></td>