summaryrefslogtreecommitdiff
path: root/TWiki
diff options
context:
space:
mode:
Diffstat (limited to 'TWiki')
-rw-r--r--TWiki/TWikiVariables.mdwn49
1 files changed, 47 insertions, 2 deletions
diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn
index 1bff7a29..3d202490 100644
--- a/TWiki/TWikiVariables.mdwn
+++ b/TWiki/TWikiVariables.mdwn
@@ -54,7 +54,52 @@ TWiki expands the following variables enclosed in % percent signs:
<td> Todays date, is <b>%DATE%</b></td>
</tr>
<tr>
- <td><code>%<nop>INCLUDE:"file.ext"%</nop></code></td>
- <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%<nop>INCLUDE:"../Know/TopicName.txt"%</nop></b></code></td>
+ <td><code>%<nop>INCLUDE{"file.ext"}%</nop></code></td>
+ <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%<nop>INCLUDE{"../Know/TopicName.txt"}%</nop></b></code></td>
+ </tr>
+ <tr>
+ <td><code>%<nop>SEARCH{"str" ...}%</nop></code></td>
+ <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="1" cellspacing="0">
+ <tr>
+ <th bgcolor="#99CCCC"><strong>Pair:</strong></th>
+ <th bgcolor="#99CCCC"><strong>Description:</strong></th>
+ <th bgcolor="#99CCCC"><strong>Default:</strong></th>
+ </tr>
+ <tr>
+ <td><code>web="Name"</code></td>
+ <td> Specify Wiki web to search </td>
+ <td> Current web </td>
+ </tr>
+ <tr>
+ <td><code>scope="topic"</code></td>
+ <td> Search topic name (title) </td>
+ <td> Topic text (body) </td>
+ </tr>
+ <tr>
+ <td><code>regex="on"</code></td>
+ <td><span style="background:"><font color="">Regular Expression</font></span><a href="http://LOCATION/RegularExpression">?</a> search </td>
+ <td> Literal search </td>
+ </tr>
+ <tr>
+ <td><code>casesensitive="on"</code></td>
+ <td> Case sensitive search </td>
+ <td> Ignore case </td>
+ </tr>
+ <tr>
+ <td><code>nosummary="on"</code></td>
+ <td> Show topic title only </td>
+ <td> Show topic summary </td>
+ </tr>
+ <tr>
+ <td><code>nosearch="on"</code></td>
+ <td> Suppress search string </td>
+ <td> Show search string </td>
+ </tr>
+ <tr>
+ <td><code>nototal="on"</code></td>
+ <td> Do not show number of topics found </td>
+ <td> Show number </td>
+ </tr>
+ </table> Example: <code><b>%<nop>SEARCH{"wiki" web="Main" scope="topic"}%</nop></b></code></td>
</tr>
</table>