summaryrefslogtreecommitdiff
path: root/TWiki/TWikiVariables.mdwn
blob: e4ed80d8ec7fdb1f0cdc3dc259031f663d0e8d15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
%TOC% %STARTINCLUDE%

## <a name="TWiki_Variables"> TWiki Variables </a>

TWikiVariables are text strings enclosed in percentage signs: <code>**%VARIABLE%**</code> that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!

### <a name="Predefined_Variables"> Predefined Variables </a>

With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.

%WIKITOOLNAME% expands the following variables enclosed in % percent signs:

<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #fafafa" width="90%"><font size="13px"><font face="sans-serif"><tr>
        <th width="160"> Variable: </th>
        <th> Expanded to: </th>
      </tr>
      <tr>
        <td><code>%<nop>WIKIHOMEURL%</nop></code></td>
        <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>SCRIPTURL%</nop></code></td>
        <td> The script URL of %WIKITOOLNAME%, is <b>%SCRIPTURL%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>SCRIPTURLPATH%</nop></code></td>
        <td> The path of the script URL of %WIKITOOLNAME%, is <b>%SCRIPTURLPATH%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>SCRIPTSUFFIX%</nop></code></td>
        <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code> is <b>%SCRIPTSUFFIX%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>PUBURL%</nop></code></td>
        <td> The public URL of TWiki, is <b>%PUBURL%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>PUBURLPATH%</nop></code></td>
        <td> The path of the public URL of %WIKITOOLNAME%, is <b>%PUBURLPATH%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>ATTACHURL%</nop></code></td>
        <td> The attachment URL of the current topic, is <b>%ATTACHURL%</b><br /> Example: If you attach a file you can refer to it as <code><b>%<nop>ATTACHURL%/image.gif</nop></b></code></td>
      </tr>
      <tr>
        <td><code>%<nop>ATTACHURLPATH%</nop></code></td>
        <td> The path of the attachment URL of the current topic, is <b>%ATTACHURLPATH%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>URLPARAM{"name"}%</nop></code></td>
        <td> Returns the value of a URL parameter. Ex: <code>%<nop>URLPARAM{"skin"}%</nop></code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b>%URLPARAM{"skin"}%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKITOOLNAME%</nop></code></td>
        <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKIVERSION%</nop></code></td>
        <td> Wiki tool version is <b>%WIKIVERSION%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>USERNAME%</nop></code></td>
        <td> Your login username is <b>%USERNAME%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKINAME%</nop></code></td>
        <td> Your Wiki username. Same as %<nop>USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic. Is <b>%WIKINAME%</b> </nop></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKIUSERNAME%</nop></code></td>
        <td> Your %<nop>WIKINAME% including the %MAINWEB% web name. Usefull for signatures. Is <b>%WIKIUSERNAME%</b> </nop></td>
      </tr>
      <tr>
        <td><code>%<nop>MAINWEB%</nop></code></td>
        <td> The Main web containing %MAINWEB%.%WIKIUSERSTOPIC%, %MAINWEB%.OfficeLocations and %MAINWEB%.TWikiGroups. Is <b>%MAINWEB%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>TWIKIWEB%</nop></code></td>
        <td> The web containing all documentation and configuration of %WIKITOOLNAME% is <b>%TWIKIWEB%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WEB%</nop></code></td>
        <td> The current web is <b>%WEB%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>BASEWEB%</nop></code></td>
        <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as <code>%<nop>WEB%</nop></code> in case there is no include. </td>
      </tr>
      <tr>
        <td><code>%<nop>INCLUDINGWEB%</nop></code></td>
        <td> The web name of the topic that includes the current topic. Same as <code>%<nop>WEB%</nop></code> in case there is no include. </td>
      </tr>
      <tr>
        <td><code>%<nop>HOMETOPIC%</nop></code></td>
        <td> The home topic in each web. Is <b><span style="background:"><font color="">%HOMETOPIC%</font></span><a href="http://LOCATION/HOMETOPIC">?</a></b></td>
      </tr>
      <tr>
        <td><code>%<nop>NOTIFYTOPIC%</nop></code></td>
        <td> The notify topic in each web. Is <b><span style="background:"><font color="">%NOTIFYTOPIC%</font></span><a href="http://LOCATION/NOTIFYTOPIC">?</a></b></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKIUSERSTOPIC%</nop></code></td>
        <td> The index topic of all registered users. Is <b>%WIKIUSERSTOPIC%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WEBPREFSTOPIC%</nop></code></td>
        <td> The web preferences topic. Is <b>%WEBPREFSTOPIC%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>STATISTICSTOPIC%</nop></code></td>
        <td> The web statistics topic. Is <b>%STATISTICSTOPIC%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>TOPIC%</nop></code></td>
        <td> The current topic name, is <b>%TOPIC%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>BASETOPIC%</nop></code></td>
        <td> The name of the topic where the includes started, e.g. the first topic of nested includes. Same as <code>%<nop>TOPIC%</nop></code> in case there is no include. </td>
      </tr>
      <tr>
        <td><code>%<nop>INCLUDINGTOPIC%</nop></code></td>
        <td> The name of the topic that includes the current topic. Same as <code>%<nop>TOPIC%</nop></code> in case there is no include. </td>
      </tr>
      <tr>
        <td><code>%<nop>SPACEDTOPIC%</nop></code></td>
        <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b>%SPACEDTOPIC%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>TOPICLIST{"format"}%</nop></code></td>
        <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="1" cellspacing="0">
            <tr>
              <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
              <th bgcolor="#99CCCC"><strong>Description:</strong></th>
              <th bgcolor="#99CCCC"><strong>Default:</strong></th>
            </tr>
            <tr>
              <td><code>"format"</code></td>
              <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
              <td><code>"$name"</code></td>
            </tr>
            <tr>
              <td><code>format="format"</code></td>
              <td> (Alternative to above) </td>
              <td><code>"$name"</code></td>
            </tr>
            <tr>
              <td><code>separator=", "</code></td>
              <td> line separator </td>
              <td><code>"\n"</code> (new line) </td>
            </tr>
            <tr>
              <td><code>web="Name"</code></td>
              <td> Name of web </td>
              <td> Current web </td>
            </tr>
          </table> Examples: <br /><code>%<nop>TOPICLIST{"   * $web.$name"}%</nop></code> creates a bullet list of all topics. <br /><code>%<nop>TOPICLIST{separator=", "}%</nop></code> creates a comma separated list of all topics. <br /><code>%<nop>TOPICLIST{" &amp;lt;option&amp;gt;$name&amp;lt;/option&amp;gt;"}%</nop></code> creates an option list (for drop down menus). </td>
      </tr>
      <tr>
        <td><code>%<nop>WEBLIST{"format"}%</nop></code></td>
        <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="1" cellspacing="0">
            <tr>
              <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
              <th bgcolor="#99CCCC"><strong>Description:</strong></th>
              <th bgcolor="#99CCCC"><strong>Default:</strong></th>
            </tr>
            <tr>
              <td><code>"format"</code></td>
              <td> Format of one line, may include <code>$name</code> variable </td>
              <td><code>"$name"</code></td>
            </tr>
            <tr>
              <td><code>format="format"</code></td>
              <td> (Alternative to above) </td>
              <td><code>"$name"</code></td>
            </tr>
            <tr>
              <td><code>separator=", "</code></td>
              <td> line separator </td>
              <td><code>"\n"</code> (new line) </td>
            </tr>
            <tr>
              <td><code>webs="public"</code></td>
              <td> comma sep list of Web, public expands to all non-hidden </td>
              <td><code>"public"</code></td>
            </tr>
            <tr>
              <td><code>marker="selected"</code></td>
              <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
              <td><code>"selected"</code></td>
            </tr>
            <tr>
              <td><code>selection</code></td>
              <td> Current value e.g. current for current Web, =section="%<nop>WEB%" </nop></td>
            </tr>
          </table> Examples: <br /><code>%<nop>WEBLIST{"   * [<nop>[$name.%HOMETOPIC%]]"}%</nop></nop></code> creates a bullet list of all webs. <br /><code>%<nop>WEBLIST{"<select><option $marker="$marker" value="$qname">$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%</select></nop></code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
      </tr>
      <tr>
        <td><code>%<nop>GMTIME%</nop></code></td>
        <td> GM time, is <b>%GMTIME%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>GMTIME{"format"}%</nop></code></td>
        <td> Formatted GM time based on time variables. <table border="1" cellpadding="1" cellspacing="0">
            <tr>
              <th bgcolor="#99CCCC"><strong>Variable:</strong></th>
              <th bgcolor="#99CCCC"><strong>Unit:</strong></th>
              <th bgcolor="#99CCCC"><strong>Example</strong></th>
            </tr>
            <tr>
              <td> $seconds </td>
              <td> seconds </td>
              <td> 59 </td>
            </tr>
            <tr>
              <td> $minutes </td>
              <td> minutes </td>
              <td> 59 </td>
            </tr>
            <tr>
              <td> $hours </td>
              <td> hours </td>
              <td> 23 </td>
            </tr>
            <tr>
              <td> $day </td>
              <td> day of month </td>
              <td> 31 </td>
            </tr>
            <tr>
              <td> $month </td>
              <td> month in ISO format </td>
              <td> Dec </td>
            </tr>
            <tr>
              <td> $mo </td>
              <td> 2 digit month </td>
              <td> 12 </td>
            </tr>
            <tr>
              <td> $year </td>
              <td> 4 digit year </td>
              <td> 1999 </td>
            </tr>
            <tr>
              <td> $ye </td>
              <td> 2 digit year </td>
              <td> 99 </td>
            </tr>
          </table> Variables can be shortened to 3 characters. Example: <br /><code>%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}%</nop></code> is <br /><b>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>SERVERTIME%</nop></code></td>
        <td> Server time, is <b>%SERVERTIME%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>SERVERTIME{"format"}%</nop></code></td>
        <td> Formatted server time. <br /> Example: <code>%<nop>SERVERTIME{"$hou:$min"}%</nop></code> is <b>%SERVERTIME{"$hou:$min"}%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>HTTP_HOST%</nop></code></td>
        <td> HTTP_HOST environment variable, is <b>%HTTP_HOST%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>REMOTE_ADDR%</nop></code></td>
        <td> REMOTE_ADDR environment variable, is <b>%REMOTE_ADDR%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>REMOTE_PORT%</nop></code></td>
        <td> REMOTE_PORT environment variable, is <b>%REMOTE_PORT%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>REMOTE_USER%</nop></code></td>
        <td> REMOTE_USER environment variable, is <b>%REMOTE_USER%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>INCLUDE{"page" ...}%</nop></code></td>
        <td> Server side include to <span style="background:"><font color="">Include Topics And Web Pages</font></span><a href="http://LOCATION/IncludeTopicsAndWebPages">?</a>. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="1" cellspacing="0">
            <tr>
              <td><code>"SomeTopic"</code></td>
              <td> The name of a topic located in the current web, i.e. <code>%<nop>INCLUDE{"WebNotify"}%</nop></code></td>
            </tr>
            <tr>
              <td><code>"Web.Topic"</code></td>
              <td> A topic in another web, i.e. <code>%<nop>INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%</nop></code></td>
            </tr>
            <tr>
              <td><code>"http://..."</code></td>
              <td> A full qualified URL, i.e. <code>%<nop>INCLUDE{"http://twiki.org/"}%</nop></code></td>
            </tr>
          </table>
        </td>
      </tr>
      <tr>
        <td><code>%<nop>STARTINCLUDE%</nop></code></td>
        <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>%<nop>STOPINCLUDE%</nop></code> variable. A normal view of the topic shows everyting exept the <code>%<nop>STARTINCLUDE%</nop></code> variable itself. </td>
      </tr>
      <tr>
        <td><code>%<nop>STOPINCLUDE%</nop></code></td>
        <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>%<nop>STOPINCLUDE%</nop></code> variable itself. </td>
      </tr>
      <tr>
        <td><code>%<nop>TOC%</nop></code></td>
        <td> Table of Contents of current topic. </td>
      </tr>
      <tr>
        <td><code>%<nop>TOC{"SomeTopic" ...}%</nop></code></td>
        <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in <span style="background:"><font color="">Wiki Syntax</font></span><a href="http://LOCATION/WikiSyntax">?</a> (<code>"---++ text"</code>) and HTML (<code>"&amp;lt;h2&amp;gt;text&amp;lt;h2&amp;gt;"</code>) are taken into account. (But not <code>"&amp;lt;H2&amp;gt;text&amp;lt;/H2&amp;gt;"</code>, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth: <table border="1" cellpadding="1" cellspacing="0">
            <tr>
              <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
              <th bgcolor="#99CCCC"><strong>Description:</strong></th>
              <th bgcolor="#99CCCC"><strong>Default:</strong></th>
            </tr>
            <tr>
              <td><code>"TopicName"</code></td>
              <td> topic name </td>
              <td> Current topic </td>
            </tr>
            <tr>
              <td><code>web="Name"</code></td>
              <td> Name of web </td>
              <td> Current web </td>
            </tr>
            <tr>
              <td><code>depth="2"</code></td>
              <td> Limit depth of headings shown in TOC </td>
              <td> 6 </td>
            </tr>
          </table> Examples: <code><b>%<nop>TOC{depth="2"}%</nop></b></code>, <code><b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%"}%</nop></b></code></td>
      </tr>
      <tr>
        <td><code>%<nop>SEARCH{"text" ...}%</nop></code></td>
        <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="1" cellspacing="0">
            <tr>
              <th bgcolor="#99CCCC"><strong>Parameter:</strong></th>
              <th bgcolor="#99CCCC"><strong>Description:</strong></th>
              <th bgcolor="#99CCCC"><strong>Default:</strong></th>
            </tr>
            <tr>
              <td><code>"text"</code></td>
              <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
              <td> required </td>
            </tr>
            <tr>
              <td><code>search="text"</code></td>
              <td> (Alternative to above) </td>
              <td> N/A </td>
            </tr>
            <tr>
              <td><code>web="Name"</code><br /><code>web="%MAINWEB% Know"</code><br /><code>web="all"</code></td>
              <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
              <td> Current web </td>
            </tr>
            <tr>
              <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
              <td> Search topic name (title) or in the text (body) of the topic </td>
              <td> Topic text (body) </td>
            </tr>
            <tr>
              <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
              <td> Sort the results of search by the topic names, last modified time, or last editor </td>
              <td> Sort by topic name </td>
            </tr>
            <tr>
              <td><code>limit="all"</code><br /><code>limit="16"</code></td>
              <td> Limit the number of results returned </td>
              <td> All results </td>
            </tr>
            <tr>
              <td><code>regex="on"</code></td>
              <td><span style="background:"><font color="">Regular Expression</font></span><a href="http://LOCATION/RegularExpression">?</a> search </td>
              <td> Literal search </td>
            </tr>
            <tr>
              <td><code>reverse="on"</code></td>
              <td> Reverse the direction of the search </td>
              <td> Ascending search </td>
            </tr>
            <tr>
              <td><code>casesensitive="on"</code></td>
              <td> Case sensitive search </td>
              <td> Ignore case </td>
            </tr>
            <tr>
              <td><code>nosummary="on"</code></td>
              <td> Show topic title only </td>
              <td> Show topic summary </td>
            </tr>
            <tr>
              <td><code>bookview="on"</code></td>
              <td><span style="background:"><font color="">Book View</font></span><a href="http://LOCATION/BookView">?</a> search, e.g. show complete topic text </td>
              <td> Show topic summary </td>
            </tr>
            <tr>
              <td><code>nosearch="on"</code></td>
              <td> Suppress search string </td>
              <td> Show search string </td>
            </tr>
            <tr>
              <td><code>noheader="on"</code></td>
              <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
              <td> Show search header </td>
            </tr>
            <tr>
              <td><code>nototal="on"</code></td>
              <td> Do not show number of topics found </td>
              <td> Show number </td>
            </tr>
          </table> Example: <code><b>%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%</nop></b></code></td>
      </tr>
      <tr>
        <td><code>%<nop>VAR{"NAME" web="Web"}%</nop></code></td>
        <td> Get a preference value from a web other then the current one. Example: To get <code>%<nop>WEBBGCOLOR%</nop></code> of the %MAINWEB% web write <code>%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%</nop></code>, is <code><b>%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%</b></code></td>
      </tr></font></font></table>

> [1]
>
> **_Note_**
>
> : The search form uses identical names for input fields.
>
> [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its %WEBPREFSTOPIC%.

### <a name="Preferences_Variables"> Preferences Variables </a>

Additional variables are defined in the preferences ( site-level ( **_SL_** ) in %TWIKIWEB%.%WIKIPREFSTOPIC%, web-level ( **_WL_** ) in %WEBPREFSTOPIC% of each web, and user level ( **_UL_** ) preferences in individual user topics):

<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #fafafa" width="90%"><font size="13px"><font face="sans-serif"><tr>
        <th width="160"> Variable: </th>
        <th> Level: </th>
        <th> What: </th>
      </tr>
      <tr>
        <td><code>%<nop>WIKIWEBMASTER%</nop></code></td>
        <td><strong><em>SL</em></strong></td>
        <td> Webmaster email address (sender of email notifications) , is <b>%WIKIWEBMASTER%</b></td>
      </tr>
      <tr>
        <td><code>%<nop>WIKIWEBLIST%</nop></code></td>
        <td><strong><em>SL</em></strong></td>
        <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
      </tr>
      <tr>
        <td><code>%<nop>WEBTOPICLIST%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> Common links of web (second line of topics) </td>
      </tr>
      <tr>
        <td><code>%<nop>WEBCOPYRIGHT%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
        <td> Copyright notice (bottom right corner of topics) </td>
      </tr>
      <tr>
        <td><code>%<nop>WEBBGCOLOR%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> Background color of web </td>
      </tr>
      <tr>
        <td><code>%<nop>NOSEARCHALL%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
      </tr>
      <tr>
        <td><code>%<nop>NEWTOPICBGCOLOR%</nop></code></td>
        <td><strong><em>SL</em></strong> , <em>UL</em></td>
        <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
      </tr>
      <tr>
        <td><code>%<nop>NEWTOPICFONTCOLOR%</nop></code></td>
        <td><strong><em>SL</em></strong> , <em>UL</em></td>
        <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
      </tr>
      <tr>
        <td><code>%<nop>EDITBOXWIDTH%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
      </tr>
      <tr>
        <td><code>%<nop>EDITBOXHEIGHT%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
      </tr>
      <tr>
        <td><code>%<nop>RELEASEEDITLOCKCHECKBOX%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> Default state of the "Release edit lock" (<span style="background:"><font color="">Unlock Topic</font></span><a href="http://LOCATION/UnlockTopic">?</a>) 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>
      </tr>
      <tr>
        <td><code>%<nop>DONTNOTIFYCHECKBOX%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> Default state of the "Minor Changes, Don't Notify" (<span style="background:"><font color="">Dont Notify</font></span><a href="http://LOCATION/DontNotify">?</a>) 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>
      </tr>
      <tr>
        <td><code>%<nop>ATTACHLINKBOX%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <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>
      </tr>
      <tr>
        <td><code>%<nop>HTTP_EQUIV_ON_VIEW%</nop></code></td>
        <td><strong><em>SL</em></strong></td>
        <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
      </tr>
      <tr>
        <td><code>%<nop>HTTP_EQUIV_ON_EDIT%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> http-equiv meta tags for edit script. </td>
      </tr>
      <tr>
        <td><code>%<nop>HTTP_EQUIV_ON_PREVIEW%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
        <td> http-equiv meta tags for preview script. </td>
      </tr>
      <tr>
        <td><code>%<nop>DENYWEBCHANGE%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>ALLOWWEBCHANGE%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>DENYTOPICCHANGE%</nop></code></td>
        <td><strong><em>(any topic)</em></strong></td>
        <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>ALLOWTOPICCHANGE%</nop></code></td>
        <td><strong><em>(any topic)</em></strong></td>
        <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>DENYWEBRENAME%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>ALLOWWEBRENAME%</nop></code></td>
        <td><strong><em>WL</em></strong></td>
        <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>DENYTOPICRENAME%</nop></code></td>
        <td><strong><em>(any topic)</em></strong></td>
        <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td><code>%<nop>ALLOWTOPICRENAME%</nop></code></td>
        <td><strong><em>(any topic)</em></strong></td>
        <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in <span style="background:"><font color="">TWiki Access Control</font></span><a href="http://LOCATION/TWikiAccessControl">?</a>) </td>
      </tr>
      <tr>
        <td>
          <p>
          </p>
        </td>
        <td><code>%<nop>FINALPREFERENCES%</nop></code></td>
        <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
        <td> List of preferences that are not allowed to be overridden by next level preferences</td>
      </tr></font></font></table>

### <a name="Setting_Preferences"> Setting Preferences </a>

* The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: <br />[6 spaces] \* [space] Set [space] VARIABLENAME [space] = [value] <br />**_Example:_**
  * <code>**Set VARIABLENAME = value**</code>

### <a name="Creating_Custom_Variables"> Creating Custom Variables </a>

* You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

> **Example: Create a custom logo variable**
>
> <br />
>
> * To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, simply define the variable on the web's [[WebPreferences]] page. You also have to upload `logo.gif` - this can be done by [[FileAttachment]] to `LogoTopic` (any topic name you choose):
>   * <code>**Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif**</code>

-- [[MikeMannix]] - 30 Aug 2001 <br />