8999f772b49eea2e6ae9bd72d608d958d94546ad
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Variables"> TWiki Variables</a><ul>
4         <li><a href="#Predefined Variables"> Predefined Variables</a></li>
5         <li><a href="#Preferences Variables"> Preferences Variables</a></li>
6         <li><a href="#Setting Preferences"> Setting Preferences</a></li>
7         <li><a href="#Creating Custom Variables"> Creating Custom Variables</a></li>
8       </ul>
9     </li>
10   </ul>
11 </div>
12
13 # <a name="TWiki Variables"></a> TWiki Variables
14
15 _Special text strings expand on the fly to display user data or system info_
16
17 TWikiVariables are text strings - `%VARIABLE%` - that expand into content whenever a page is opened. When a topic is rendered for viewing, `VARIABLES` are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.
18
19 ## <a name="Predefined Variables"></a> Predefined Variables
20
21 Most predefined variables return values that were either set in the <code>**lib/twiki.cfg**</code> file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.
22
23 - %T% **Take the time to thoroughly read through ALL preference variables.** If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see <code>**%INCLUDINGTOPIC%**</code>, <code>**%INCLUDE%**</code>, and the mighty <code>**%SEARCH%**</code>.
24
25 This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the following variables (enclosed in <code>**%**</code> percent signs):
26
27 <table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #f5f5f5">
28   <tr>
29     <th width="160"> Variable: </th>
30     <th> Expanded to: </th>
31   </tr>
32   <tr>
33     <td><code>%WIKIHOMEURL%</code></td>
34     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
35   </tr>
36   <tr>
37     <td><code>%SCRIPTURL%</code></td>
38     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
39   </tr>
40   <tr>
41     <td><code>%SCRIPTURLPATH%</code></td>
42     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
43   </tr>
44   <tr>
45     <td><code>%SCRIPTSUFFIX%</code></td>
46     <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code> is <b></b></td>
47   </tr>
48   <tr>
49     <td><code>%PUBURL%</code></td>
50     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b><br /> Example: You can refer to a file attached to another topic as <code><b>%PUBURL%/%WEB%/OtherTopic/image.gif</b></code></td>
51   </tr>
52   <tr>
53     <td><code>%PUBURLPATH%</code></td>
54     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
55   </tr>
56   <tr>
57     <td><code>%ATTACHURL%</code></td>
58     <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>
59   </tr>
60   <tr>
61     <td><code>%ATTACHURLPATH%</code></td>
62     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
63   </tr>
64   <tr>
65     <td><code>%ICON{"type"}%</code></td>
66     <td> Small 16x16 pixel icon of common attachment types, like <img align="top" alt="bmp" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/bmp.gif" width="16" /> <code>bmp</code>, <img align="top" alt="doc" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/doc.gif" width="16" /> <code>doc</code>, <img align="top" alt="gif" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/gif.gif" width="16" /> <code>gif</code>, <img align="top" alt="hlp" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/hlp.gif" width="16" /> <code>hlp</code>, <img align="top" alt="html" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/html.gif" width="16" /> <code>html</code>, <img align="top" alt="mp3" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/mp3.gif" width="16" /> <code>mp3</code>, <img align="top" alt="pdf" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/pdf.gif" width="16" /> <code>pdf</code>, <img align="top" alt="ppt" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/ppt.gif" width="16" /> <code>ppt</code>, <img align="top" alt="txt" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/txt.gif" width="16" /> <code>txt</code>, <img align="top" alt="xls" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/xls.gif" width="16" /> <code>xls</code>, <img align="top" alt="xml" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/xml.gif" width="16" /> <code>xml</code>, <img align="top" alt="zip" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/zip.gif" width="16" /> <code>zip</code>, etc. Specify file type only, file name, or full path name. Example: <code>%ICON{"pdf"}%</code> returns <img align="top" alt="pdf" border="0" height="16" src="http://www.dementia.org/twiki//view/Main/WebHome/pdf.gif" width="16" /></td>
67   </tr>
68   <tr>
69     <td><code>%URLPARAM{"name"}%</code></td>
70     <td> Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
71         <tr>
72           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
73           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
74           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
75         </tr>
76         <tr>
77           <td><code>"name"</code></td>
78           <td> The name of a URL parameter </td>
79           <td> required </td>
80         </tr>
81         <tr>
82           <td><code>default="..."</code></td>
83           <td> Default value in case parameter is empty or missing </td>
84           <td> empty string </td>
85         </tr>
86         <tr>
87           <td><code>newline="&lt;br /&gt;"</code></td>
88           <td> Convert newlines to other delimiters </td>
89           <td> no conversion </td>
90         </tr>
91         <tr>
92           <td><code>encode="entity"</code></td>
93           <td> Encode special characters into HTML entities, like a double quote into <code>&amp;#034;</code>. This is needed if text is put into an HTML form field </td>
94           <td> no encoding </td>
95         </tr>
96         <tr>
97           <td><code>encode="url"</code></td>
98           <td> Encode special characters for URL parameter use, like a double quote into <code>%22</code></td>
99           <td> no encoding </td>
100         </tr>
101       </table> Example: <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b></b></td>
102   </tr>
103   <tr>
104     <td><code>%ENCODE{"string"}%</code></td>
105     <td> Encodes a string. Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
106         <tr>
107           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
108           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
109           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
110         </tr>
111         <tr>
112           <td><code>"string"</code></td>
113           <td> String to encode </td>
114           <td> required (can be empty) </td>
115         </tr>
116         <tr>
117           <td><code>type="entity"</code></td>
118           <td> Encode special characters into HTML entities, like a double quote into <code>&amp;#034;</code></td>
119           <td> URL encoding </td>
120         </tr>
121         <tr>
122           <td><code>type="url"</code></td>
123           <td> Encode special characters for URL parameter use, like a double quote into <code>%22</code></td>
124           <td> (this is the default) </td>
125         </tr>
126       </table> Example: <code>%ENCODE{"spaced name"}%</code> returns <b>spaced%20name</b></td>
127   </tr>
128   <tr>
129     <td><code>%WIKITOOLNAME%</code></td>
130     <td> The name of your TWiki site - <b>%WIKITOOLNAME%</b></td>
131   </tr>
132   <tr>
133     <td><code>%WIKIVERSION%</code></td>
134     <td> Your current TWiki version - <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
135   </tr>
136   <tr>
137     <td><code>%USERNAME%</code></td>
138     <td> Your login username - <b>admin</b></td>
139   </tr>
140   <tr>
141     <td><code>%WIKINAME%</code></td>
142     <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
143   </tr>
144   <tr>
145     <td><code>%WIKIUSERNAME%</code></td>
146     <td> Your %WIKINAME% including the Main web name - always use full signatures - <b>Main.admin</b></td>
147   </tr>
148   <tr>
149     <td><code>%MAINWEB%</code></td>
150     <td> The web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]] is <b>Main</b></td>
151   </tr>
152   <tr>
153     <td><code>%TWIKIWEB%</code></td>
154     <td> The web containing all documentation and site-wide preference settings for %WIKITOOLNAME% - <b>TWiki</b></td>
155   </tr>
156   <tr>
157     <td><code>%WEB%</code></td>
158     <td> The current web is <b>%WEB%</b></td>
159   </tr>
160   <tr>
161     <td><code>%BASEWEB%</code></td>
162     <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>
163   </tr>
164   <tr>
165     <td><code>%INCLUDINGWEB%</code></td>
166     <td> The web name of the topic that includes the current topic - same as <code>%WEB%</code> if there is no INCLUDE. </td>
167   </tr>
168   <tr>
169     <td><code>%HOMETOPIC%</code></td>
170     <td> The home topic in each web - <b>[[Main/WebHome]]</b></td>
171   </tr>
172   <tr>
173     <td><code>%NOTIFYTOPIC%</code></td>
174     <td> The notify topic in each web - <b>[[Main/WebNotify]]</b></td>
175   </tr>
176   <tr>
177     <td><code>%WIKIUSERSTOPIC%</code></td>
178     <td> The index topic of all registered users - <b>TWikiUsers</b></td>
179   </tr>
180   <tr>
181     <td><code>%WIKIPREFSTOPIC%</code></td>
182     <td> The site-wide preferences topic - <b>TWikiPreferences</b></td>
183   </tr>
184   <tr>
185     <td><code>%WEBPREFSTOPIC%</code></td>
186     <td> The local web preferences topic in each web - <b>WebPreferences</b></td>
187   </tr>
188   <tr>
189     <td><code>%STATISTICSTOPIC%</code></td>
190     <td> The web statistics topic <b>WebStatistics</b></td>
191   </tr>
192   <tr>
193     <td><code>%TOPIC%</code></td>
194     <td> The current topic name - <b>%TOPIC%</b></td>
195   </tr>
196   <tr>
197     <td><code>%BASETOPIC%</code></td>
198     <td> The name of the topic where a single or nested INCLUDE started - same as <code>%TOPIC%</code> if there is no INCLUDE. </td>
199   </tr>
200   <tr>
201     <td><code>%INCLUDINGTOPIC%</code></td>
202     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
203   </tr>
204   <tr>
205     <td><code>%SPACEDTOPIC%</code></td>
206     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
207   </tr>
208   <tr>
209     <td><code>%TOPICLIST{"format"}%</code></td>
210     <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">
211         <tr>
212           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
213           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
214           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
215         </tr>
216         <tr>
217           <td><code>"format"</code></td>
218           <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
219           <td><code>"$name"</code></td>
220         </tr>
221         <tr>
222           <td><code>format="format"</code></td>
223           <td> (Alternative to above) </td>
224           <td><code>"$name"</code></td>
225         </tr>
226         <tr>
227           <td><code>separator=", "</code></td>
228           <td> line separator </td>
229           <td><code>"\n"</code> (new line) </td>
230         </tr>
231         <tr>
232           <td><code>web="Name"</code></td>
233           <td> Name of web </td>
234           <td> Current web </td>
235         </tr>
236       </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>
237   </tr>
238   <tr>
239     <td><code>%WEBLIST{"format"}%</code></td>
240     <td> Web index, ex: 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">
241         <tr>
242           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
243           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
244           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
245         </tr>
246         <tr>
247           <td><code>"format"</code></td>
248           <td> Format of one line, may include <code>$name</code> variable </td>
249           <td><code>"$name"</code></td>
250         </tr>
251         <tr>
252           <td><code>format="format"</code></td>
253           <td> (Alternative to above) </td>
254           <td><code>"$name"</code></td>
255         </tr>
256         <tr>
257           <td><code>separator=", "</code></td>
258           <td> line separator </td>
259           <td><code>"\n"</code> (new line) </td>
260         </tr>
261         <tr>
262           <td><code>webs="public"</code></td>
263           <td> comma sep list of Web, public expands to all non-hidden </td>
264           <td><code>"public"</code></td>
265         </tr>
266         <tr>
267           <td><code>marker="selected"</code></td>
268           <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
269           <td><code>"selected"</code></td>
270         </tr>
271         <tr>
272           <td><code>selection="%WEB%"</code></td>
273           <td> Current value to be selected in list </td>
274           <td><code>section="%WEB%"</code></td>
275         </tr>
276       </table> Examples: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. <br /><code>%WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash,public" selection="%WEB%" separator=" "}%</code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
277   </tr>
278   <tr>
279     <td><code>%GMTIME%</code></td>
280     <td> GM time, is <b>29 Jun 2010 - 15:43</b></td>
281   </tr>
282   <tr>
283     <td><code>%GMTIME{"format"}%</code></td>
284     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
285         <tr>
286           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
287           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
288           <th bgcolor="#99CCCC"><strong> Example </strong></th>
289         </tr>
290         <tr>
291           <td> $seconds </td>
292           <td> seconds </td>
293           <td> 59 </td>
294         </tr>
295         <tr>
296           <td> $minutes </td>
297           <td> minutes </td>
298           <td> 59 </td>
299         </tr>
300         <tr>
301           <td> $hours </td>
302           <td> hours </td>
303           <td> 23 </td>
304         </tr>
305         <tr>
306           <td> $day </td>
307           <td> day of month </td>
308           <td> 31 </td>
309         </tr>
310         <tr>
311           <td> $month </td>
312           <td> month in ISO format </td>
313           <td> Dec </td>
314         </tr>
315         <tr>
316           <td> $mo </td>
317           <td> 2 digit month </td>
318           <td> 12 </td>
319         </tr>
320         <tr>
321           <td> $year </td>
322           <td> 4 digit year </td>
323           <td> 1999 </td>
324         </tr>
325         <tr>
326           <td> $ye </td>
327           <td> 2 digit year </td>
328           <td> 99 </td>
329         </tr>
330       </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:43:57</b></td>
331   </tr>
332   <tr>
333     <td><code>%SERVERTIME%</code></td>
334     <td> Server time, is <b>29 Jun 2010 - 11:43</b></td>
335   </tr>
336   <tr>
337     <td><code>%SERVERTIME{"format"}%</code></td>
338     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:43</b></td>
339   </tr>
340   <tr>
341     <td><code>%HTTP_HOST%</code></td>
342     <td> HTTP_HOST environment variable, is <b></b></td>
343   </tr>
344   <tr>
345     <td><code>%REMOTE_ADDR%</code></td>
346     <td> REMOTE_ADDR environment variable, is <b></b></td>
347   </tr>
348   <tr>
349     <td><code>%REMOTE_PORT%</code></td>
350     <td> REMOTE_PORT environment variable, is <b></b></td>
351   </tr>
352   <tr>
353     <td><code>%REMOTE_USER%</code></td>
354     <td> REMOTE_USER environment variable, is <b></b></td>
355   </tr>
356   <tr>
357     <td><code>%INCLUDE{"page" ...}%</code></td>
358     <td> Server side include to [[Main/IncludeTopicsAndWebPages]]: <table border="1" cellpadding="0" cellspacing="0">
359         <tr>
360           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
361           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
362           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
363         </tr>
364         <tr>
365           <td><code>"SomeTopic"</code></td>
366           <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
367           <td>   </td>
368         </tr>
369         <tr>
370           <td><code>"Web.Topic"</code></td>
371           <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.SiteMap"}%</code></td>
372           <td>   </td>
373         </tr>
374         <tr>
375           <td><code>"http://..."</code></td>
376           <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
377           <td>   </td>
378         </tr>
379         <tr>
380           <td><code>pattern="..."</code></td>
381           <td> A [[Main/RegularExpression]] pattern to include a subset of a topic or page </td>
382           <td> none </td>
383         </tr>
384         <tr>
385           <td><code>rev="1.2"</code></td>
386           <td> Include a previous topic revision; N/A for URLs </td>
387           <td> top revision </td>
388         </tr>
389         <tr>
390           <td><code>warn="off"</code></td>
391           <td> Warn if topic include fails: Fail silently (if <code>off</code>); output default warning (if set to <code>on</code>); else, output specific text (use <code>$topic</code> for topic name) </td>
392           <td><code>%INCLUDE- WARNING%</code> [[Main/TWikiPreferences]] setting </td>
393         </tr>
394       </table>
395     </td>
396   </tr>
397   <tr>
398     <td><code>%STARTINCLUDE%</code></td>
399     <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>
400   </tr>
401   <tr>
402     <td><code>%STOPINCLUDE%</code></td>
403     <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>
404   </tr>
405   <tr>
406     <td><code>%TOC%</code></td>
407     <td> Table of Contents of current topic. </td>
408   </tr>
409   <tr>
410     <td><code>%TOC{"SomeTopic" ...}%</code></td>
411     <td> Table of Contents. 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. Any heading text after <code>"!!"</code> is excluded from the TOC; for example, write <code>"---+!! text"</code> if you do not want to list a header in the TOC. Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
412         <tr>
413           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
414           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
415           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
416         </tr>
417         <tr>
418           <td><code>"TopicName"</code></td>
419           <td> topic name </td>
420           <td> Current topic </td>
421         </tr>
422         <tr>
423           <td><code>web="Name"</code></td>
424           <td> Name of web </td>
425           <td> Current web </td>
426         </tr>
427         <tr>
428           <td><code>depth="2"</code></td>
429           <td> Limit depth of headings shown in TOC </td>
430           <td> 6 </td>
431         </tr>
432         <tr>
433           <td><code>title="Some text"</code></td>
434           <td> Title to appear at top of TOC </td>
435           <td> none </td>
436         </tr>
437       </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%</b></code></td>
438   </tr>
439   <tr>
440     <td><code>%SEARCH{"text" ...}%</code></td>
441     <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">
442         <tr>
443           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
444           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
445           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
446         </tr>
447         <tr>
448           <td><code>"text"</code></td>
449           <td> Search term. Is a keyword search, literal search or regular expression search, depending on the <code>type</code> parameter. [[Main/SearchHelp]] has more </td>
450           <td> required </td>
451         </tr>
452         <tr>
453           <td><code>search="text"</code></td>
454           <td> (Alternative to above) </td>
455           <td> N/A </td>
456         </tr>
457         <tr>
458           <td><code>web="Name"</code><br /><code>web="Main, Know"</code><br /><code>web="all"</code></td>
459           <td> Wiki web to search: A web, a list of webs separated by comma, or <code>all</code> webs. [2] </td>
460           <td> Current web </td>
461         </tr>
462         <tr>
463           <td><code>topic="WebPreferences"</code><br /><code>topic="*Bug"</code></td>
464           <td> Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. </td>
465           <td> All topics in a web </td>
466         </tr>
467         <tr>
468           <td><code>excludetopic="Web*"</code><br /><code>excludetopic="WebHome, WebChanges"</code></td>
469           <td> Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. </td>
470           <td> None </td>
471         </tr>
472         <tr>
473           <td><code>type="keyword"</code><br /><code>type="literal"</code><br /><code>type="regex"</code></td>
474           <td> Do a keyword search like <code>soap "web service" -shampoo</code>; a literal search like <code>web service</code>; or [[Main/RegularExpression]] search like <code>soap;web service;!shampoo</code></td>
475           <td><code>%SEARCHVAR- DEFAULTTYPE%</code> [[Main/TWikiPreferences]] setting </td>
476         </tr>
477         <tr>
478           <td><code>scope="topic"</code><br /><code>scope="text"</code><br /><code>scope="all"</code></td>
479           <td> Search topic name (title); the text (body) of topic; or all (both) </td>
480           <td><code>"text"</code></td>
481         </tr>
482         <tr>
483           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code><br /><code>order=<br /> "formfield(name)"</code></td>
484           <td> Sort the results of search by the topic names, last modified time, last editor, or named field of [[Main/TWikiForms]]</td>
485           <td> Sort by topic name </td>
486         </tr>
487         <tr>
488           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
489           <td> Limit the number of results returned </td>
490           <td> All results </td>
491         </tr>
492         <tr>
493           <td><code>reverse="on"</code></td>
494           <td> Reverse the direction of the search </td>
495           <td> Ascending search </td>
496         </tr>
497         <tr>
498           <td><code>casesensitive="on"</code></td>
499           <td> Case sensitive search </td>
500           <td> Ignore case </td>
501         </tr>
502         <tr>
503           <td><code>nosummary="on"</code></td>
504           <td> Show topic title only </td>
505           <td> Show topic summary </td>
506         </tr>
507         <tr>
508           <td><code>bookview="on"</code></td>
509           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
510           <td> Show topic summary </td>
511         </tr>
512         <tr>
513           <td><code>nosearch="on"</code></td>
514           <td> Suppress search string </td>
515           <td> Show search string </td>
516         </tr>
517         <tr>
518           <td><code>noheader="on"</code></td>
519           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
520           <td> Show search header </td>
521         </tr>
522         <tr>
523           <td><code>nototal="on"</code></td>
524           <td> Do not show number of topics found </td>
525           <td> Show number </td>
526         </tr>
527         <tr>
528           <td><code>header="..."</code><br /><code>format="..."</code></td>
529           <td> Custom format results: see <strong>[[Main/FormattedSearch]]</strong> for usage, variables &amp; examples </td>
530           <td> Results in table </td>
531         </tr>
532         <tr>
533           <td><code>multiple="on"</code></td>
534           <td> Multiple hits per topic. Each hit can be [[Main/FormattedSearch]]. The last token is used in case of a regular expression ";" <em>and</em> search </td>
535           <td> Only one hit per topic </td>
536         </tr>
537         <tr>
538           <td><code>separator=", "</code></td>
539           <td> Line separator between hits </td>
540           <td> Newline <code>"$n"</code></td>
541         </tr>
542       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code><br /> Formatted example: <code><b>%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%</b></code> <em>(displays results in a table with header - [[Main/FormattedSearch]])</em><br /> %H% If the TWiki:Plugins.TablePlugin is installed, you may set a <code>%TABLE{}%</code> variable just before the <code>%SEARCH{}%</code> to alter the output of a search. Example: <code><b>%TABLE{ tablewidth="90%" }%</b></code></td>
543   </tr>
544   <tr>
545     <td><code>%METASEARCH{...}%</code></td>
546     <td> Special search of meta data <table border="1" cellpadding="0" cellspacing="0">
547         <tr>
548           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
549           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
550           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
551         </tr>
552         <tr>
553           <td><code>type="topicmoved"</code></td>
554           <td> What sort of search is required? <br /><code>"topicmoved"</code> if search for a topic that may have been moved <br /><code>"parent"</code> if searching for topics that have a specific parent i.e. its children </td>
555           <td> required </td>
556         </tr>
557         <tr>
558           <td><code>web="%WEB%"</code></td>
559           <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. </td>
560           <td> required </td>
561         </tr>
562         <tr>
563           <td><code>topic="%TOPIC%"</code></td>
564           <td> The topic the search relates to </td>
565           <td> required </td>
566         </tr>
567         <tr>
568           <td><code>title="Title"</code></td>
569           <td> Text that is prepended to any search results </td>
570           <td> required </td>
571         </tr>
572       </table> Example: <code><b>%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%</b></code>, you may want to use this in [[Main/WebTopicViewTemplate]] and [[Main/WebTopicNonWikiTemplate]]<br /><code><b>%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%</b></code></td>
573   </tr>
574   <tr>
575     <td><code>%VAR{"NAME" web="Web"}%</code></td>
576     <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>
577   </tr>
578 </table>
579
580 > [1]
581 >
582 > **_Note_**
583 >
584 > : The search form uses identical names for input fields.
585 >
586 > [2] **_Note_**: A web can be excluded from a <code>**web="all"**</code> search if you define a <code>**NOSEARCHALL=on**</code> variable in its [[WebPreferences]].
587
588 <a name="PreferencesVariables"></a>
589
590 ## <a name="Preferences Variables"></a> Preferences Variables
591
592 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):
593
594 <table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #f5f5f5">
595   <tr>
596     <th width="160"> Variable: </th>
597     <th> Level: </th>
598     <th> What: </th>
599   </tr>
600   <tr>
601     <td><code>%WIKIWEBMASTER%</code></td>
602     <td><strong><em>SL</em></strong></td>
603     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
604   </tr>
605   <tr>
606     <td><code>%WIKIWEBLIST%</code></td>
607     <td><strong><em>SL</em></strong></td>
608     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
609   </tr>
610   <tr>
611     <td><code>%WEBTOPICLIST%</code></td>
612     <td><strong><em>WL</em></strong></td>
613     <td> Common links of web (second line of topics) </td>
614   </tr>
615   <tr>
616     <td><code>%WEBCOPYRIGHT%</code></td>
617     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
618     <td> Copyright notice (bottom right corner of topics) </td>
619   </tr>
620   <tr>
621     <td><code>%WEBBGCOLOR%</code></td>
622     <td><strong><em>WL</em></strong></td>
623     <td> Background color of web </td>
624   </tr>
625   <tr>
626     <td><code>%NOSEARCHALL%</code></td>
627     <td><strong><em>WL</em></strong></td>
628     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
629   </tr>
630   <tr>
631     <td><code>%NEWTOPICBGCOLOR%</code></td>
632     <td><strong><em>SL</em></strong> , <em>UL</em></td>
633     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
634   </tr>
635   <tr>
636     <td><code>%NEWTOPICFONTCOLOR%</code></td>
637     <td><strong><em>SL</em></strong> , <em>UL</em></td>
638     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
639   </tr>
640   <tr>
641     <td><code>%EDITBOXWIDTH%</code></td>
642     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
643     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
644   </tr>
645   <tr>
646     <td><code>%EDITBOXHEIGHT%</code></td>
647     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
648     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
649   </tr>
650   <tr>
651     <td><code>%EDITBOXSTYLE%</code></td>
652     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
653     <td> Style of text edit box. Set to <code>width: 99%</code> for full window width (default; overwrites the EDITBOXWIDTH setting), or <code>width: auto</code> to disable. Value is: <b><code>%EDITBOXSTYLE%</code></b></td>
654   </tr>
655   <tr>
656     <td><code>%RELEASEEDITLOCKCHECKBOX%</code></td>
657     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
658     <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>
659   </tr>
660   <tr>
661     <td><code>%DONTNOTIFYCHECKBOX%</code></td>
662     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
663     <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>
664   </tr>
665   <tr>
666     <td><code>%ATTACHLINKBOX%</code></td>
667     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
668     <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>
669   </tr>
670   <tr>
671     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
672     <td><strong><em>SL</em></strong></td>
673     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
674   </tr>
675   <tr>
676     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
677     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
678     <td> http-equiv meta tags for edit script. </td>
679   </tr>
680   <tr>
681     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
682     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
683     <td> http-equiv meta tags for preview script. </td>
684   </tr>
685   <tr>
686     <td><code>%DENYWEBCHANGE%</code></td>
687     <td><strong><em>WL</em></strong></td>
688     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
689   </tr>
690   <tr>
691     <td><code>%ALLOWWEBCHANGE%</code></td>
692     <td><strong><em>WL</em></strong></td>
693     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
694   </tr>
695   <tr>
696     <td><code>%DENYTOPICCHANGE%</code></td>
697     <td><strong><em>(any topic)</em></strong></td>
698     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
699   </tr>
700   <tr>
701     <td><code>%ALLOWTOPICCHANGE%</code></td>
702     <td><strong><em>(any topic)</em></strong></td>
703     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
704   </tr>
705   <tr>
706     <td><code>%DENYWEBRENAME%</code></td>
707     <td><strong><em>WL</em></strong></td>
708     <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
709   </tr>
710   <tr>
711     <td><code>%ALLOWWEBRENAME%</code></td>
712     <td><strong><em>WL</em></strong></td>
713     <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
714   </tr>
715   <tr>
716     <td><code>%DENYTOPICRENAME%</code></td>
717     <td><strong><em>(any topic)</em></strong></td>
718     <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
719   </tr>
720   <tr>
721     <td><code>%ALLOWTOPICRENAME%</code></td>
722     <td><strong><em>(any topic)</em></strong></td>
723     <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
724   </tr>
725   <tr>
726     <td><code>%FINALPREFERENCES%</code></td>
727     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
728     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
729   </tr>
730 </table>
731
732 **_Note:_** There are some more useful variables defined in the [[TWikiPreferences]] like `%BR%` for line break, colors like `%RED%` for colored text and small icons like `%H%` for a %H% Help icon.
733
734 <a name="SettingPrefs"></a>
735
736 ## <a name="Setting Preferences"></a> Setting Preferences
737
738 - The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br />[multiple of 3 spaces] \* [space] Set [space] VARIABLENAME [space] = [value]<br />**_Examples:_**
739 - <code>**Set VARIABLENAME = value**</code>
740   - <code>**Set VARIABLENAME = value**</code>
741
742 ## <a name="Creating Custom Variables"></a> Creating Custom Variables
743
744 - You can add your own Preference Variables for us across an entire site or a single web, using the standard [[Preferences syntax|Main/WebHome#SettingPrefs]]. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.
745
746 > **Example: Create a custom logo variable the %WEB% web**
747 >
748 > <br />
749 >
750 > - To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, define the Variable on the web's [[WebPreferences]] page, and upload a logo file, ex: `mylogo.gif`. You can upload by [[attaching the file|Main/FileAttachment]] to [[WebPreferences]], or, to avoid clutter, to any other topic in the same web, ex: `LogoTopic`:
751 >   - <code>**Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif**</code>
752
753 -- TWiki:Main.PeterThoeny - 14 Jan 2004 <br /> -- TWiki:Main.MikeMannix - 12 May 2002