none
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 ## <a name="TWiki Variables"></a> TWiki Variables
2
3 ### <a name="Predefined Variables"></a> Predefined Variables
4
5 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
6
7 <table border="1">
8   <tr>
9     <th> Variable: </th>
10     <th> Expanded to: </th>
11   </tr>
12   <tr>
13     <td><code>%WIKIHOMEURL%</code></td>
14     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
15   </tr>
16   <tr>
17     <td><code>%SCRIPTURL%</code></td>
18     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
19   </tr>
20   <tr>
21     <td><code>%SCRIPTURLPATH%</code></td>
22     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
23   </tr>
24   <tr>
25     <td><code>%SCRIPTSUFFIX%</code></td>
26     <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
27   </tr>
28   <tr>
29     <td><code>%PUBURL%</code></td>
30     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
31   </tr>
32   <tr>
33     <td><code>%PUBURLPATH%</code></td>
34     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
35   </tr>
36   <tr>
37     <td><code>%ATTACHURL%</code></td>
38     <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>
39   </tr>
40   <tr>
41     <td><code>%ATTACHURLPATH%</code></td>
42     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
43   </tr>
44   <tr>
45     <td><code>%URLPARAM{"name"}%</code></td>
46     <td> Returns the value of a URL parameter. I.e. <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b></b></td>
47   </tr>
48   <tr>
49     <td><code>%WIKITOOLNAME%</code></td>
50     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
51   </tr>
52   <tr>
53     <td><code>%WIKIVERSION%</code></td>
54     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
55   </tr>
56   <tr>
57     <td><code>%USERNAME%</code></td>
58     <td> Your login username, is <b>admin</b></td>
59   </tr>
60   <tr>
61     <td><code>%WIKIUSERNAME%</code></td>
62     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
63   </tr>
64   <tr>
65     <td><code>%WEB%</code></td>
66     <td> The current web, is <b>%WEB%</b></td>
67   </tr>
68   <tr>
69     <td><code>%BASEWEB%</code></td>
70     <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as <code>%WEB%</code> in case there is no include. </td>
71   </tr>
72   <tr>
73     <td><code>%INCLUDINGWEB%</code></td>
74     <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
75   </tr>
76   <tr>
77     <td><code>%TOPIC%</code></td>
78     <td> The current topic name, is <b>%TOPIC%</b></td>
79   </tr>
80   <tr>
81     <td><code>%BASETOPIC%</code></td>
82     <td> The name of the topic where the includes started, e.g. the first topic of nested includes. Same as <code>%TOPIC%</code> in case there is no include. </td>
83   </tr>
84   <tr>
85     <td><code>%INCLUDINGTOPIC%</code></td>
86     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
87   </tr>
88   <tr>
89     <td><code>%SPACEDTOPIC%</code></td>
90     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
91   </tr>
92   <tr>
93     <td><code>%TOPICLIST{"format"}%</code></td>
94     <td> Topic index of a web. Parameter is composed of the format, followed by an optional <code>web="Name"</code>. The <code>"format"</code> defines the format of one topic item; use it to create any formatting you need. The <code>$name</code> variable is expanded to the topic name; the <code>$web</code> variable is expanded to the name of the web. Examples: <br /><code>%TOPICLIST{"   * $web.$name"}%</code> creates a bullet list of all topics. <br /><code>%TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%</code> creates an option list (for drop down menus). </td>
95   </tr>
96   <tr>
97     <td><code>%WEBLIST{"format"}%</code></td>
98     <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable is expanded to the name of the web. Example: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. </td>
99   </tr>
100   <tr>
101     <td><code>%GMTIME%</code></td>
102     <td> GM time, is <b>29 Jun 2010 - 15:26</b></td>
103   </tr>
104   <tr>
105     <td><code>%GMTIME{"format"}%</code></td>
106     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
107         <tr>
108           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
109           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
110           <th bgcolor="#99CCCC"><strong> Example </strong></th>
111         </tr>
112         <tr>
113           <td> $seconds </td>
114           <td> seconds </td>
115           <td> 59 </td>
116         </tr>
117         <tr>
118           <td> $minutes </td>
119           <td> minutes </td>
120           <td> 59 </td>
121         </tr>
122         <tr>
123           <td> $hours </td>
124           <td> hours </td>
125           <td> 23 </td>
126         </tr>
127         <tr>
128           <td> $day </td>
129           <td> day of month </td>
130           <td> 31 </td>
131         </tr>
132         <tr>
133           <td> $month </td>
134           <td> month in ISO format </td>
135           <td> Dec </td>
136         </tr>
137         <tr>
138           <td> $mo </td>
139           <td> 2 digit month </td>
140           <td> 12 </td>
141         </tr>
142         <tr>
143           <td> $year </td>
144           <td> 4 digit year </td>
145           <td> 1999 </td>
146         </tr>
147         <tr>
148           <td> $ye </td>
149           <td> 2 digit year </td>
150           <td> 99 </td>
151         </tr>
152       </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:26:32</b></td>
153   </tr>
154   <tr>
155     <td><code>%SERVERTIME%</code></td>
156     <td> Server time, is <b>29 Jun 2010 - 11:26</b></td>
157   </tr>
158   <tr>
159     <td><code>%SERVERTIME{"format"}%</code></td>
160     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:26</b></td>
161   </tr>
162   <tr>
163     <td><code>%HTTP_HOST%</code></td>
164     <td> HTTP_HOST environment variable, is <b></b></td>
165   </tr>
166   <tr>
167     <td><code>%REMOTE_ADDR%</code></td>
168     <td> REMOTE_ADDR environment variable, is <b></b></td>
169   </tr>
170   <tr>
171     <td><code>%REMOTE_PORT%</code></td>
172     <td> REMOTE_PORT environment variable, is <b></b></td>
173   </tr>
174   <tr>
175     <td><code>%REMOTE_USER%</code></td>
176     <td> REMOTE_USER environment variable, is <b></b></td>
177   </tr>
178   <tr>
179     <td><code>%INCLUDE{"SomeTopic"}%</code></td>
180     <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
181   </tr>
182   <tr>
183     <td><code>%STARTINCLUDE%</code></td>
184     <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>
185   </tr>
186   <tr>
187     <td><code>%STOPINCLUDE%</code></td>
188     <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>
189   </tr>
190   <tr>
191     <td><code>%TOC%</code></td>
192     <td> Table of Content of current topic. </td>
193   </tr>
194   <tr>
195     <td><code>%TOC{"SomeTopic" ...}%</code></td>
196     <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] (<code>"---++ text"</code>) and HTML (<code>"&lt;h2&gt;text&lt;h2&gt;"</code>) are taken into account. Parameter is composed of the topic name, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
197         <tr>
198           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
199           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
200           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
201         </tr>
202         <tr>
203           <td><code>web="Name"</code></td>
204           <td> Name of web </td>
205           <td> Current web </td>
206         </tr>
207         <tr>
208           <td><code>depth="2"</code></td>
209           <td> Limit depth of headings shown in TOC </td>
210           <td> 6 </td>
211         </tr>
212       </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
213   </tr>
214   <tr>
215     <td><code>%SEARCH{"str" ...}%</code></td>
216     <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional <code>name="value"</code> pairs: [1] <table border="1" cellpadding="0" cellspacing="0">
217         <tr>
218           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
219           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
220           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
221         </tr>
222         <tr>
223           <td><code>search="food"</code></td>
224           <td> Search term, (either regex or literal, depending on the <code>regex</code> parameter) </td>
225           <td> (used if initial search term is missing) </td>
226         </tr>
227         <tr>
228           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
229           <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[2]</code></td>
230           <td> Current web </td>
231         </tr>
232         <tr>
233           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
234           <td> Search topic name (title) or in the text (body) of the topic </td>
235           <td> Topic text (body) </td>
236         </tr>
237         <tr>
238           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
239           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
240           <td> Sort by topic name </td>
241         </tr>
242         <tr>
243           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
244           <td> Limit the number of results returned </td>
245           <td> All results </td>
246         </tr>
247         <tr>
248           <td><code>regex="on"</code></td>
249           <td>[[Main/RegularExpression]] search </td>
250           <td> Literal search </td>
251         </tr>
252         <tr>
253           <td><code>reverse="on"</code></td>
254           <td> Reverse the direction of the search </td>
255           <td> Ascending search </td>
256         </tr>
257         <tr>
258           <td><code>casesensitive="on"</code></td>
259           <td> Case sensitive search </td>
260           <td> Ignore case </td>
261         </tr>
262         <tr>
263           <td><code>nosummary="on"</code></td>
264           <td> Show topic title only </td>
265           <td> Show topic summary </td>
266         </tr>
267         <tr>
268           <td><code>bookview="on"</code></td>
269           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
270           <td> Show topic summary </td>
271         </tr>
272         <tr>
273           <td><code>nosearch="on"</code></td>
274           <td> Suppress search string </td>
275           <td> Show search string </td>
276         </tr>
277         <tr>
278           <td><code>noheader="on"</code></td>
279           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
280           <td> Show search header </td>
281         </tr>
282         <tr>
283           <td><code>nototal="on"</code></td>
284           <td> Do not show number of topics found </td>
285           <td> Show number </td>
286         </tr>
287       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
288   </tr>
289   <tr>
290     <td><code>%VAR{"NAME" web="Web"}%</code></td>
291     <td> Get a preference value from a web other 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>
292     <td>
293       <p>
294       </p>
295     </td>
296   </tr>
297 </table>
298
299 [1] **_Note_**: The search form uses identical names for input fields.
300
301 [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
302
303 ### <a name="Preferences Variables"></a> Preferences Variables
304
305 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):
306
307 <table border="1">
308   <tr>
309     <th> Variable: </th>
310     <th> Level: </th>
311     <th> What: </th>
312   </tr>
313   <tr>
314     <td><code>%WIKIWEBMASTER%</code></td>
315     <td><strong><em>SL</em></strong></td>
316     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
317   </tr>
318   <tr>
319     <td><code>%WIKIWEBLIST%</code></td>
320     <td><strong><em>SL</em></strong></td>
321     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
322   </tr>
323   <tr>
324     <td><code>%WEBTOPICLIST%</code></td>
325     <td><strong><em>WL</em></strong></td>
326     <td> Common links of web (second line of topics) </td>
327   </tr>
328   <tr>
329     <td><code>%WEBCOPYRIGHT%</code></td>
330     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
331     <td> Copyright notice (bottom right corner of topics) </td>
332   </tr>
333   <tr>
334     <td><code>%WEBBGCOLOR%</code></td>
335     <td><strong><em>WL</em></strong></td>
336     <td> Background color of web </td>
337   </tr>
338   <tr>
339     <td><code>%NOSEARCHALL%</code></td>
340     <td><strong><em>WL</em></strong></td>
341     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
342   </tr>
343   <tr>
344     <td><code>%NEWTOPICBGCOLOR%</code></td>
345     <td><strong><em>SL</em></strong> , <em>UL</em></td>
346     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
347   </tr>
348   <tr>
349     <td><code>%NEWTOPICFONTCOLOR%</code></td>
350     <td><strong><em>SL</em></strong> , <em>UL</em></td>
351     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
352   </tr>
353   <tr>
354     <td><code>%EDITBOXWIDTH%</code></td>
355     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
356     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
357   </tr>
358   <tr>
359     <td><code>%EDITBOXHEIGHT%</code></td>
360     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
361     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
362   </tr>
363   <tr>
364     <td><code>%ATTACHLINKBOX%</code></td>
365     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
366     <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>
367   </tr>
368   <tr>
369     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
370     <td><strong><em>SL</em></strong></td>
371     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
372   </tr>
373   <tr>
374     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
375     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
376     <td> http-equiv meta tags for edit script. </td>
377   </tr>
378   <tr>
379     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
380     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
381     <td> http-equiv meta tags for preview script. </td>
382   </tr>
383   <tr>
384     <td><code>%DENYWEBCHANGE%</code></td>
385     <td><strong><em>WL</em></strong></td>
386     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
387   </tr>
388   <tr>
389     <td><code>%ALLOWWEBCHANGE%</code></td>
390     <td><strong><em>WL</em></strong></td>
391     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
392   </tr>
393   <tr>
394     <td><code>%DENYTOPICCHANGE%</code></td>
395     <td><strong><em>(any topic)</em></strong></td>
396     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
397   </tr>
398   <tr>
399     <td><code>%ALLOWTOPICCHANGE%</code></td>
400     <td><strong><em>(any topic)</em></strong></td>
401     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
402   </tr>
403   <tr>
404     <td><code>%FINALPREFERENCES%</code></td>
405     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
406     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
407   </tr>
408 </table>
409
410 **_Notes:_**
411
412 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
413   - `Set VARIABLENAME = value`
414 - Additional preferences variables can be defined on all three level as needed. Example:
415   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
416
417 -- [[PeterThoeny]] - 24 Mar 2001 <br />