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>%WIKINAME%</code></td>
62     <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
63   </tr>
64   <tr>
65     <td><code>%WIKIUSERNAME%</code></td>
66     <td> Your %WIKINAME% including the Main web name. Usefull for signatures. Is <b>Main.admin</b></td>
67   </tr>
68   <tr>
69     <td><code>%MAINWEB%</code></td>
70     <td> The Main web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]]. Is <b>Main</b></td>
71   </tr>
72   <tr>
73     <td><code>%TWIKIWEB%</code></td>
74     <td> The web containing all documentation and configuration of %WIKITOOLNAME%. Is <b>TWiki</b></td>
75   </tr>
76   <tr>
77     <td><code>%WEB%</code></td>
78     <td> The current web, is <b>%WEB%</b></td>
79   </tr>
80   <tr>
81     <td><code>%BASEWEB%</code></td>
82     <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>
83   </tr>
84   <tr>
85     <td><code>%INCLUDINGWEB%</code></td>
86     <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
87   </tr>
88   <tr>
89     <td><code>%HOMETOPIC%</code></td>
90     <td> The home topic in each web. Is <b>[[Main/WebHome]]</b></td>
91   </tr>
92   <tr>
93     <td><code>%NOTIFYTOPIC%</code></td>
94     <td> The notify topic in each web. Is <b>[[Main/WebNotify]]</b></td>
95   </tr>
96   <tr>
97     <td><code>%WIKIUSERSTOPIC%</code></td>
98     <td> The index topic of all registered users. Is <b>TWikiUsers</b></td>
99   </tr>
100   <tr>
101     <td><code>%WEBPREFSTOPIC%</code></td>
102     <td> The web preferences topic. Is <b>WebPreferences</b></td>
103   </tr>
104   <tr>
105     <td><code>%STATISTICSTOPIC%</code></td>
106     <td> The web statistics topic. Is <b>WebStatistics</b></td>
107   </tr>
108   <tr>
109     <td><code>%TOPIC%</code></td>
110     <td> The current topic name, is <b>%TOPIC%</b></td>
111   </tr>
112   <tr>
113     <td><code>%BASETOPIC%</code></td>
114     <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>
115   </tr>
116   <tr>
117     <td><code>%INCLUDINGTOPIC%</code></td>
118     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
119   </tr>
120   <tr>
121     <td><code>%SPACEDTOPIC%</code></td>
122     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
123   </tr>
124   <tr>
125     <td><code>%TOPICLIST{"format"}%</code></td>
126     <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The <code>$name</code> variable gets expanded to the topic name; the <code>$web</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
127         <tr>
128           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
129           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
130           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
131         </tr>
132         <tr>
133           <td><code>"format"</code></td>
134           <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
135           <td><code>"$name"</code></td>
136         </tr>
137         <tr>
138           <td><code>format="format"</code></td>
139           <td> (Alternative to above) </td>
140           <td><code>"$name"</code></td>
141         </tr>
142         <tr>
143           <td><code>separator=", "</code></td>
144           <td> line separator </td>
145           <td><code>"\n"</code> (new line) </td>
146         </tr>
147         <tr>
148           <td><code>web="Name"</code></td>
149           <td> Name of web </td>
150           <td> Current web </td>
151         </tr>
152       </table> Examples: <br /><code>%TOPICLIST{"   * $web.$name"}%</code> creates a bullet list of all topics. <br /><code>%TOPICLIST{separator=", "}%</code> creates a comma separated list of all topics. <br /><code>%TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%</code> creates an option list (for drop down menus). </td>
153   </tr>
154   <tr>
155     <td><code>%WEBLIST{"format"}%</code></td>
156     <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 gets expanded to the name of the web, <code>$qname</code> gets expanded to double quoted name, <code>$marker</code> to <code>marker</code> where web matches <code>selection</code>. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
157         <tr>
158           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
159           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
160           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
161         </tr>
162         <tr>
163           <td><code>"format"</code></td>
164           <td> Format of one line, may include <code>$name</code> variable </td>
165           <td><code>"$name"</code></td>
166         </tr>
167         <tr>
168           <td><code>format="format"</code></td>
169           <td> (Alternative to above) </td>
170           <td><code>"$name"</code></td>
171         </tr>
172         <tr>
173           <td><code>separator=", "</code></td>
174           <td> line separator </td>
175           <td><code>"\n"</code> (new line) </td>
176         </tr>
177         <tr>
178           <td><code>webs="public"</code></td>
179           <td> comma sep list of Web, public expands to all non-hidden </td>
180           <td><code>"public"</code></td>
181         </tr>
182         <tr>
183           <td><code>marker="selected"</code></td>
184           <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
185           <td><code>"selected"</code></td>
186         </tr>
187         <tr>
188           <td><code>selection</code></td>
189           <td> Current value e.g. current for current Web, =section="%WEB%" </td>
190         </tr>
191       </table> Examples: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. <br /><code>%WEBLIST{"<select><option $marker="$marker" value="$qname">$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%</select></code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
192   </tr>
193   <tr>
194     <td><code>%GMTIME%</code></td>
195     <td> GM time, is <b>29 Jun 2010 - 15:26</b></td>
196   </tr>
197   <tr>
198     <td><code>%GMTIME{"format"}%</code></td>
199     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
200         <tr>
201           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
202           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
203           <th bgcolor="#99CCCC"><strong> Example </strong></th>
204         </tr>
205         <tr>
206           <td> $seconds </td>
207           <td> seconds </td>
208           <td> 59 </td>
209         </tr>
210         <tr>
211           <td> $minutes </td>
212           <td> minutes </td>
213           <td> 59 </td>
214         </tr>
215         <tr>
216           <td> $hours </td>
217           <td> hours </td>
218           <td> 23 </td>
219         </tr>
220         <tr>
221           <td> $day </td>
222           <td> day of month </td>
223           <td> 31 </td>
224         </tr>
225         <tr>
226           <td> $month </td>
227           <td> month in ISO format </td>
228           <td> Dec </td>
229         </tr>
230         <tr>
231           <td> $mo </td>
232           <td> 2 digit month </td>
233           <td> 12 </td>
234         </tr>
235         <tr>
236           <td> $year </td>
237           <td> 4 digit year </td>
238           <td> 1999 </td>
239         </tr>
240         <tr>
241           <td> $ye </td>
242           <td> 2 digit year </td>
243           <td> 99 </td>
244         </tr>
245       </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:59</b></td>
246   </tr>
247   <tr>
248     <td><code>%SERVERTIME%</code></td>
249     <td> Server time, is <b>29 Jun 2010 - 11:26</b></td>
250   </tr>
251   <tr>
252     <td><code>%SERVERTIME{"format"}%</code></td>
253     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:26</b></td>
254   </tr>
255   <tr>
256     <td><code>%HTTP_HOST%</code></td>
257     <td> HTTP_HOST environment variable, is <b></b></td>
258   </tr>
259   <tr>
260     <td><code>%REMOTE_ADDR%</code></td>
261     <td> REMOTE_ADDR environment variable, is <b></b></td>
262   </tr>
263   <tr>
264     <td><code>%REMOTE_PORT%</code></td>
265     <td> REMOTE_PORT environment variable, is <b></b></td>
266   </tr>
267   <tr>
268     <td><code>%REMOTE_USER%</code></td>
269     <td> REMOTE_USER environment variable, is <b></b></td>
270   </tr>
271   <tr>
272     <td><code>%INCLUDE{"page" ...}%</code></td>
273     <td> Server side include to [[Main/IncludeTopicsAndWebPages]]. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="0" cellspacing="0">
274         <tr>
275           <td><code>"SomeTopic"</code></td>
276           <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
277         </tr>
278         <tr>
279           <td><code>"Web.Topic"</code></td>
280           <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
281         </tr>
282         <tr>
283           <td><code>"http://..."</code></td>
284           <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
285         </tr>
286       </table>
287     </td>
288   </tr>
289   <tr>
290     <td><code>%STARTINCLUDE%</code></td>
291     <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>
292   </tr>
293   <tr>
294     <td><code>%STOPINCLUDE%</code></td>
295     <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>
296   </tr>
297   <tr>
298     <td><code>%TOC%</code></td>
299     <td> Table of Content of current topic. </td>
300   </tr>
301   <tr>
302     <td><code>%TOC{"SomeTopic" ...}%</code></td>
303     <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. Parameters are topic name, web and depth: <table border="1" cellpadding="0" cellspacing="0">
304         <tr>
305           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
306           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
307           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
308         </tr>
309         <tr>
310           <td><code>"TopicName"</code></td>
311           <td> topic name </td>
312           <td> Current topic </td>
313         </tr>
314         <tr>
315           <td><code>web="Name"</code></td>
316           <td> Name of web </td>
317           <td> Current web </td>
318         </tr>
319         <tr>
320           <td><code>depth="2"</code></td>
321           <td> Limit depth of headings shown in TOC </td>
322           <td> 6 </td>
323         </tr>
324       </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
325   </tr>
326   <tr>
327     <td><code>%SEARCH{"text" ...}%</code></td>
328     <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] <table border="1" cellpadding="0" cellspacing="0">
329         <tr>
330           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
331           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
332           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
333         </tr>
334         <tr>
335           <td><code>"text"</code></td>
336           <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
337           <td> required </td>
338         </tr>
339         <tr>
340           <td><code>search="text"</code></td>
341           <td> (Alternative to above) </td>
342           <td> N/A </td>
343         </tr>
344         <tr>
345           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
346           <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
347           <td> Current web </td>
348         </tr>
349         <tr>
350           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
351           <td> Search topic name (title) or in the text (body) of the topic </td>
352           <td> Topic text (body) </td>
353         </tr>
354         <tr>
355           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
356           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
357           <td> Sort by topic name </td>
358         </tr>
359         <tr>
360           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
361           <td> Limit the number of results returned </td>
362           <td> All results </td>
363         </tr>
364         <tr>
365           <td><code>regex="on"</code></td>
366           <td>[[Main/RegularExpression]] search </td>
367           <td> Literal search </td>
368         </tr>
369         <tr>
370           <td><code>reverse="on"</code></td>
371           <td> Reverse the direction of the search </td>
372           <td> Ascending search </td>
373         </tr>
374         <tr>
375           <td><code>casesensitive="on"</code></td>
376           <td> Case sensitive search </td>
377           <td> Ignore case </td>
378         </tr>
379         <tr>
380           <td><code>nosummary="on"</code></td>
381           <td> Show topic title only </td>
382           <td> Show topic summary </td>
383         </tr>
384         <tr>
385           <td><code>bookview="on"</code></td>
386           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
387           <td> Show topic summary </td>
388         </tr>
389         <tr>
390           <td><code>nosearch="on"</code></td>
391           <td> Suppress search string </td>
392           <td> Show search string </td>
393         </tr>
394         <tr>
395           <td><code>noheader="on"</code></td>
396           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
397           <td> Show search header </td>
398         </tr>
399         <tr>
400           <td><code>nototal="on"</code></td>
401           <td> Do not show number of topics found </td>
402           <td> Show number </td>
403         </tr>
404       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
405   </tr>
406   <tr>
407     <td><code>%VAR{"NAME" web="Web"}%</code></td>
408     <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>
409     <td>
410       <p>
411       </p>
412     </td>
413   </tr>
414 </table>
415
416 [1] **_Note_**: The search form uses identical names for input fields.
417
418 [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
419
420 ### <a name="Preferences Variables"></a> Preferences Variables
421
422 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):
423
424 <table border="1">
425   <tr>
426     <th> Variable: </th>
427     <th> Level: </th>
428     <th> What: </th>
429   </tr>
430   <tr>
431     <td><code>%WIKIWEBMASTER%</code></td>
432     <td><strong><em>SL</em></strong></td>
433     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
434   </tr>
435   <tr>
436     <td><code>%WIKIWEBLIST%</code></td>
437     <td><strong><em>SL</em></strong></td>
438     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
439   </tr>
440   <tr>
441     <td><code>%WEBTOPICLIST%</code></td>
442     <td><strong><em>WL</em></strong></td>
443     <td> Common links of web (second line of topics) </td>
444   </tr>
445   <tr>
446     <td><code>%WEBCOPYRIGHT%</code></td>
447     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
448     <td> Copyright notice (bottom right corner of topics) </td>
449   </tr>
450   <tr>
451     <td><code>%WEBBGCOLOR%</code></td>
452     <td><strong><em>WL</em></strong></td>
453     <td> Background color of web </td>
454   </tr>
455   <tr>
456     <td><code>%NOSEARCHALL%</code></td>
457     <td><strong><em>WL</em></strong></td>
458     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
459   </tr>
460   <tr>
461     <td><code>%NEWTOPICBGCOLOR%</code></td>
462     <td><strong><em>SL</em></strong> , <em>UL</em></td>
463     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
464   </tr>
465   <tr>
466     <td><code>%NEWTOPICFONTCOLOR%</code></td>
467     <td><strong><em>SL</em></strong> , <em>UL</em></td>
468     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
469   </tr>
470   <tr>
471     <td><code>%EDITBOXWIDTH%</code></td>
472     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
473     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
474   </tr>
475   <tr>
476     <td><code>%EDITBOXHEIGHT%</code></td>
477     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
478     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
479   </tr>
480   <tr>
481     <td><code>%RELEASEEDITLOCKCHECKBOX%</code></td>
482     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
483     <td> Default state of the "Release edit lock" ([[Main/UnlockTopic]]) check box in preview. Checkbox is initially checked if <code>Set RELEASEEDITLOCKCHECKBOX = checked="checked"</code>, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do <strong>not</strong> go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: <b><code>%RELEASEEDITLOCKCHECKBOX%</code></b></td>
484   </tr>
485   <tr>
486     <td><code>%DONTNOTIFYCHECKBOX%</code></td>
487     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
488     <td> Default state of the "Minor Changes, Don't Notify" ([[Main/DontNotify]]) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b></td>
489   </tr>
490   <tr>
491     <td><code>%ATTACHLINKBOX%</code></td>
492     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
493     <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>
494   </tr>
495   <tr>
496     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
497     <td><strong><em>SL</em></strong></td>
498     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
499   </tr>
500   <tr>
501     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
502     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
503     <td> http-equiv meta tags for edit script. </td>
504   </tr>
505   <tr>
506     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
507     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
508     <td> http-equiv meta tags for preview script. </td>
509   </tr>
510   <tr>
511     <td><code>%DENYWEBCHANGE%</code></td>
512     <td><strong><em>WL</em></strong></td>
513     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
514   </tr>
515   <tr>
516     <td><code>%ALLOWWEBCHANGE%</code></td>
517     <td><strong><em>WL</em></strong></td>
518     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
519   </tr>
520   <tr>
521     <td><code>%DENYTOPICCHANGE%</code></td>
522     <td><strong><em>(any topic)</em></strong></td>
523     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
524   </tr>
525   <tr>
526     <td><code>%ALLOWTOPICCHANGE%</code></td>
527     <td><strong><em>(any topic)</em></strong></td>
528     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
529   </tr>
530   <tr>
531     <td><code>%DENYWEBRENAME%</code></td>
532     <td><strong><em>WL</em></strong></td>
533     <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
534   </tr>
535   <tr>
536     <td><code>%ALLOWWEBRENAME%</code></td>
537     <td><strong><em>WL</em></strong></td>
538     <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
539   </tr>
540   <tr>
541     <td><code>%DENYTOPICRENAME%</code></td>
542     <td><strong><em>(any topic)</em></strong></td>
543     <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
544   </tr>
545   <tr>
546     <td><code>%ALLOWTOPICRENAME%</code></td>
547     <td><strong><em>(any topic)</em></strong></td>
548     <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
549   </tr>
550   <tr>
551     <td>
552       <p>
553       </p>
554     </td>
555     <td><code>%FINALPREFERENCES%</code></td>
556     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
557     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
558   </tr>
559 </table>
560
561 **_Notes:_**
562
563 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
564   - `Set VARIABLENAME = value`
565 - Additional preferences variables can be defined on all three level as needed. Example:
566   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
567
568 -- [[PeterThoeny]] - 23 Jul 2001 <br />