TWiki/FormattedSearch.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#TWiki Formatted Search Results"> TWiki Formatted Search Results</a><ul>
   4         <li><a href="#Syntax"> Syntax</a></li>
   5         <li><a href="#Examples"> Examples</a><ul>
   6             <li><a href="#Bullet list showing topic name a"> Bullet list showing topic name and summary</a></li>
   7           </ul>
   8         </li>
   9       </ul>
  10     </li>
  11     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
  12         <li>
  13           <ul>
  14             <li><a href="#Table showing form field values"> Table showing form field values of topics with a form</a></li>
  15             <li><a href="#Extract some text from a topic u"> Extract some text from a topic using regular expression</a></li>
  16           </ul>
  17         </li>
  18       </ul>
  19     </li>
  20     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
  21         <li>
  22           <ul>
  23             <li><a href="#Nested Search"> Nested Search</a></li>
  24           </ul>
  25         </li>
  26       </ul>
  27     </li>
  28     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
  29         <li>
  30           <ul>
  31             <li><a href="#Most recently changed pages"> Most recently changed pages</a></li>
  32           </ul>
  33         </li>
  34       </ul>
  35     </li>
  36     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
  37         <li>
  38           <ul>
  39             <li><a href="#Search with conditional output"> Search with conditional output</a></li>
  40           </ul>
  41         </li>
  42       </ul>
  43     </li>
  44     <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
  45         <li>
  46           <ul>
  47             <li><a href="#Embedding search forms to return"> Embedding search forms to return a formatted result</a></li>
  48           </ul>
  49         </li>
  50       </ul>
  51     </li>
  52     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
  53   </ul>
  54 </div>
  55
  56 # <a name="TWiki Formatted Search Results"></a> TWiki Formatted Search Results
  57
  58 _Inline search feature allows flexible formatting of search result_
  59
  60 The <code>[[%SEARCH{...}%|Main/TWikiVariables#VarSEARCH]]</code> 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 |" }%`).
  61
  62 ## <a name="Syntax"></a> Syntax
  63
  64 Two parameters can be used to specify a customized search result:
  65
  66 1. `header="..."` parameter
  67
  68 Use the header parameter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. <br /> Example: `header="| *Topic:* | *Summary:* |"`
  69
  70 2. `format="..."` parameter
  71
  72 Use the format parameter to specify the format of one search hit. <br /> Example: `format="| $topic | $summary |"`
  73
  74 Variables that can be used in the format string:
  75
  76 <table border="1" cellpadding="0" cellspacing="0">
  77   <tr>
  78     <th bgcolor="#99CCCC"><strong> Name: </strong></th>
  79     <th bgcolor="#99CCCC"><strong> Expands To: </strong></th>
  80   </tr>
  81   <tr>
  82     <td><code>$web</code></td>
  83     <td> Name of the web </td>
  84   </tr>
  85   <tr>
  86     <td><code>$topic</code></td>
  87     <td> Topic name </td>
  88   </tr>
  89   <tr>
  90     <td><code>$topic(20)</code></td>
  91     <td> Topic name, "<tt>- </tt>" hyphenated each 20 characters </td>
  92   </tr>
  93   <tr>
  94     <td><code>$topic(30, -&lt;br /&gt;)</code></td>
  95     <td> Topic name, hyphenated each 30 characters with separator "<tt>-&lt;br /&gt;</tt>" </td>
  96   </tr>
  97   <tr>
  98     <td><code>$topic(40, ...)</code></td>
  99     <td> Topic name, shortended to 40 characters with "<tt>...</tt>" indication </td>
 100   </tr>
 101   <tr>
 102     <td><code>$parent</code></td>
 103     <td> Name of parent topic; empty if not set </td>
 104   </tr>
 105   <tr>
 106     <td><code>$parent(20)</code></td>
 107     <td> Name of parent topic, same hyphenation/shortening like <code>$topic()</code></td>
 108   </tr>
 109   <tr>
 110     <td><code>$text</code></td>
 111     <td> Formatted topic text. In case of a <code>multiple="on"</code> search, it is the line found for each search hit. </td>
 112   </tr>
 113   <tr>
 114     <td><code>$locked</code></td>
 115     <td> LOCKED flag (if any) </td>
 116   </tr>
 117   <tr>
 118     <td><code>$date</code></td>
 119     <td> Time stamp of last topic update, e.g. <code>29 Jun 2010 - 15:46</code></td>
 120   </tr>
 121   <tr>
 122     <td><code>$isodate</code></td>
 123     <td> Time stamp of last topic update, e.g. <code>2010-06-29T15:46Z</code></td>
 124   </tr>
 125   <tr>
 126     <td><code>$rev</code></td>
 127     <td> Number of last topic revision, e.g. <code>1.4</code></td>
 128   </tr>
 129   <tr>
 130     <td><code>$username</code></td>
 131     <td> Login name of last topic update, e.g. <code>jsmith</code></td>
 132   </tr>
 133   <tr>
 134     <td><code>$wikiname</code></td>
 135     <td> Wiki user name of last topic update, e.g. <code>JohnSmith</code></td>
 136   </tr>
 137   <tr>
 138     <td><code>$wikiusername</code></td>
 139     <td> Wiki user name of last topic update, like <code>Main.JohnSmith</code></td>
 140   </tr>
 141   <tr>
 142     <td><code>$createdate</code></td>
 143     <td> Time stamp of topic revision 1.1 </td>
 144   </tr>
 145   <tr>
 146     <td><code>$createusername</code></td>
 147     <td> Login name of topic revision 1.1, e.g. <code>jsmith</code></td>
 148   </tr>
 149   <tr>
 150     <td><code>$createwikiname</code></td>
 151     <td> Wiki user name of topic revision 1.1, e.g. <code>JohnSmith</code></td>
 152   </tr>
 153   <tr>
 154     <td><code>$createwikiusername</code></td>
 155     <td> Wiki user name of topic revision 1.1, e.g. <code>Main.JohnSmith</code></td>
 156   </tr>
 157   <tr>
 158     <td><code>$summary</code></td>
 159     <td> Topic summary </td>
 160   </tr>
 161   <tr>
 162     <td><code>$formname</code></td>
 163     <td> The name of the form attached to the topic; empty if none </td>
 164   </tr>
 165   <tr>
 166     <td><code>$formfield(name)</code></td>
 167     <td> The field value of a form field; for example, <code>$formfield(TopicClassification)</code> would get expanded to <code>PublicFAQ</code>. This applies only to topics that have a [[Main/TWikiForms]]</td>
 168   </tr>
 169   <tr>
 170     <td><code>$formfield(name, 10)</code></td>
 171     <td> Form field value, "<tt>- </tt>" hyphenated each 10 characters </td>
 172   </tr>
 173   <tr>
 174     <td><code>$formfield(name, 20, -&lt;br /&gt;)</code></td>
 175     <td> Form field value, hyphenated each 20 characters with separator "<tt>-&lt;br /&gt;</tt>" </td>
 176   </tr>
 177   <tr>
 178     <td><code>$formfield(name, 30, ...)</code></td>
 179     <td> Form field value, shortended to 30 characters with "<tt>...</tt>" indication </td>
 180   </tr>
 181   <tr>
 182     <td><code>$pattern(reg-exp)</code></td>
 183     <td> A regular expression pattern to extract some text from a topic (does not search meta data; use <code>$formfield</code> instead). In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit.%BB% Specify a [[Main/RegularExpression]] that covers the whole text (topic or line), which typically starts with <code>.*</code>, and must end in <code>.*</code> %BB% Put text you want to keep in parenthesis, like <code>$pattern(.*?(from here.*?to here).*)</code> %BB% Example: <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the email address from a bullet of format <code>* Email: ...</code> %BB% This example has non-greedy <code>.*?</code> patterns to scan for the first occurance of the Email bullet; use greedy <code>.*</code> patterns to scan for the last occurance %BB% Limitation: Do not use <code>.*)</code> inside the pattern, e.g. <code>$pattern(.*foo(.*)bar.*)</code> does not work, but <code>$pattern(.*foo(.*?)bar.*)</code> does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag </td>
 184   </tr>
 185   <tr>
 186     <td><code>$n</code> or <code>$n()</code></td>
 187     <td> New line </td>
 188   </tr>
 189   <tr>
 190     <td><code>$nop</code> or <code>$nop()</code></td>
 191     <td> Is a "no operation". This variable gets removed; useful for nested search </td>
 192   </tr>
 193   <tr>
 194     <td><code>$quot</code></td>
 195     <td> Double quote (<code>"</code>). Alternatively write <code>\"</code> to escape it </td>
 196   </tr>
 197   <tr>
 198     <td><code>$percnt</code></td>
 199     <td> Percent sign (<code>%</code>) </td>
 200   </tr>
 201   <tr>
 202     <td><code>$dollar</code></td>
 203     <td> Dollar sign (<code>$</code>) </td>
 204   </tr>
 205 </table>
 206
 207 ## <a name="Examples"></a> Examples
 208
 209 <a name="SearchBulletList"></a>
 210
 211 ### <a name="Bullet list showing topic name a"></a> Bullet list showing topic name and summary
 212
 213 **Write this:**
 214
 215 `%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header="   * *Topic: Summary:*" format="   * [[$topic]]: $summary" }%`
 216
 217 **To get this:**
 218
 219 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 220
 221 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 222
 223 ### <a name="Table showing form field values"></a><a name="Table showing form field values "></a> Table showing form field values of topics with a form
 224
 225 In a web where there is a form that contains a `TopicClassification` field, an `OperatingSystem` field and an `OsVersion` field we could write:
 226
 227 `| *Topic:* | *OperatingSystem:* | *OsVersion:* |`<br />`%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%`
 228
 229 To get this:
 230
 231 <table border="1" cellpadding="1" cellspacing="0">
 232   <tr>
 233     <th bgcolor="#99CCCC"><strong>Topic:</strong></th>
 234     <th bgcolor="#99CCCC"><strong>OperatingSystem:</strong></th>
 235     <th bgcolor="#99CCCC"><strong>OsVersion:</strong></th>
 236   </tr>
 237   <tr>
 238     <td><a href="http://www.dementia.org/twiki//view/Sandbox/IncorrectDllVersionW32PTH10DLL">IncorrectDllVersionW32PTH10DLL</a></td>
 239     <td><a href="http://www.dementia.org/twiki//view/Sandbox/OsWin">OsWin</a></td>
 240     <td> 95/98 </td>
 241   </tr>
 242   <tr>
 243     <td><a href="http://www.dementia.org/twiki//view/Sandbox/WinDoze95Crash">WinDoze95Crash</a></td>
 244     <td><a href="http://www.dementia.org/twiki//view/Sandbox/OsWin">OsWin</a></td>
 245     <td> 95 </td>
 246   </tr>
 247 </table>
 248
 249 ### <a name="Extract some text from a topic u"></a> Extract some text from a topic using regular expression
 250
 251 **Write this:**
 252
 253 `%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%`
 254
 255 **To get this:**
 256
 257 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 258
 259 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 260
 261 ### <a name="Nested Search"></a> Nested Search
 262
 263 Search can be nested. For example, search for some topics, then form a new search for each topic found in the first search. The idea is to build the nested search string using a formatted search in the first search.
 264
 265 Here is an example. Let's search for all topics that contain the word "culture" (first search), and let's find out where each topic found is linked from (second search).
 266
 267 - First search:
 268   - `%SEARCH{ "culture" format="   * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%`
 269 - Second search. For each hit we want this search:
 270   - `%SEARCH{ "(topic found in first search)" format="$topic" nosearch="on" nototal="on" separator=", " }%`
 271 - Now let's nest the two. We need to escape the second search, e.g. the first search will build a valid second search string. Note that we escape the second search so that it does not get evaluated prematurely by the first search:
 272   - Use `$percnt` to escape the leading percent of the second search
 273   - Use `\"` to escape the double quotes
 274   - Use `$dollar` to escape the `$` of `$topic`
 275   - Use `$nop` to escape the `}%` sequence
 276
 277 **Write this:**
 278
 279 `%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%`
 280
 281 **To get this:**
 282
 283 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 284
 285 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 286
 287 **_Note:_** Nested search can be slow, especially if you nest more then 3 times. Nesting is limited to 16 levels. For each new nesting level you need to "escape the escapes", e.g. write `$dollarpercntSEARCH{` for level three, `$dollardollarpercntSEARCH{` for level four, etc.
 288
 289 ### <a name="Most recently changed pages"></a> Most recently changed pages
 290
 291 **Write this:**
 292
 293 `%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="| [[$topic]] | $wikiusername  | $date |" limit="7" }%`
 294
 295 **To get this:**
 296
 297 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 298
 299 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 300
 301 ### <a name="Search with conditional output"></a> Search with conditional output
 302
 303 A regular expression search is flexible, but there are limitations. For example, you cannot show all topics that are up to exactly one week old, or create a report that shows all records with invalid form fields or fields within a certain range, etc. You need some additional logic to format output based on a condition:
 304
 305 1. Specify a search which returns more hits then you need
 306 2. For each search hit apply a spreadsheet formula to determine if the hit is needed
 307 3. If needed, format and output the result
 308 4. Else supress the search hit
 309
 310 This requires the TWiki:Plugins.SpreadSheetPlugin. The following example shows all topics that are up to exactly one week old.
 311
 312 **Write this:**
 313
 314 `%CALC{$SET(weekold, $TIMEADD($TIME(), -7, day))}%` %BR% `%SEARCH{ "." scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on" format="$percntCALC{$IF($TIME($date) < $GET(weekold), <nop>, | [[$topic]] | $wikiusername | $date | $rev |)}$percnt" limit="100" }%`
 315
 316 - The first line sets the `weekold` variable to the serialized date of exactly one week ago
 317 - The SEARCH has a deferred CALC. The `$percnt` makes sure that the CALC gets executed once for each search hit
 318 - The CALC compares the date of the topic with the `weekold` date
 319 - If topic is older, a `<nop>` is returned, which gets removed at the end of the TWiki rendering process
 320 - Otherwise, the search hit is formatted and returned
 321
 322 **To get this:**
 323
 324 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 325
 326 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 327
 328 ### <a name="Embedding search forms to return"></a> Embedding search forms to return a formatted result
 329
 330 Use an HTML form and an embedded formatted search on the same topic. You can link them together with an `%URLPARAM{"..."}%` variable. Example:
 331
 332 **Write this:**
 333
 334     <form action="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%">
 335     Find Topics:
 336     <input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />
 337     <input type="submit" value="Search" />
 338     </form>
 339     Result:
 340     %SEARCH{ search="%URLPARAM{"q"}%" format="   * $web.$topic: %BR% $summary" nosearch="on" }%
 341
 342 **To get this:**
 343
 344 <form action="http://www.dementia.org/twiki//view/%WEB%/%TOPIC%"> Find Topics: <input name="q" size="32" type="text" value="" /> <input type="submit" value="Search" /></form>
 345
 346 Result:
 347
 348 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 349
 350 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 351
 352 -- TWiki:Main.PeterThoeny - 26 Jul 2004