1c75e5adf68fc067f29fdb63eb3a222b0a96af9b
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 TWiki expands the following variables enclosed in % percent signs:
2
3 <table border="1">
4   <tr>
5     <th> Variable: </th>
6     <th> Expanded to: </th>
7   </tr>
8   <tr>
9     <td><code>%WIKIHOMEURL%</code></td>
10     <td> The base script URL of TWiki, link of Home icon in upper left corner is <b>%WIKIHOMEURL%</b></td>
11   </tr>
12   <tr>
13     <td><code>%SCRIPTURL%</code></td>
14     <td> The base script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
15   </tr>
16   <tr>
17     <td><code>%PUBURL%</code></td>
18     <td> The base public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
19   </tr>
20   <tr>
21     <td><code>%ATTACHURL%</code></td>
22     <td> The attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b><br /> Example: If you attach a file you can refer to it as <code><b>%ATTACHURL%/image.gif</b></code></td>
23   </tr>
24   <tr>
25     <td><code>%WIKIWEBMASTER%</code></td>
26     <td> The email address of the Wiki webmaster, is <b></b></td>
27   </tr>
28   <tr>
29     <td><code>%WIKITOOLNAME%</code></td>
30     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
31   </tr>
32   <tr>
33     <td><code>%WIKIVERSION%</code></td>
34     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
35   </tr>
36   <tr>
37     <td><code>%USERNAME%</code></td>
38     <td> Your login username, is <b>admin</b></td>
39   </tr>
40   <tr>
41     <td><code>%WIKIUSERNAME%</code></td>
42     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
43   </tr>
44   <tr>
45     <td><code>%WEB%</code></td>
46     <td> The current web, is <b>%WEB%</b></td>
47   </tr>
48   <tr>
49     <td><code>%TOPIC%</code></td>
50     <td> The current topic name, is <b>%TOPIC%</b></td>
51   </tr>
52   <tr>
53     <td><code>%DATE%</code></td>
54     <td> Todays date, is <b>29 Jun 2010</b></td>
55   </tr>
56   <tr>
57     <td><code>%INCLUDE{"file.ext"}%</code></td>
58     <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%INCLUDE{"../Know/TopicName.txt"}%</b></code></td>
59   </tr>
60   <tr>
61     <td><code>%SEARCH{"str" ...}%</code></td>
62     <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="0" cellspacing="0">
63         <tr>
64           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
65           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
66           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
67         </tr>
68         <tr>
69           <td><code>web="Name"</code></td>
70           <td> Specify Wiki web to search </td>
71           <td> Current web </td>
72         </tr>
73         <tr>
74           <td><code>scope="topic"</code></td>
75           <td> Search topic name (title) </td>
76           <td> Topic text (body) </td>
77         </tr>
78         <tr>
79           <td><code>regex="on"</code></td>
80           <td>[[Main/RegularExpression]] search </td>
81           <td> Literal search </td>
82         </tr>
83         <tr>
84           <td><code>casesensitive="on"</code></td>
85           <td> Case sensitive search </td>
86           <td> Ignore case </td>
87         </tr>
88         <tr>
89           <td><code>nosummary="on"</code></td>
90           <td> Show topic title only </td>
91           <td> Show topic summary </td>
92         </tr>
93         <tr>
94           <td><code>nosearch="on"</code></td>
95           <td> Suppress search string </td>
96           <td> Show search string </td>
97         </tr>
98         <tr>
99           <td><code>nototal="on"</code></td>
100           <td> Do not show number of topics found </td>
101           <td> Show number </td>
102         </tr>
103       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
104   </tr>
105 </table>