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