1 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
6 <th> Expanded to: </th>
9 <td><code>%WIKIHOMEURL%</code></td>
10 <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
13 <td><code>%SCRIPTURL%</code></td>
14 <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
17 <td><code>%SCRIPTURLPATH%</code></td>
18 <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
21 <td><code>%SCRIPTSUFFIX%</code></td>
22 <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
25 <td><code>%PUBURL%</code></td>
26 <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
29 <td><code>%PUBURLPATH%</code></td>
30 <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
33 <td><code>%ATTACHURL%</code></td>
34 <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>
37 <td><code>%ATTACHURLPATH%</code></td>
38 <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
41 <td><code>%WIKITOOLNAME%</code></td>
42 <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
45 <td><code>%WIKIVERSION%</code></td>
46 <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
49 <td><code>%USERNAME%</code></td>
50 <td> Your login username, is <b>admin</b></td>
53 <td><code>%WIKIUSERNAME%</code></td>
54 <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
57 <td><code>%WEB%</code></td>
58 <td> The current web, is <b>%WEB%</b></td>
61 <td><code>%TOPIC%</code></td>
62 <td> The current topic name, is <b>%TOPIC%</b></td>
65 <td><code>%SPACEDTOPIC%</code></td>
66 <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
69 <td><code>%GMTIME%</code></td>
70 <td> GM time, is <b>29 Jun 2010 - 15:25</b></td>
73 <td><code>%GMTIME{"format"}%</code></td>
74 <td> Formatted GM time based on keywords (first three characters needed.) <br /> Example: <code>%GMTIME{"day month, year - hour:min:sec"}%</code> is <b>day month, year - hour:min:sec</b></td>
77 <td><code>%SERVERTIME%</code></td>
78 <td> Server time, is <b>29 Jun 2010 - 11:25</b></td>
81 <td><code>%SERVERTIME{"format"}%</code></td>
82 <td> Formatted server time. Example: <code>%SERVERTIME{"hou:min"}%</code> is <b>hou:min</b></td>
85 <td><code>%HTTP_HOST%</code></td>
86 <td> HTTP_HOST environment variable, is <b></b></td>
89 <td><code>%REMOTE_ADDR%</code></td>
90 <td> REMOTE_ADDR environment variable, is <b></b></td>
93 <td><code>%REMOTE_PORT%</code></td>
94 <td> REMOTE_PORT environment variable, is <b></b></td>
97 <td><code>%REMOTE_USER%</code></td>
98 <td> REMOTE_USER environment variable, is <b></b></td>
101 <td><code>%INCLUDE{"SomeTopic"}%</code></td>
102 <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
105 <td><code>%STARTINCLUDE%</code></td>
106 <td> If present in included topic, start to include text from this location up to the end, or up to the location of the <code>%STOPINCLUDE%</code> variable. A normal view of the topic shows everyting exept the <code>%STARTINCLUDE%</code> variable itself. </td>
109 <td><code>%STOPINCLUDE%</code></td>
110 <td> If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the <code>%STOPINCLUDE%</code> variable itself. </td>
113 <td><code>%SEARCH{"str" ...}%</code></td>
114 <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">
116 <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
117 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
118 <th bgcolor="#99CCCC"><strong> Default: </strong></th>
121 <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
122 <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[1]</code></td>
123 <td> Current web </td>
126 <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
127 <td> Search topic name (title) or in the text (body) of the topic </td>
128 <td> Topic text (body) </td>
131 <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
132 <td> Sort the results of search by the topic names, last modified time, or last editor </td>
133 <td> Sort by topic name </td>
136 <td><code>limit="all"</code><br /><code>limit="16"</code></td>
137 <td> Limit the number of results returned </td>
138 <td> All results </td>
141 <td><code>regex="on"</code></td>
142 <td>[[Main/RegularExpression]] search </td>
143 <td> Literal search </td>
146 <td><code>reverse="on"</code></td>
147 <td> Reverse the direction of the search </td>
148 <td> Ascending search </td>
151 <td><code>casesensitive="on"</code></td>
152 <td> Case sensitive search </td>
153 <td> Ignore case </td>
156 <td><code>nosummary="on"</code></td>
157 <td> Show topic title only </td>
158 <td> Show topic summary </td>
161 <td><code>bookview="on"</code></td>
162 <td>[[Main/BookView]] search, e.g. show complete topic text </td>
163 <td> Show topic summary </td>
166 <td><code>nosearch="on"</code></td>
167 <td> Suppress search string </td>
168 <td> Show search string </td>
171 <td><code>noheader="on"</code></td>
172 <td> Suppress search header <br /><span style="background: #FFB0B0">Topics: Changed: By: </span></td>
173 <td> Show search header </td>
176 <td><code>nototal="on"</code></td>
177 <td> Do not show number of topics found </td>
178 <td> Show number </td>
180 </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
183 <td><code>%VAR{"NAME" web="Web"}%</code></td>
184 <td> Get a preference value from another web then the current one. Example: To get <code>%WEBBGCOLOR%</code> of the Main web write <code>%VAR{"WEBBGCOLOR" web="Main"}%</code>, is <code><b></b></code></td>
192 [1] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
194 Additional variables are defined in the preferences ( site-level ( **_SL_** ) in [[TWikiPreferences]], web-level ( **_WL_** ) in [[WebPreferences]] of each web, and user level ( **_UL_** ) preferences in individual user topics):
203 <td><code>%WIKIWEBMASTER%</code></td>
204 <td><strong><em>SL</em></strong></td>
205 <td> Webmaster email address (sender of email notifications) , is <b></b></td>
208 <td><code>%WIKIWEBLIST%</code></td>
209 <td><strong><em>SL</em></strong></td>
210 <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
213 <td><code>%WEBTOPICLIST%</code></td>
214 <td><strong><em>WL</em></strong></td>
215 <td> Common links of web (second line of topics) </td>
218 <td><code>%WEBCOPYRIGHT%</code></td>
219 <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
220 <td> Copyright notice (bottom right corner of topics) </td>
223 <td><code>%WEBBGCOLOR%</code></td>
224 <td><strong><em>WL</em></strong></td>
225 <td> Background color of web </td>
228 <td><code>%NOSEARCHALL%</code></td>
229 <td><strong><em>WL</em></strong></td>
230 <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
233 <td><code>%NEWTOPICBGCOLOR%</code></td>
234 <td><strong><em>SL</em></strong> , <em>UL</em></td>
235 <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
238 <td><code>%NEWTOPICFONTCOLOR%</code></td>
239 <td><strong><em>SL</em></strong> , <em>UL</em></td>
240 <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
243 <td><code>%EDITBOXWIDTH%</code></td>
244 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
245 <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
248 <td><code>%EDITBOXHEIGHT%</code></td>
249 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
250 <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
253 <td><code>%ATTACHLINKBOX%</code></td>
254 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
255 <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to <code>CHECKED</code> , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: <b><code>%ATTACHLINKBOX%</code></b></td>
258 <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
259 <td><strong><em>SL</em></strong></td>
260 <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
263 <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
264 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
265 <td> http-equiv meta tags for edit script. </td>
268 <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
269 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
270 <td> http-equiv meta tags for preview script. </td>
273 <td><code>%DENYWEBCHANGE%</code></td>
274 <td><strong><em>WL</em></strong></td>
275 <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
278 <td><code>%ALLOWWEBCHANGE%</code></td>
279 <td><strong><em>WL</em></strong></td>
280 <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
283 <td><code>%DENYTOPICCHANGE%</code></td>
284 <td><strong><em>(any topic)</em></strong></td>
285 <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
288 <td><code>%ALLOWTOPICCHANGE%</code></td>
289 <td><strong><em>(any topic)</em></strong></td>
290 <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
293 <td><code>%FINALPREFERENCES%</code></td>
294 <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
295 <td> List of preferences that are not allowed to be overridden by next level preferences</td>
301 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
302 - `Set VARIABLENAME = value`
303 - Additional preferences variables can be defined on all three level as needed. Example:
304 - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
306 -- [[PeterThoeny]] - 10 Nov 2000 <br />