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></li>
  37   </ul>
  38 </div>
  39
  40 # <a name="TWiki Formatted Search Results"></a> TWiki Formatted Search Results
  41
  42 _Inline search feature allows flexible formatting of search result_
  43
  44 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 |" }%`).
  45
  46 ## <a name="Syntax"></a> Syntax
  47
  48 Two parameters can be used to specify a customized search result:
  49
  50 1. `header="..."` parameter
  51
  52 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:* |"`
  53
  54 2. `format="..."` parameter
  55
  56 Use the format parameter to specify the format of one search hit. <br /> Example: `format="| $topic | $summary |"`
  57
  58 Variables that can be used in the format string:
  59
  60 <table border="1" cellpadding="0" cellspacing="0">
  61   <tr>
  62     <th bgcolor="#99CCCC"><strong> Name: </strong></th>
  63     <th bgcolor="#99CCCC"><strong> Expands To: </strong></th>
  64   </tr>
  65   <tr>
  66     <td><code>$web</code></td>
  67     <td> Name of the web(s), separated by commas, or 'all' </td>
  68   </tr>
  69   <tr>
  70     <td><code>$topic</code></td>
  71     <td> Topic name </td>
  72   </tr>
  73   <tr>
  74     <td><code>$topic(20)</code></td>
  75     <td> Topic name, "<tt>- </tt>" hyphenated each 20 characters </td>
  76   </tr>
  77   <tr>
  78     <td><code>$topic(30, -&lt;br /&gt;)</code></td>
  79     <td> Topic name, hyphenated each 30 characters with separator "<tt>-&lt;br /&gt;</tt>" </td>
  80   </tr>
  81   <tr>
  82     <td><code>$topic(40, ...)</code></td>
  83     <td> Topic name, shortended to 40 characters with "<tt>...</tt>" indication </td>
  84   </tr>
  85   <tr>
  86     <td><code>$text</code></td>
  87     <td> Formatted topic text. In case of a <code>multiple="on"</code> search, it is the line found for each search hit. </td>
  88   </tr>
  89   <tr>
  90     <td><code>$locked</code></td>
  91     <td> LOCKED flag (if any) </td>
  92   </tr>
  93   <tr>
  94     <td><code>$date</code></td>
  95     <td> Time stamp of last topic update, like <code>29 Jun 2010 - 15:43</code></td>
  96   </tr>
  97   <tr>
  98     <td><code>$isodate</code></td>
  99     <td> Time stamp of last topic update, like <code>2010-06-29T15:43Z</code></td>
 100   </tr>
 101   <tr>
 102     <td><code>$rev</code></td>
 103     <td> Number of last topic revision, like <code>1.4</code></td>
 104   </tr>
 105   <tr>
 106     <td><code>$username</code></td>
 107     <td> Login name of last topic update, like <code>jsmith</code></td>
 108   </tr>
 109   <tr>
 110     <td><code>$wikiname</code></td>
 111     <td> Wiki user name of last topic update, like <code>JohnSmith</code></td>
 112   </tr>
 113   <tr>
 114     <td><code>$wikiusername</code></td>
 115     <td> Wiki user name of last topic update, like <code>Main.JohnSmith</code></td>
 116   </tr>
 117   <tr>
 118     <td><code>$summary</code></td>
 119     <td> Topic summary </td>
 120   </tr>
 121   <tr>
 122     <td><code>$formfield(name)</code></td>
 123     <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>
 124   </tr>
 125   <tr>
 126     <td><code>$formfield(name, 10)</code></td>
 127     <td> Form field value, "<tt>- </tt>" hyphenated each 10 characters </td>
 128   </tr>
 129   <tr>
 130     <td><code>$formfield(name, 20, -&lt;br /&gt;)</code></td>
 131     <td> Form field value, hyphenated each 20 characters with separator "<tt>-&lt;br /&gt;</tt>" </td>
 132   </tr>
 133   <tr>
 134     <td><code>$formfield(name, 30, ...)</code></td>
 135     <td> Form field value, shortended to 30 characters with "<tt>...</tt>" indication </td>
 136   </tr>
 137   <tr>
 138     <td><code>$pattern(reg-exp)</code></td>
 139     <td> A regular expression pattern to extract some text from a topic. In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit. For example, <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the email address from a bullet of format <code>* Email: ...</code>. </td>
 140   </tr>
 141   <tr>
 142     <td><code>$n</code> or <code>$n()</code></td>
 143     <td> New line </td>
 144   </tr>
 145   <tr>
 146     <td><code>$nop</code> or <code>$nop()</code></td>
 147     <td> Is a "no operation". This variable gets removed; useful for nested search </td>
 148   </tr>
 149   <tr>
 150     <td><code>$quot</code></td>
 151     <td> Double quote (<code>"</code>). Alternatively write <code>\"</code> to escape it </td>
 152   </tr>
 153   <tr>
 154     <td><code>$percnt</code></td>
 155     <td> Percent sign (<code>%</code>) </td>
 156   </tr>
 157   <tr>
 158     <td><code>$dollar</code></td>
 159     <td> Dollar sign (<code>$</code>) </td>
 160   </tr>
 161 </table>
 162
 163 **_Note:_** For `$pattern(reg-exp)`, specify a [[RegularExpression]] that scans from start to end and contains the text you want to keep in parenthesis, like `$pattern(.*?(from here.*?to here).*)`. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table make sure to include everything including the table end tag.
 164
 165 ## <a name="Examples"></a> Examples
 166
 167 <a name="SearchBulletList"></a>
 168
 169 ### <a name="Bullet list showing topic name a"></a> Bullet list showing topic name and summary
 170
 171 **Write this:**
 172
 173 `%SEARCH{ "FAQ" scope="topic" nosearch="on" nototal="on" header="   * *Topic: Summary:*" format="   * [[$topic]]: $summary" }%`
 174
 175 **To get this:**
 176
 177 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 178
 179 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 180
 181 ### <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
 182
 183 **Write this in the Know web:**
 184
 185 `| *Topic:* | *OperatingSystem:* | *OsVersion:* |`<br />`%SEARCH{ "[T]opicClassification.*?value=\"[P]ublicFAQ\"" scope="text" regex="on" nosearch="on" nototal="on" format="| [[$topic]] | $formfield(OperatingSystem) | $formfield(OsVersion) |" }%`
 186
 187 **To get this:**
 188
 189 <table border="1" cellpadding="1" cellspacing="0">
 190   <tr>
 191     <th bgcolor="#99CCCC"><strong>Topic:</strong></th>
 192     <th bgcolor="#99CCCC"><strong>OperatingSystem:</strong></th>
 193     <th bgcolor="#99CCCC"><strong>OsVersion:</strong></th>
 194   </tr>
 195   <tr>
 196     <td><a href="http://www.dementia.org/twiki//view/Know/IncorrectDllVersionW32PTH10DLL">IncorrectDllVersionW32PTH10DLL</a></td>
 197     <td><a href="http://www.dementia.org/twiki//view/Know/OsWin">OsWin</a></td>
 198     <td> 95/98 </td>
 199   </tr>
 200   <tr>
 201     <td><a href="http://www.dementia.org/twiki//view/Know/WinDoze95Crash">WinDoze95Crash</a></td>
 202     <td><a href="http://www.dementia.org/twiki//view/Know/OsWin">OsWin</a></td>
 203     <td> 95 </td>
 204   </tr>
 205 </table>
 206
 207 ### <a name="Extract some text from a topic u"></a> Extract some text from a topic using regular expression
 208
 209 **Write this:**
 210
 211 `%SEARCH{ "__Back to\:__ TWikiFAQ" scope="text" regex="on" nosearch="on" nototal="on" header="TWiki FAQs:" format="   * $pattern(.*?FAQ\:[\n\r]*([^\n\r]+).*) [[$topic][Answer...]]" }%`
 212
 213 **To get this:**
 214
 215 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 216
 217 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 218
 219 ### <a name="Nested Search"></a> Nested Search
 220
 221 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.
 222
 223 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).
 224
 225 - First search:
 226   - `%SEARCH{ "culture" format="   * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%`
 227 - Second search. For each hit we want this search:
 228   - `%SEARCH{ "(topic found in first search)" format="   $topic" nosearch="on" nototal="on" }%`
 229 - 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:
 230   - Use `$percnt` to escape the leading percent of the second search
 231   - Use `\"` to escape the double quotes
 232   - Use `$dollar` to escape the `$` of `$topic`
 233   - Use `$nop` to escape the `}%` sequence
 234
 235 **Write this:**
 236
 237 `%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"   $dollartopic\" nosearch=\"on\" nototal=\"on\" }$nop%" nosearch="on" nototal="on" }%`
 238
 239 **To get this:**
 240
 241 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 242
 243 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 244
 245 ### <a name="Most recently changed pages"></a> Most recently changed pages
 246
 247 **Write this:**
 248
 249 `%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" nototal="on" order="modified" reverse="on"  format="| [[$topic]] | $wikiusername  | $date |" limit="7" }%`
 250
 251 **To get this:**
 252
 253 # <a name="TWiki Installation Error"></a> TWiki Installation Error
 254
 255 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 256
 257 -- TWiki:Main.PeterThoeny - 15 Dec 2003