buildrelease

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

diff --git a/TWiki/VarMETASEARCH.mdwn b/TWiki/VarMETASEARCH.mdwn
index 2feb968..feb5243 100644 (file)
--- a/TWiki/VarMETASEARCH.mdwn
+++ b/TWiki/VarMETASEARCH.mdwn
@@ -12,26 +12,26 @@
   <tr>
     <td><code>type="topicmoved"</code></td>
     <td> What sort of search is required? <br /><code>"topicmoved"</code> if search for a topic that may have been moved <br /><code>"parent"</code> if searching for topics that have a specific parent i.e. its children <br /><code>"field"</code> if searching for topics that have a particular form field value (use the <code>name</code> and <code>value</code> parameters to specify which field to search) </td>
-    <td> required </td>
+    <td> Required </td>
   </tr>
   <tr>
     <td><code>web="%WEB%"</code></td>
     <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. </td>
-    <td> current web </td>
+    <td> Current web </td>
   </tr>
   <tr>
     <td><code>topic="%TOPIC%"</code></td>
     <td> The topic the search relates to, for <code>topicmoved</code> and <code>parent</code> searches </td>
-    <td> current topic </td>
+    <td> All topics in a web </td>
   </tr>
   <tr>
     <td><code>name</code></td>
-    <td> form field to search, for <code>field</code> type searches. May be a regular expression (see [[Main/WebHome#VarSEARCH]]). </td>
+    <td> form field to search, for <code>field</code> type searches. May be a regular expression (see [[Main/VarSEARCH]]). </td>
     <td>   </td>
   </tr>
   <tr>
     <td><code>value</code></td>
-    <td> form field value, for <code>field</code> type searches. May be a regular expression (see [[Main/WebHome#VarSEARCH]]). </td>
+    <td> form field value, for <code>field</code> type searches. May be a regular expression (see [[Main/VarSEARCH]]). </td>
     <td>   </td>
   </tr>
   <tr>
@@ -40,15 +40,21 @@
     <td> empty </td>
   </tr>
   <tr>
+    <td><code>format="..."</code></td>
+    <td> Custom format results. Supports same format strings as [[Main/VarSEARCH]]. See <strong>[[Main/FormattedSearch]]</strong> for usage, variables &amp; examples </td>
+    <td> Results in table </td>
+  </tr>
+  <tr>
     <td><code>default="none"</code></td>
     <td> Default text shown if no search hit </td>
-    <td> empty </td>
+    <td> Empty </td>
   </tr>
 </table>
 - Example: `%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%`
 - Example: You may want to use this in [[WebTopicViewTemplate]] and [[WebTopicNonWikiTemplate]]:<br />`%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%`
 - Example: `%METASEARCH{type="field" name="Country" value="China"}%`
-- Related: [[SEARCH|Main/WebHome#VarSEARCH]], [[META|Main/WebHome#VarMETA]]
+- Related: [[SEARCH|Main/VarSEARCH]], [[META|Main/VarMETA]]
+- **_%X% Note:_** METASEARCH is deprecated in favour of the new and much more powerful query type search. See [[SEARCH|Main/VarSEARCH]] and [[QuerySearch]].
 
 **_Related Topics:_** [[UserDocumentationCategory]]