data/TWiki/TWikiVariables.txt,v
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 head	1.83;
       
     2 access;
       
     3 symbols;
       
     4 locks; strict;
       
     5 comment	@# @;
       
     6 
       
     7 
       
     8 1.83
       
     9 date	2008.01.22.03.21.24;	author TWikiContributor;	state Exp;
       
    10 branches;
       
    11 next	1.82;
       
    12 
       
    13 1.82
       
    14 date	2007.01.16.04.12.02;	author TWikiContributor;	state Exp;
       
    15 branches;
       
    16 next	1.81;
       
    17 
       
    18 1.81
       
    19 date	2006.10.25.00.21.59;	author TWikiContributor;	state Exp;
       
    20 branches;
       
    21 next	1.80;
       
    22 
       
    23 1.80
       
    24 date	2006.04.01.05.55.17;	author TWikiContributor;	state Exp;
       
    25 branches;
       
    26 next	1.79;
       
    27 
       
    28 1.79
       
    29 date	2006.02.01.12.01.20;	author TWikiContributor;	state Exp;
       
    30 branches;
       
    31 next	1.78;
       
    32 
       
    33 1.78
       
    34 date	2004.08.14.07.55.23;	author PeterThoeny;	state Exp;
       
    35 branches;
       
    36 next	1.77;
       
    37 
       
    38 1.77
       
    39 date	2004.05.09.07.41.10;	author PeterThoeny;	state Exp;
       
    40 branches;
       
    41 next	1.76;
       
    42 
       
    43 1.76
       
    44 date	2004.04.01.07.50.58;	author PeterThoeny;	state Exp;
       
    45 branches;
       
    46 next	1.75;
       
    47 
       
    48 1.75
       
    49 date	2004.03.17.06.31.00;	author PeterThoeny;	state Exp;
       
    50 branches;
       
    51 next	1.74;
       
    52 
       
    53 1.74
       
    54 date	2004.01.19.00.29.54;	author PeterThoeny;	state Exp;
       
    55 branches;
       
    56 next	1.73;
       
    57 
       
    58 1.73
       
    59 date	2004.01.18.09.11.57;	author PeterThoeny;	state Exp;
       
    60 branches;
       
    61 next	1.72;
       
    62 
       
    63 1.72
       
    64 date	2004.01.16.07.25.29;	author PeterThoeny;	state Exp;
       
    65 branches;
       
    66 next	1.71;
       
    67 
       
    68 1.71
       
    69 date	2004.01.10.07.25.51;	author PeterThoeny;	state Exp;
       
    70 branches;
       
    71 next	1.70;
       
    72 
       
    73 1.70
       
    74 date	2003.11.01.11.08.04;	author PeterThoeny;	state Exp;
       
    75 branches;
       
    76 next	1.69;
       
    77 
       
    78 1.69
       
    79 date	2003.09.29.00.28.27;	author PeterThoeny;	state Exp;
       
    80 branches;
       
    81 next	1.68;
       
    82 
       
    83 1.68
       
    84 date	2003.08.29.06.49.35;	author PeterThoeny;	state Exp;
       
    85 branches;
       
    86 next	1.67;
       
    87 
       
    88 1.67
       
    89 date	2003.08.23.07.51.41;	author PeterThoeny;	state Exp;
       
    90 branches;
       
    91 next	1.66;
       
    92 
       
    93 1.66
       
    94 date	2003.08.23.05.39.00;	author PeterThoeny;	state Exp;
       
    95 branches;
       
    96 next	1.65;
       
    97 
       
    98 1.65
       
    99 date	2003.06.30.23.40.04;	author PeterThoeny;	state Exp;
       
   100 branches;
       
   101 next	1.64;
       
   102 
       
   103 1.64
       
   104 date	2003.03.22.06.35.17;	author PeterThoeny;	state Exp;
       
   105 branches;
       
   106 next	1.63;
       
   107 
       
   108 1.63
       
   109 date	2003.02.09.00.46.08;	author PeterThoeny;	state Exp;
       
   110 branches;
       
   111 next	1.62;
       
   112 
       
   113 1.62
       
   114 date	2003.01.27.08.22.18;	author PeterThoeny;	state Exp;
       
   115 branches;
       
   116 next	1.61;
       
   117 
       
   118 1.61
       
   119 date	2003.01.19.08.21.09;	author PeterThoeny;	state Exp;
       
   120 branches;
       
   121 next	1.60;
       
   122 
       
   123 1.60
       
   124 date	2002.12.11.08.10.00;	author PeterThoeny;	state Exp;
       
   125 branches;
       
   126 next	1.59;
       
   127 
       
   128 1.59
       
   129 date	2002.11.23.04.42.00;	author PeterThoeny;	state Exp;
       
   130 branches;
       
   131 next	1.58;
       
   132 
       
   133 1.58
       
   134 date	2002.10.06.01.21.00;	author PeterThoeny;	state Exp;
       
   135 branches;
       
   136 next	1.57;
       
   137 
       
   138 1.57
       
   139 date	2002.08.25.07.18.17;	author PeterThoeny;	state Exp;
       
   140 branches;
       
   141 next	1.56;
       
   142 
       
   143 1.56
       
   144 date	2002.06.05.01.20.35;	author PeterThoeny;	state Exp;
       
   145 branches;
       
   146 next	1.55;
       
   147 
       
   148 1.55
       
   149 date	2002.05.24.16.04.04;	author PeterThoeny;	state Exp;
       
   150 branches;
       
   151 next	1.54;
       
   152 
       
   153 1.54
       
   154 date	2002.05.17.23.48.00;	author PeterThoeny;	state Exp;
       
   155 branches;
       
   156 next	1.53;
       
   157 
       
   158 1.53
       
   159 date	2002.05.15.06.59.32;	author PeterThoeny;	state Exp;
       
   160 branches;
       
   161 next	1.52;
       
   162 
       
   163 1.52
       
   164 date	2002.05.12.11.07.14;	author MikeMannix;	state Exp;
       
   165 branches;
       
   166 next	1.51;
       
   167 
       
   168 1.51
       
   169 date	2002.04.07.10.30.00;	author PeterThoeny;	state Exp;
       
   170 branches;
       
   171 next	1.50;
       
   172 
       
   173 1.50
       
   174 date	2002.03.08.03.52.00;	author MikeMannix;	state Exp;
       
   175 branches;
       
   176 next	1.49;
       
   177 
       
   178 1.49
       
   179 date	2002.02.16.10.37.10;	author PeterThoeny;	state Exp;
       
   180 branches;
       
   181 next	1.48;
       
   182 
       
   183 1.48
       
   184 date	2002.01.23.10.22.00;	author MikeMannix;	state Exp;
       
   185 branches;
       
   186 next	1.47;
       
   187 
       
   188 1.47
       
   189 date	2002.01.06.03.45.00;	author MikeMannix;	state Exp;
       
   190 branches;
       
   191 next	1.46;
       
   192 
       
   193 1.46
       
   194 date	2001.12.02.11.58.00;	author MikeMannix;	state Exp;
       
   195 branches;
       
   196 next	1.45;
       
   197 
       
   198 1.45
       
   199 date	2001.11.30.10.14.00;	author MikeMannix;	state Exp;
       
   200 branches;
       
   201 next	1.44;
       
   202 
       
   203 1.44
       
   204 date	2001.10.25.02.10.24;	author PeterThoeny;	state Exp;
       
   205 branches;
       
   206 next	1.43;
       
   207 
       
   208 1.43
       
   209 date	2001.09.15.09.52.20;	author MikeMannix;	state Exp;
       
   210 branches;
       
   211 next	1.42;
       
   212 
       
   213 1.42
       
   214 date	2001.09.14.06.07.40;	author PeterThoeny;	state Exp;
       
   215 branches;
       
   216 next	1.41;
       
   217 
       
   218 1.41
       
   219 date	2001.09.13.07.49.26;	author JohnTalintyre;	state Exp;
       
   220 branches;
       
   221 next	1.40;
       
   222 
       
   223 1.40
       
   224 date	2001.09.12.07.37.54;	author MikeMannix;	state Exp;
       
   225 branches;
       
   226 next	1.39;
       
   227 
       
   228 1.39
       
   229 date	2001.09.07.10.08.32;	author MikeMannix;	state Exp;
       
   230 branches;
       
   231 next	1.38;
       
   232 
       
   233 1.38
       
   234 date	2001.09.07.05.10.55;	author MikeMannix;	state Exp;
       
   235 branches;
       
   236 next	1.37;
       
   237 
       
   238 1.37
       
   239 date	2001.09.01.03.18.20;	author MikeMannix;	state Exp;
       
   240 branches;
       
   241 next	1.36;
       
   242 
       
   243 1.36
       
   244 date	2001.08.31.06.06.23;	author MikeMannix;	state Exp;
       
   245 branches;
       
   246 next	1.35;
       
   247 
       
   248 1.35
       
   249 date	2001.08.30.16.06.31;	author MikeMannix;	state Exp;
       
   250 branches;
       
   251 next	1.34;
       
   252 
       
   253 1.34
       
   254 date	2001.08.30.14.48.51;	author MikeMannix;	state Exp;
       
   255 branches;
       
   256 next	1.33;
       
   257 
       
   258 1.33
       
   259 date	2001.08.29.00.16.01;	author MikeMannix;	state Exp;
       
   260 branches;
       
   261 next	1.32;
       
   262 
       
   263 1.32
       
   264 date	2001.08.27.04.31.10;	author MikeMannix;	state Exp;
       
   265 branches;
       
   266 next	1.31;
       
   267 
       
   268 1.31
       
   269 date	2001.08.26.22.08.29;	author MikeMannix;	state Exp;
       
   270 branches;
       
   271 next	1.30;
       
   272 
       
   273 1.30
       
   274 date	2001.08.15.14.29.41;	author PeterThoeny;	state Exp;
       
   275 branches;
       
   276 next	1.29;
       
   277 
       
   278 1.29
       
   279 date	2001.08.07.15.11.42;	author JohnTalintyre;	state Exp;
       
   280 branches;
       
   281 next	1.28;
       
   282 
       
   283 1.28
       
   284 date	2001.07.23.07.30.52;	author PeterThoeny;	state Exp;
       
   285 branches;
       
   286 next	1.27;
       
   287 
       
   288 1.27
       
   289 date	2001.07.15.02.04.44;	author PeterThoeny;	state Exp;
       
   290 branches;
       
   291 next	1.26;
       
   292 
       
   293 1.26
       
   294 date	2001.07.11.16.56.50;	author PeterThoeny;	state Exp;
       
   295 branches;
       
   296 next	1.25;
       
   297 
       
   298 1.25
       
   299 date	2001.06.26.00.40.16;	author PeterThoeny;	state Exp;
       
   300 branches;
       
   301 next	1.24;
       
   302 
       
   303 1.24
       
   304 date	2001.06.08.01.59.58;	author PeterThoeny;	state Exp;
       
   305 branches;
       
   306 next	1.23;
       
   307 
       
   308 1.23
       
   309 date	2001.06.02.00.27.07;	author PeterThoeny;	state Exp;
       
   310 branches;
       
   311 next	1.22;
       
   312 
       
   313 1.22
       
   314 date	2001.03.25.07.32.59;	author PeterThoeny;	state Exp;
       
   315 branches;
       
   316 next	1.21;
       
   317 
       
   318 1.21
       
   319 date	2001.03.16.08.32.38;	author PeterThoeny;	state Exp;
       
   320 branches;
       
   321 next	1.20;
       
   322 
       
   323 1.20
       
   324 date	2001.03.02.02.05.13;	author PeterThoeny;	state Exp;
       
   325 branches;
       
   326 next	1.19;
       
   327 
       
   328 1.19
       
   329 date	2001.01.20.08.58.55;	author PeterThoeny;	state Exp;
       
   330 branches;
       
   331 next	1.18;
       
   332 
       
   333 1.18
       
   334 date	2001.01.20.02.25.23;	author PeterThoeny;	state Exp;
       
   335 branches;
       
   336 next	1.17;
       
   337 
       
   338 1.17
       
   339 date	2001.01.16.03.45.49;	author PeterThoeny;	state Exp;
       
   340 branches;
       
   341 next	1.16;
       
   342 
       
   343 1.16
       
   344 date	2000.12.18.21.14.46;	author PeterThoeny;	state Exp;
       
   345 branches;
       
   346 next	1.15;
       
   347 
       
   348 1.15
       
   349 date	2000.12.15.17.59.47;	author PeterThoeny;	state Exp;
       
   350 branches;
       
   351 next	1.14;
       
   352 
       
   353 1.14
       
   354 date	2000.12.14.02.40.48;	author PeterThoeny;	state Exp;
       
   355 branches;
       
   356 next	1.13;
       
   357 
       
   358 1.13
       
   359 date	2000.11.11.00.39.03;	author PeterThoeny;	state Exp;
       
   360 branches;
       
   361 next	1.12;
       
   362 
       
   363 1.12
       
   364 date	2000.11.02.06.41.55;	author PeterThoeny;	state Exp;
       
   365 branches;
       
   366 next	1.11;
       
   367 
       
   368 1.11
       
   369 date	2000.09.20.01.00.47;	author PeterThoeny;	state Exp;
       
   370 branches;
       
   371 next	1.10;
       
   372 
       
   373 1.10
       
   374 date	2000.09.19.07.19.18;	author PeterThoeny;	state Exp;
       
   375 branches;
       
   376 next	1.9;
       
   377 
       
   378 1.9
       
   379 date	2000.08.18.07.12.18;	author PeterThoeny;	state Exp;
       
   380 branches;
       
   381 next	1.8;
       
   382 
       
   383 1.8
       
   384 date	2000.07.28.23.24.51;	author PeterThoeny;	state Exp;
       
   385 branches;
       
   386 next	1.7;
       
   387 
       
   388 1.7
       
   389 date	2000.05.29.09.01.12;	author PeterThoeny;	state Exp;
       
   390 branches;
       
   391 next	1.6;
       
   392 
       
   393 1.6
       
   394 date	2000.04.22.05.03.14;	author PeterThoeny;	state Exp;
       
   395 branches;
       
   396 next	1.5;
       
   397 
       
   398 1.5
       
   399 date	2000.03.21.23.20.32;	author PeterThoeny;	state Exp;
       
   400 branches;
       
   401 next	1.4;
       
   402 
       
   403 1.4
       
   404 date	2000.03.01.03.12.47;	author PeterThoeny;	state Exp;
       
   405 branches;
       
   406 next	1.3;
       
   407 
       
   408 1.3
       
   409 date	2000.02.28.08.23.43;	author PeterThoeny;	state Exp;
       
   410 branches;
       
   411 next	1.2;
       
   412 
       
   413 1.2
       
   414 date	2000.01.30.08.45.31;	author PeterThoeny;	state Exp;
       
   415 branches;
       
   416 next	1.1;
       
   417 
       
   418 1.1
       
   419 date	99.06.13.07.45.37;	author thoeny;	state Exp;
       
   420 branches;
       
   421 next	;
       
   422 
       
   423 
       
   424 desc
       
   425 @none
       
   426 @
       
   427 
       
   428 
       
   429 1.83
       
   430 log
       
   431 @buildrelease
       
   432 @
       
   433 text
       
   434 @%META:TOPICINFO{author="TWikiContributor" date="1173217738" format="1.0" version="83"}%
       
   435 %META:TOPICPARENT{name="WebHome"}%
       
   436 %STARTSECTION{type="include"}%
       
   437 ---+ TWiki Variables
       
   438 
       
   439 _Special text strings expand on the fly to display user data or system info_
       
   440 
       
   441 <nop>TWikiVariables are text strings - =%<nop>VARIABLE%= or =%<nop>VARIABLE{ parameter="value" }%= - that expand into content whenever a topic is rendered for viewing. There are two types of variables:
       
   442    1 Preferences variables: Can be defined and changed by the user
       
   443    1 Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a =%<nop>CALC{}%= variable)
       
   444 
       
   445 %TOC%
       
   446 
       
   447 ---++ Using Variables
       
   448 
       
   449 To use a variable type its name. For example,
       
   450    * type =%<nop>T%= to get %T% (a preferences variable)
       
   451    * type =%<nop>TOPIC%= to get =%TOPIC%= (a predefined variable)
       
   452    * type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a variable defined by Plugin)
       
   453 
       
   454 __Note:__
       
   455    * To leave a variable unexpanded, precede it with an exclamation point, e.g. type =!%<nop>TOPIC%= to get =%<nop>TOPIC%=
       
   456    * Variables are expanded relative to the topic they are _used_ in, not the topic they are _defined_ in
       
   457    * Type =%<nop>ALLVARIABLES%= to get a full listing of all variables defined for a particular topic
       
   458 
       
   459 ---++ Variable Names
       
   460 Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g. =%<nop>MYVAR%=, =%<nop>MyVar%=, =%<nop>My2ndVar%=, and =%<nop>My_Var%= are all valid variable names. Variables are case sensitive. =%<nop>MyVAR%= and =%<nop>MYVAR%= are not the same variable.
       
   461 
       
   462 By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.
       
   463 
       
   464 #SettingPrefs
       
   465 #PreferencesVariables
       
   466 ---++ Preferences Variables
       
   467 
       
   468 Unlike predefined variables, preferences variables can be defined by the user in various places.
       
   469 
       
   470 ---+++ Setting Preferences Variables
       
   471 You can set variables in all the following places:
       
   472    1 local site level in [[%SYSTEMWEB%.TWikiPreferences][%SYSTEMWEB%.TWikiPreferences]]
       
   473    1 plugin topics (see TWikiPlugins)
       
   474    1 local site level in [[%LOCALSITEPREFS%][%LOCALSITEPREFS%]]
       
   475    1 user level in individual user topics in %USERSWEB% web
       
   476    1 web level in %WEBPREFSTOPIC% of each web
       
   477    1 topic level in topics in webs
       
   478    1 session variables (if sessions are enabled)
       
   479 
       
   480 Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.
       
   481 
       
   482 If you are setting a variable and using it in the same topic, note that TWiki reads all the variable settings from the saved version of the topic before it displays anything.  This means you can use a variable anywhere in the topic, even if you set it somewhere inconspicuous near the end. *But beware:*  it also means that if you change the setting of a variable you are using in the same topic, ==Preview== will show the wrong thing, and you must ==Save== the topic to see it correctly.
       
   483 
       
   484 The syntax for setting 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] = [space] value=
       
   485 <blockquote>
       
   486 *Examples:*
       
   487    * ==<nop>Set VARIABLENAME = value==
       
   488       * ==<nop>Set VARIABLENAME = value==
       
   489 </blockquote>
       
   490 Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.
       
   491 <blockquote>
       
   492 *Example:*
       
   493 <pre>
       
   494    * <nop>Set VARIABLENAME = value starts here
       
   495      and continues here
       
   496 </pre>
       
   497 </blockquote>
       
   498 
       
   499 Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
       
   500 
       
   501 <blockquote>
       
   502 *Example: Create a custom logo variable* <br />
       
   503    * To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the Variable on the web's WebPreferences topic, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. =LogoTopic=. Sample variable setting in WebPreferences:
       
   504       * ==<nop>Set MYLOGO = %<nop>PUBURL%/%<nop>WEB%/LogoTopic/mylogo.gif==
       
   505 </blockquote>
       
   506 
       
   507 You can also set preferences variables on a topic by clicking the link =Edit topic preference settings= under =More topic actions=. Preferences set in this manner are not visible in the topic text, but take effect nevertheless.
       
   508 
       
   509 ---+++ Access Control Variables
       
   510 
       
   511 These are special types of preferences variables to control access to content. TWikiAccessControl explains these security settings in detail.
       
   512 
       
   513 ---+++ Local values for variables
       
   514 Certain topics (a users home topic, web site and default preferences topics) have a problem; variables defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but *only* when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using =Local= in place of =Set= in the variable definition. For example, if the user sets the following in their home topic:
       
   515 <verbatim>
       
   516    * Set EDITBOXHEIGHT = 10
       
   517    * Local EDITBOXHEIGHT = 20
       
   518 </verbatim>
       
   519 Then when they are editing any other topic, they will get a 10 high edit box. However when they are editing their home topic, they will get a 20 high edit box.
       
   520 =Local= can be used wherever a preference needs to take a different value depending on where the current operation is being performed.
       
   521 
       
   522 Use this powerful feature with great care! =%<nop>ALLVARIABLES%= can be used to get a listing of the values of all variables in their evaluation order, so you can see variable scope if you get confused.
       
   523 
       
   524 ---+++ Frequently Used Preferences Variables
       
   525 
       
   526 The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings:
       
   527    * =%<nop>BR%= - line break
       
   528    * =%<nop>BULLET%= - bullet sign
       
   529    * =%<nop>BB%= - line break and bullet combined
       
   530    * =%<nop>BB2%= - indented line break and bullet
       
   531    * =%<nop>RED% text %<nop>ENDCOLOR%= - colored text (also =%<nop>YELLOW%=, =%<nop>ORANGE%=, =%<nop>PINK%=, =%<nop>PURPLE%=, =%<nop>TEAL%=, =%<nop>NAVY%=, =%<nop>BLUE%=, =%<nop>AQUA%=, =%<nop>LIME%=, =%<nop>GREEN%=, =%<nop>OLIVE%=, =%<nop>MAROON%=, =%<nop>BROWN%=, =%<nop>BLACK%=, =%<nop>GRAY%=, =%<nop>SILVER%=, =%<nop>WHITE%=)
       
   532    * =%<nop>H%= - %H% Help icon
       
   533    * =%<nop>I%= - %I% Idea icon
       
   534    * =%<nop>M%= - %M% Moved to icon
       
   535    * =%<nop>N%= - %N% New icon
       
   536    * =%<nop>P%= - %P% Refactor icon
       
   537    * =%<nop>Q%= - %Q% Question icon
       
   538    * =%<nop>S%= - %S% Pick icon
       
   539    * =%<nop>T%= - %T% Tip icon
       
   540    * =%<nop>U%= - %U% Updated icon
       
   541    * =%<nop>X%= - %X% Alert icon
       
   542    * =%<nop>Y%= - %Y% Done icon
       
   543 
       
   544 There are additional useful preferences variables defined in TWikiPreferences, in [[%LOCALSITEPREFS%]], and in WebPreferences of every web.
       
   545 
       
   546 #PreDef
       
   547 ---++ Predefined Variables
       
   548 
       
   549 Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like =%<nop>SEARCH%=, are powerful and general tools.
       
   550 
       
   551    * %X% Predefined variables can be overridden by [[#PreferencesVariables][preferences variables]]
       
   552    * %X% Plugins may extend the set of predefined variables (see individual Plugins topics for details)
       
   553    * %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 =%<nop>INCLUDINGTOPIC%=, =%<nop>INCLUDE%=, and the mighty =%<nop>SEARCH%=.
       
   554 
       
   555 This version of TWiki - %WIKIVERSION% - predefines the following variables:
       
   556 
       
   557 %SEARCH{
       
   558     "^Var[A-Z_0-9]+$"
       
   559     casesensitive="on"
       
   560     type="regex"
       
   561     scope="topic"
       
   562     format="$percntINCLUDE{$web.$topic}$percnt"
       
   563     nonoise="on"
       
   564 }%
       
   565 
       
   566 %ENDSECTION{type="include"}%
       
   567 
       
   568 __Related Topics:__ UserDocumentationCategory
       
   569 
       
   570 @
       
   571 
       
   572 
       
   573 1.82
       
   574 log
       
   575 @buildrelease
       
   576 @
       
   577 text
       
   578 @d1 1
       
   579 a1 1
       
   580 %META:TOPICINFO{author="TWikiContributor" date="1142799790" format="1.0" version="82"}%
       
   581 a2 1
       
   582 %TOC%
       
   583 d4 1
       
   584 a4 1
       
   585 ---# TWiki Variables
       
   586 d12 2
       
   587 d39 1
       
   588 a39 1
       
   589    1 local site level in [[%TWIKIWEB%.TWikiPreferences][%TWIKIWEB%.TWikiPreferences]]
       
   590 d42 1
       
   591 a42 1
       
   592    1 user level in individual user topics in %MAINWEB% web
       
   593 d49 2
       
   594 @
       
   595 
       
   596 
       
   597 1.81
       
   598 log
       
   599 @buildrelease
       
   600 @
       
   601 text
       
   602 @d1 1
       
   603 a1 1
       
   604 %META:TOPICINFO{author="TWikiContributor" date="1142799790" format="1.0" version="81"}%
       
   605 d39 1
       
   606 a43 1
       
   607    1 plugin topics (see TWikiPlugins)
       
   608 d49 1
       
   609 a49 1
       
   610 <blockquote style="background-color:#f9f9f9">
       
   611 d55 1
       
   612 a55 1
       
   613 <blockquote style="background-color:#f9f9f9">
       
   614 d65 1
       
   615 a65 1
       
   616 <blockquote style="background-color:#f9f9f9">
       
   617 @
       
   618 
       
   619 
       
   620 1.80
       
   621 log
       
   622 @buildrelease
       
   623 @
       
   624 text
       
   625 @d1 1
       
   626 a1 1
       
   627 %META:TOPICINFO{author="TWikiContributor" date="1142799790" format="1.0" version="80"}%
       
   628 d38 2
       
   629 a39 1
       
   630    1 local site level in %LOCALSITEPREFS%
       
   631 @
       
   632 
       
   633 
       
   634 1.79
       
   635 log
       
   636 @buildrelease
       
   637 @
       
   638 text
       
   639 @d1 1
       
   640 a1 1
       
   641 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="79"}%
       
   642 d4 1
       
   643 a4 1
       
   644 %STARTINCLUDE%
       
   645 d10 2
       
   646 a11 2
       
   647 	1 Preferences variables: Can be defined and changed by the user
       
   648 	1 Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a =%<nop>CALC{}%= variable)
       
   649 d16 3
       
   650 a18 3
       
   651 	* type =%<nop>T%= to get %T% (a preferences variable)
       
   652 	* type =%<nop>TOPIC%= to get =%TOPIC%= (a predefined variable)
       
   653 	* type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a variable defined by Plugin)
       
   654 d21 3
       
   655 a23 3
       
   656 	* To leave a variable unexpanded, precede it with an exclamation point, e.g. type =!%<nop>TOPIC%= to get =%<nop>TOPIC%=
       
   657 	* Variables are expanded relative to the topic they are _used_ in, not the topic they are _defined_ in
       
   658 	* Type =%<nop>ALLVARIABLES%= to get a full listing of all variables defined for a particular topic
       
   659 d25 4
       
   660 d38 6
       
   661 a43 6
       
   662 	1 local site level in %LOCALSITEPREFS%
       
   663 	1 user level in individual user topics in %MAINWEB% web
       
   664 	1 web level in %WEBPREFSTOPIC% of each web
       
   665 	1 topic level in topics in webs
       
   666 	1 plugin topics (see TWikiPlugins)
       
   667 	1 session variables (if sessions are enabled)
       
   668 d50 2
       
   669 a51 2
       
   670 	* ==<nop>Set VARIABLENAME = value==
       
   671 		* ==<nop>Set VARIABLENAME = value==
       
   672 d57 2
       
   673 a58 2
       
   674 	* <nop>Set VARIABLENAME = value starts here
       
   675 	  and continues here
       
   676 d66 2
       
   677 a67 2
       
   678 	* To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the Variable on the web's WebPreferences topic, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. =LogoTopic=. Sample variable setting in WebPreferences:
       
   679 		* ==<nop>Set MYLOGO = %<nop>PUBURL%/%<nop>WEB%/LogoTopic/mylogo.gif==
       
   680 d79 2
       
   681 a80 2
       
   682 	* Set EDITBOXHEIGHT = 10
       
   683 	* Local EDITBOXHEIGHT = 20
       
   684 d90 16
       
   685 a105 16
       
   686 	* =%<nop>BR%= - line break
       
   687 	* =%<nop>BULLET%= - bullet sign
       
   688 	* =%<nop>BB%= - line break and bullet combined
       
   689 	* =%<nop>BB2%= - indented line break and bullet
       
   690 	* =%<nop>RED% text %<nop>ENDCOLOR%= - colored text (also =%<nop>YELLOW%=, =%<nop>ORANGE%=, =%<nop>PINK%=, =%<nop>PURPLE%=, =%<nop>TEAL%=, =%<nop>NAVY%=, =%<nop>BLUE%=, =%<nop>AQUA%=, =%<nop>LIME%=, =%<nop>GREEN%=, =%<nop>OLIVE%=, =%<nop>MAROON%=, =%<nop>BROWN%=, =%<nop>BLACK%=, =%<nop>GRAY%=, =%<nop>SILVER%=, =%<nop>WHITE%=)
       
   691 	* =%<nop>H%= - %H% Help icon
       
   692 	* =%<nop>I%= - %I% Idea icon
       
   693 	* =%<nop>M%= - %M% Moved to icon
       
   694 	* =%<nop>N%= - %N% New icon
       
   695 	* =%<nop>P%= - %P% Refactor icon
       
   696 	* =%<nop>Q%= - %Q% Question icon
       
   697 	* =%<nop>S%= - %S% Pick icon
       
   698 	* =%<nop>T%= - %T% Tip icon
       
   699 	* =%<nop>U%= - %U% Updated icon
       
   700 	* =%<nop>X%= - %X% Alert icon
       
   701 	* =%<nop>Y%= - %Y% Done icon
       
   702 d114 3
       
   703 a116 3
       
   704 	* %X% Predefined variables can be overridden by [[#PreferencesVariables][preferences variables]]
       
   705 	* %X% Plugins may extend the set of predefined variables (see individual Plugins topics for details)
       
   706 	* %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 =%<nop>INCLUDINGTOPIC%=, =%<nop>INCLUDE%=, and the mighty =%<nop>SEARCH%=.
       
   707 d120 8
       
   708 a127 2
       
   709 %INCLUDE{"TWikiVariablesAtoM"}%
       
   710 %INCLUDE{"TWikiVariablesNtoZ"}%
       
   711 d129 1
       
   712 a129 1
       
   713 %STOPINCLUDE%
       
   714 @
       
   715 
       
   716 
       
   717 1.78
       
   718 log
       
   719 @none
       
   720 @
       
   721 text
       
   722 @d1 1
       
   723 a1 1
       
   724 %META:TOPICINFO{author="PeterThoeny" date="1092470123" format="1.0" version="1.78"}%
       
   725 d9 15
       
   726 a23 1
       
   727 <nop>TWikiVariables are text strings - =%<nop>VARIABLE%= - that expand into content whenever a page is rendered for viewing. =VARIABLES= are replaced by data, either user-entered or automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you can configure. You can also define custom variables, with new names and values.
       
   728 a24 3
       
   729 __Notes:__
       
   730 	* To leave a variable unexpanded, precede it with an exclamation point, e.g. type =!%<nop>TOPIC%= to get !%TOPIC%.
       
   731 	* Variables are expanded relative to the topic they are _used_ in, not the topic they are _defined_ in.
       
   732 d26 3
       
   733 a28 1
       
   734 ---++ Predefined Variables
       
   735 d30 1
       
   736 a30 1
       
   737 Most predefined variables return values that were either set in the ==lib/twiki.cfg== 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.
       
   738 d32 25
       
   739 a56 1
       
   740 	* %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 ==%<nop>INCLUDINGTOPIC%==, ==%<nop>INCLUDE%==, and the mighty ==%<nop>SEARCH%==.
       
   741 d58 1
       
   742 a58 1
       
   743 This version of TWiki - %WIKIVERSION% - expands the following variables (enclosed in ==%== percent signs):
       
   744 d60 5
       
   745 a64 2
       
   746 %INCLUDE{"TWikiVariablesAtoM"}%
       
   747 %INCLUDE{"TWikiVariablesNtoZ"}%
       
   748 d66 1
       
   749 a66 1
       
   750 __Note:__ Above text is included from TWikiVariablesAtoM and TWikiVariablesNtoZ
       
   751 d68 1
       
   752 d70 1
       
   753 a70 2
       
   754 #PreferencesVariables
       
   755 ---++ Preferences Variables
       
   756 d72 30
       
   757 a101 166
       
   758 Additional variables are defined in the preferences topics:
       
   759 	* site-level ( __SL__ ) in %TWIKIWEB%.%WIKIPREFSTOPIC%
       
   760 	* web-level ( __WL__ ) in %WEBPREFSTOPIC% of each web
       
   761 	* user level ( __UL__ ) in individual user topics
       
   762 
       
   763 <table cellspacing="0" cellpadding="2" border="1" align="center" style="background-color:#f5f5f5">
       
   764 <tr>
       
   765   <th width="160"> Variable: </th><th> Level: </th><th> What: </th><th>Expands to:</th>
       
   766 </tr>
       
   767 <tr>
       
   768   <td> =%<nop>ALLOWTOPICCHANGE%= </td>
       
   769   <td> __(any topic)__ </td>
       
   770   <td> List of users and groups who are *allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
   771   <td> %ALLOWTOPICCHANGE% &nbsp;</td>
       
   772 </tr>
       
   773 <tr>
       
   774   <td> =%<nop>ALLOWTOPICRENAME%= </td>
       
   775   <td> __(any topic)__ </td>
       
   776   <td> List of users and groups who are *allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
   777   <td> %ALLOWTOPICRENAME% &nbsp;</td>
       
   778 </tr>
       
   779 <tr>
       
   780   <td> =%<nop>ALLOWWEBCHANGE%= </td>
       
   781   <td> __WL__ </td>
       
   782   <td> List of users and groups who are *allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
   783   <td> %ALLOWWEBCHANGE% &nbsp;</td>
       
   784 </tr>
       
   785 <tr>
       
   786   <td> =%<nop>ALLOWWEBRENAME%= </td>
       
   787   <td> __WL__ </td>
       
   788   <td> List of users and groups who are *allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
   789   <td> %ALLOWWEBRENAME% &nbsp;</td>
       
   790 </tr>
       
   791 <tr>
       
   792   <td> =%<nop>ATTACHLINKBOX%= </td>
       
   793   <td> __SL__ , __UL__ </td>
       
   794   <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to =CHECKED= , 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>
       
   795   <td> %ATTACHLINKBOX% &nbsp;</td>
       
   796 </tr>
       
   797 <tr>
       
   798   <td> =%<nop>DENYTOPICCHANGE%= </td>
       
   799   <td> __(any topic)__ </td>
       
   800   <td> List of users and groups who are *not allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
   801   <td> %DENYTOPICCHANGE% &nbsp;</td>
       
   802 </tr>
       
   803 <tr>
       
   804   <td> =%<nop>DENYTOPICRENAME%= </td>
       
   805   <td> __(any topic)__ </td>
       
   806   <td> List of users and groups who are *not allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
   807   <td> %DENYTOPICRENAME% &nbsp;</td>
       
   808 </tr>
       
   809 <tr>
       
   810   <td> =%<nop>DENYWEBCHANGE%= </td>
       
   811   <td> __WL__ </td>
       
   812   <td> List of users and groups who are *not allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
   813   <td> %DENYWEBCHANGE% &nbsp;</td>
       
   814 </tr>
       
   815 <tr>
       
   816   <td> =%<nop>DENYWEBRENAME%= </td>
       
   817   <td> __WL__ </td>
       
   818   <td> List of users and groups who are *not allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
   819   <td> %DENYWEBRENAME% &nbsp;</td>
       
   820 </tr>
       
   821 <tr>
       
   822   <td> =%<nop>DONTNOTIFYCHECKBOX%= </td>
       
   823   <td> __SL__ , __UL__ </td>
       
   824   <td> Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if =Set DONTNOTIFYCHECKBOX = checked="checked"=, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b> </td>
       
   825   <td> %DONTNOTIFYCHECKBOX% &nbsp;</td>
       
   826 </tr>
       
   827 <tr>
       
   828   <td> =%<nop>EDITBOXHEIGHT%= </td>
       
   829   <td> __SL__ , __UL__ </td>
       
   830   <td> Vertical size of edit box, is <b> =%EDITBOXHEIGHT%= </b> </td>
       
   831   <td> %EDITBOXHEIGHT% &nbsp;</td>
       
   832 </tr>
       
   833 <tr>
       
   834   <td> =%<nop>EDITBOXWIDTH%= </td>
       
   835   <td> __SL__ , __UL__ </td>
       
   836   <td> Horizontal size of edit box, is <b> =%EDITBOXWIDTH%= </b> </td>
       
   837   <td> %EDITBOXWIDTH% &nbsp;</td>
       
   838 </tr>
       
   839 <tr>
       
   840   <td> =%<nop>EDITBOXSTYLE%= </td>
       
   841   <td> __SL__ , __UL__ </td>
       
   842   <td> Style of text edit box. Set to =width: 99%= for full window width (default; overwrites the EDITBOXWIDTH setting), or =width: auto= to disable. Value is: <b><code>%EDITBOXSTYLE%</code></b> </td>
       
   843   <td> %EDITBOXSTYLE% &nbsp;</td>
       
   844 </tr>
       
   845 <tr>
       
   846   <td> =%<nop>FINALPREFERENCES%= </td>
       
   847   <td> __SL__ , __WL__ </td>
       
   848   <td> List of preferences that are not allowed to be overridden by next level preferences</td>
       
   849   <td> %FINALPREFERENCES% &nbsp;</td>
       
   850 </tr>
       
   851 <tr>
       
   852   <td> =%<nop>HTTP_EQUIV_ON_EDIT%= </td>
       
   853   <td> __SL__ , __UL__ </td>
       
   854   <td> http-equiv meta tags for edit script. </td>
       
   855   <td> %HTTP_EQUIV_ON_EDIT% &nbsp;</td>
       
   856 </tr>
       
   857 <tr>
       
   858   <td> =%<nop>HTTP_EQUIV_ON_PREVIEW%= </td>
       
   859   <td> __SL__ , __UL__ </td>
       
   860   <td> http-equiv meta tags for preview script. </td>
       
   861   <td> %HTTP_EQUIV_ON_PREVIEW% &nbsp;</td>
       
   862 </tr>
       
   863 <tr>
       
   864   <td> =%<nop>HTTP_EQUIV_ON_VIEW%= </td>
       
   865   <td> __SL__ </td>
       
   866   <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
       
   867   <td> %HTTP_EQUIV_ON_VIEW% &nbsp;</td>
       
   868 </tr>
       
   869 <tr>
       
   870   <td> =%<nop>NEWTOPICBGCOLOR%= </td>
       
   871   <td> __SL__ , _UL_ </td>
       
   872   <td> Background color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
   873   <td> %NEWTOPICBGCOLOR% &nbsp;</td>
       
   874 </tr>
       
   875 <tr>
       
   876   <td> =%<nop>NEWTOPICFONTCOLOR%= </td>
       
   877   <td> __SL__ , _UL_ </td>
       
   878   <td> Font color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
   879   <td> %NEWTOPICFONTCOLOR% &nbsp;</td>
       
   880 </tr>
       
   881 <tr>
       
   882   <td> =%<nop>NOSEARCHALL%= </td>
       
   883   <td> __WL__ </td>
       
   884   <td> Exclude web from a =web="all"= search (set variable to =on= for hidden webs) </td>
       
   885   <td> %NOSEARCHALL% &nbsp;</td>
       
   886 </tr>
       
   887 <tr>
       
   888   <td> =%<nop>RELEASEEDITLOCKCHECKBOX%= </td>
       
   889   <td> __SL__ , __UL__ </td>
       
   890   <td> Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if =Set RELEASEEDITLOCKCHECKBOX = checked="checked"=, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do *not* 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>
       
   891   <td> %RELEASEEDITLOCKCHECKBOX% &nbsp;</td>
       
   892 </tr>
       
   893 <tr>
       
   894   <td> =%<nop>WEBBGCOLOR%= </td>
       
   895   <td> __WL__ </td>
       
   896   <td> Background color of web </td>
       
   897   <td> %WEBBGCOLOR% &nbsp;</td>
       
   898 </tr>
       
   899 <tr>
       
   900   <td> =%<nop>WEBCOPYRIGHT%= </td>
       
   901   <td> __SL__ , __WL__ </td>
       
   902   <td> Copyright notice (bottom right corner of topics) </td>
       
   903   <td> %WEBCOPYRIGHT% &nbsp;</td>
       
   904 </tr>
       
   905 <tr>
       
   906   <td> =%<nop>WEBTOPICLIST%= </td>
       
   907   <td> __WL__ </td>
       
   908   <td> Common links of web (second line of topics) </td>
       
   909   <td> %WEBTOPICLIST% &nbsp;</td>
       
   910 </tr>
       
   911 <tr>
       
   912   <td> =%<nop>WIKIWEBLIST%= </td>
       
   913   <td> __SL__ </td>
       
   914   <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
       
   915   <td> %WIKIWEBLIST% &nbsp;</td>
       
   916 </tr>
       
   917 <tr>
       
   918   <td> =%<nop>WIKIWEBMASTER%= </td>
       
   919   <td> __SL__ </td>
       
   920   <td> Webmaster email address (sender of email notifications) , is <b>%WIKIWEBMASTER%</b> </td>
       
   921   <td> %WIKIWEBMASTER% &nbsp;</td>
       
   922 </tr>
       
   923 </table>
       
   924 d103 1
       
   925 a103 1
       
   926 __Note:__ There are some more useful variables defined in the TWikiPreferences like =%<nop>BR%= for line break, colors like =%<nop>RED%= for colored text and small icons like =%<nop>H%= for a %H% Help icon.
       
   927 d105 2
       
   928 a106 2
       
   929 #SettingPrefs
       
   930 ---++ Setting Preferences
       
   931 d108 1
       
   932 a108 3
       
   933 	* 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:__ 
       
   934 	* ==<nop>Set VARIABLENAME = value==
       
   935 		* ==<nop>Set VARIABLENAME = value==
       
   936 d110 3
       
   937 a112 1
       
   938 ---++ Creating Custom Variables
       
   939 d114 1
       
   940 a114 1
       
   941 	* You can add your own Preference Variables for us across an entire site or a single web, using the standard [[#SettingPrefs][Preferences syntax]]. 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.
       
   942 d116 2
       
   943 a117 5
       
   944 <blockquote style="background-color:#ffffff">
       
   945 *Example: Create a custom logo variable the <nop>%WEB% web* <br />
       
   946 	* To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the Variable on the web's WebPreferences page, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: =LogoTopic=:
       
   947 		* ==<nop>Set MYLOGO = %<nop>PUBURL%/<nop>TWiki/LogoTopic/mylogo.gif== 
       
   948 </blockquote>
       
   949 a118 2
       
   950 -- TWiki:Main.PeterThoeny - 14 Aug 2004 <br />
       
   951 -- TWiki:Main.MikeMannix - 12 May 2002
       
   952 d121 1
       
   953 a121 3
       
   954 Crawford split up this topic into included TWikiVariablesAtoM and TWikiVariablesNtoZ.
       
   955 
       
   956 -- Main.PeterThoeny - 26 Jul 2004
       
   957 @
       
   958 
       
   959 
       
   960 1.77
       
   961 log
       
   962 @none
       
   963 @
       
   964 text
       
   965 @d1 1
       
   966 a1 1
       
   967 %META:TOPICINFO{author="PeterThoeny" date="1084088470" format="1.0" version="1.77"}%
       
   968 d9 1
       
   969 a9 1
       
   970 <nop>TWikiVariables are text strings - =%<nop>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.
       
   971 d11 3
       
   972 a13 1
       
   973 __Note:__ To leave a variable unexpanded, preceed it with an exclamation point, e.g. type =!%<nop>TOPIC%= to get !%TOPIC%.
       
   974 d23 4
       
   975 a26 420
       
   976 #VarATTACHURL
       
   977 ---+++ ATTACHURL -- attachment URL of the current topic
       
   978 	* Syntax: =%<nop>ATTACHURL%=
       
   979 	* Expands to: =%ATTACHURL%=
       
   980 	* Example: If you attach a file you can refer to it as =%<nop>ATTACHURL%/image.gif=
       
   981 	* Related: [[#VarATTACHURLPATH][ATTACHURLPATH]], [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]], FileAttachments
       
   982 
       
   983 #VarATTACHURLPATH
       
   984 ---+++ ATTACHURLPATH -- path of the attachment URL of the current topic
       
   985 	* Syntax: =%<nop>ATTACHURLPATH%=
       
   986 	* Expands to: =%ATTACHURLPATH%=
       
   987 	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURL][PUBURL]], FileAttachments
       
   988 
       
   989 #VarBASETOPIC
       
   990 ---+++ BASETOPIC -- base topic where an INCLUDE started
       
   991 	* The name of the topic where a single or nested INCLUDE started - same as =%<nop>TOPIC%= if there is no INCLUDE
       
   992 	* Syntax: =%<nop>BASETOPIC%=
       
   993 	* Related: [[#VarBASEWEB][BASEWEB]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarINCLUDE][INCLUDE]], [[#VarTOPIC][TOPIC]]
       
   994 
       
   995 #VarBASEWEB
       
   996 ---+++ BASEWEB -- base web where an INCLUDE started
       
   997 	* The web name where the includes started, e.g. the web of the first topic of nested includes. Same as =%<nop>WEB%= in case there is no include.
       
   998 	* Syntax: =%<nop>BASEWEB%=
       
   999 	* Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarINCLUDINGWEB][INCLUDINGWEB]], [[#VarINCLUDE][INCLUDE]], [[#VarWEB][WEB]]
       
  1000 
       
  1001 #VarDISPLAYTIME
       
  1002 ---+++ DISPLAYTIME -- display time
       
  1003 	* Syntax: =%<nop>DISPLAYTIME%=
       
  1004 	* Expands to: =%DISPLAYTIME%=
       
  1005 	* Related: [[#VarDISPLAYTIME2][DISPLAYTIME{"format"}]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]]
       
  1006 
       
  1007 #VarDISPLAYTIME2
       
  1008 ---+++ DISPLAYTIME{"format"} -- formatted display time
       
  1009 	* Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as =%<nop>GMTIME%=
       
  1010 	* Syntax: =%<nop>DISPLAYTIME{"format"}%=
       
  1011 	* Example: =%<nop>DISPLAYTIME{"$hou:$min"}%= expands to =%DISPLAYTIME{"$hou:$min"}%=
       
  1012 	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]]
       
  1013 
       
  1014 #VarENCODE
       
  1015 ---+++ ENCODE{"string"} -- encodes a string
       
  1016 	* Syntax: =%<nop>ENCODE{"string"}%=
       
  1017 	* Supported parameters:
       
  1018 	 | *Parameter:* | *Description:* | *Default:* |
       
  1019 	 | ="string"= | String to encode | required (can be empty) |
       
  1020 	 | =type="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;= | URL encoding |
       
  1021 	 | =type="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | (this is the default) |
       
  1022 	* Example: =%<nop>ENCODE{"spaced name"}%= expands to =%ENCODE{"spaced name"}%=
       
  1023 	* Related: [[#VarURLPARAM][URLPARAM]]
       
  1024 
       
  1025 #VarGMTIME
       
  1026 ---+++ GMTIME -- GM time
       
  1027 	* Syntax: =%<nop>GMTIME%=
       
  1028 	* Expands to: =%GMTIME%=
       
  1029 	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME2][GMTIME{"format"}]], [[#VarSERVERTIME][SERVERTIME]]
       
  1030 
       
  1031 #VarGMTIME2
       
  1032 ---+++ GMTIME{"format"} -- formatted GM time
       
  1033 	* Syntax: =%<nop>GMTIME{"format"}%=
       
  1034 	* Supported variables:
       
  1035 	  | *Variable:* | *Unit:* | *Example* |
       
  1036 	  | =$seconds= | seconds | 59 |
       
  1037 	  | =$minutes= | minutes | 59 |
       
  1038 	  | =$hours= | hours | 23 |
       
  1039 	  | =$day= | day of month | 31 |
       
  1040 	  | =$wday= | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu |
       
  1041 	  | =$month= | month in ISO format | Dec |
       
  1042 	  | =$mo= | 2 digit month | 12 |
       
  1043 	  | =$year= | 4 digit year | 1999 |
       
  1044 	  | =$ye= | 2 digit year | 99 |
       
  1045 	  | =$tz= | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT |
       
  1046 	  | =$iso= | ISO format timestamp | %GMTIME{"$iso"}% |
       
  1047 	  | =$rcs= | RCS format timestamp | %GMTIME{"$rcs"}% |
       
  1048 	  | =$http= | E-mail & http format timestamp | %GMTIME{"$http"}% |
       
  1049 	* Variables can be shortened to 3 characters
       
  1050 	* Example: =%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}%= expands to =%GMTIME{"$day $month, $year - $hour:$min:$sec"}%=
       
  1051 	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]]
       
  1052 
       
  1053 #VarHOMETOPIC
       
  1054 ---+++ HOMETOPIC -- home topic in each web
       
  1055 	* Syntax: =%<nop>HOMETOPIC%=
       
  1056 	* Expands to: =%HOMETOPIC%=, renders as [[%HOMETOPIC%]]
       
  1057 	* Related: [[#VarNOTIFYTOPIC][NOTIFYTOPIC]], [[#VarSTATISTICSTOPIC][STATISTICSTOPIC]], [[#VarTOPIC][TOPIC]]
       
  1058 
       
  1059 #VarHTTPHOST
       
  1060 ---+++ HTTP_HOST -- environment variable
       
  1061 	* Syntax: =%<nop>HTTP_HOST%=
       
  1062 	* Expands to: =%HTTP_HOST%=
       
  1063 	* Related: [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarREMOTEUSER][REMOTE_USER]]
       
  1064 
       
  1065 #VarICON
       
  1066 ---+++ ICON{"type"} -- small icon of common attachment types
       
  1067 	* Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
       
  1068 	* Syntax: =%<nop>ICON{"type"}%=
       
  1069 	* Samples: %ICON{"bmp"}% =bmp=, %ICON{"doc"}% =doc=, %ICON{"gif"}% =gif=, %ICON{"hlp"}% =hlp=, %ICON{"html"}% =html=, %ICON{"mp3"}% =mp3=, %ICON{"pdf"}% =pdf=, %ICON{"ppt"}% =ppt=, %ICON{"txt"}% =txt=, %ICON{"xls"}% =xls=, %ICON{"xml"}% =xml=, %ICON{"zip"}% =zip=
       
  1070 	* Example: =%<nop>ICON{"pdf"}%= expands to %ICON{"pdf"}%
       
  1071 	* Related: %WIKIPREFSTOPIC%, FileAttachments, TWikiDocGraphics
       
  1072 
       
  1073 #VarINCLUDE
       
  1074 ---+++ INCLUDE{"page"} -- include other topics or web pages
       
  1075 	* Syntax: =%<nop>INCLUDE{"page" ...}%=
       
  1076 	* Supported parameters:
       
  1077 	| *Parameter:* | *Description:* | *Default:* |
       
  1078 	| ="SomeTopic"= | The name of a topic located in the current web, i.e. =%<nop>INCLUDE{"WebNotify"}%= | |
       
  1079 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%= | |
       
  1080 	| ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://twiki.org/"}%= | |
       
  1081 	| =pattern="..."= | A RegularExpression pattern to include a subset of a topic or page | none |
       
  1082 	| =rev="1.2"= | Include a previous topic revision; N/A for URLs | top revision |
       
  1083 	| =warn="off"= | Warn if topic include fails: Fail silently (if =off=); output default warning (if set to =on=); else, output specific text (use =$topic= for topic name) | =%INCLUDE- WARNING%= [[TWikiPreferences][preferences]] setting |
       
  1084 	* Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarBASEWEB][BASEWEB]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarINCLUDINGWEB][INCLUDINGWEB]], IncludeTopicsAndWebPages
       
  1085 
       
  1086 #VarINCLUDINGTOPIC
       
  1087 ---+++ INCLUDINGTOPIC -- name of topic that includes current topic
       
  1088 	* The name of the topic that includes the current topic - same as =%<nop>TOPIC%= in case there is no include
       
  1089 	* Syntax: =%<nop>INCLUDINGTOPIC%=
       
  1090 	* Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarINCLUDINGWEB][INCLUDINGWEB]], [[#VarINCLUDE][INCLUDE]], [[#VarTOPIC][TOPIC]]
       
  1091 
       
  1092 
       
  1093 #VarINCLUDINGWEB
       
  1094 ---+++ INCLUDINGWEB -- web that includes current topic
       
  1095 	* The web name of the topic that includes the current topic - same as =%<nop>WEB%= if there is no INCLUDE.
       
  1096 	* Syntax: =%<nop>INCLUDINGWEB%=
       
  1097 	* Related: [[#VarBASEWEB][BASEWEB]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarINCLUDE][INCLUDE]], [[#VarWEB][WEB]]
       
  1098 
       
  1099 #VarMAINWEB
       
  1100 ---+++ MAINWEB -- name of Main web
       
  1101 	* The web containing %MAINWEB%.%WIKIUSERSTOPIC%, %MAINWEB%.OfficeLocations and %MAINWEB%.TWikiGroups
       
  1102 	* Syntax: =%<nop>MAINWEB%=
       
  1103 	* Expands to: =%MAINWEB%=
       
  1104 	* Related: [[#VarTWIKIWEB][TWIKIWEB]]
       
  1105 
       
  1106 #VarMETASEARCH
       
  1107 ---+++ METASEARCH -- special search of meta data
       
  1108 	* Syntax: =%<nop>METASEARCH{...}%=
       
  1109 	* Supported parameters:
       
  1110 	  | *Parameter:* | *Description:* | *Default:* |
       
  1111 	  | =type="topicmoved"= | What sort of search is required? <br /> ="topicmoved"= if search for a topic that may have been moved <br /> ="parent"= if searching for topics that have a specific parent i.e. its children | required |
       
  1112 	  | =web="%<nop>WEB%"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. | required |
       
  1113 	  | =topic="%<nop>TOPIC%"= | The topic the search relates to | required |
       
  1114 	  | =title="Title"= | Text that is prepended to any search results | required |
       
  1115 	* Example: =%<nop>METASEARCH{type="topicmoved" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="This topic used to exist and was moved to: "}%=
       
  1116 	* Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:<br /> =%<nop>METASEARCH{type="parent" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="Children: "}%=
       
  1117 	* Related: [[#VarSEARCH][SEARCH]]
       
  1118 
       
  1119 #VarNOTIFYTOPIC
       
  1120 ---+++ NOTIFYTOPIC -- name of the notify topic
       
  1121 	* Syntax: =%<nop>NOTIFYTOPIC%=
       
  1122 	* Expands to: =%NOTIFYTOPIC%=, renders as [[%NOTIFYTOPIC%]]
       
  1123 	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarSTATISTICSTOPIC][STATISTICSTOPIC]], [[#VarTOPIC][TOPIC]]
       
  1124 
       
  1125 #VarPUBURL
       
  1126 ---+++ PUBURL -- the base URL of attachments
       
  1127 	* Syntax: =%<nop>PUBURL%=
       
  1128 	* Expands to: =%PUBURL%=
       
  1129 	* Example: You can refer to a file attached to another topic with =%<nop>PUBURL%/%<nop>WEB%/OtherTopic/image.gif=
       
  1130 	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]], FileAttachments
       
  1131 
       
  1132 #VarPUBURLPATH
       
  1133 ---+++ PUBURLPATH -- the base URL path of attachments
       
  1134 	* Syntax: =%<nop>PUBURLPATH%=
       
  1135 	* Expands to: =%PUBURLPATH%=
       
  1136 	* Related: [[#VarATTACHURL][ATTACHURL]], [[#VarPUBURL][PUBURL]], FileAttachments
       
  1137 
       
  1138 #VarREMOTEADDR
       
  1139 ---+++ REMOTE_ADDR -- environment variable
       
  1140 	* Syntax: =%<nop>REMOTE_ADDR%=
       
  1141 	* Expands to: =%REMOTE_ADDR%=
       
  1142 	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarREMOTEUSER][REMOTE_USER]]
       
  1143 
       
  1144 #VarREMOTEPORT
       
  1145 ---+++ REMOTE_PORT -- environment variable
       
  1146 	* Syntax: =%<nop>REMOTE_PORT%=
       
  1147 	* Expands to: <code>%REMOTE_PORT%</code>
       
  1148 	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEUSER][REMOTE_USER]]
       
  1149 
       
  1150 #VarREMOTEUSER
       
  1151 ---+++ REMOTE_USER -- environment variable
       
  1152 	* Syntax: =%<nop>REMOTE_USER%=
       
  1153 	* Expands to: <code>%REMOTE_USER%</code>
       
  1154 	* Related: [[#VarHTTPHOST][HTTP_HOST]], [[#VarREMOTEADDR][REMOTE_ADDR]], [[#VarREMOTEPORT][REMOTE_PORT]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]]
       
  1155 
       
  1156 #VarSCRIPTURL
       
  1157 ---+++ SCRIPTURL -- script URL of %WIKITOOLNAME%
       
  1158 	* Syntax: =%<nop>SCRIPTURL%=
       
  1159 	* Expands to: =%SCRIPTURL%=
       
  1160 	* Example: To get the authenticated version of current topic write =%<nop>SCRIPTURL%/viewauth%<nop>SCRIPTSUFFIX%/%<nop>WEB%/%<nop>TOPIC%= which expands to =%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%=
       
  1161 	* Related: [[#VarPUBURL][PUBURL]], [[#VarSCRIPTSUFFIX][SCRIPTSUFFIX]], [[#VarSCRIPTURLPATH][SCRIPTURLPATH]]
       
  1162 
       
  1163 #VarSCRIPTURLPATH
       
  1164 ---+++ SCRIPTURLPATH -- script URL path of %WIKITOOLNAME%
       
  1165 	* Syntax: =%<nop>SCRIPTURLPATH%=
       
  1166 	* Expands to: =%SCRIPTURLPATH%=
       
  1167 	* Related: [[#VarPUBURLPATH][PUBURLPATH]], [[#VarSCRIPTURL][SCRIPTURL]]
       
  1168 
       
  1169 #VarSCRIPTSUFFIX
       
  1170 ---+++ SCRIPTSUFFIX -- script suffix
       
  1171 	* Some %WIKITOOLNAME% installations require a file extension for CGI scripts like =.pl= or =.cgi=
       
  1172 	* Syntax: =%<nop>SCRIPTSUFFIX%=
       
  1173 	* Expands to: <code>%SCRIPTSUFFIX%</code>
       
  1174 	* Related: [[#VarSCRIPTURL][SCRIPTURL]]
       
  1175 
       
  1176 #VarSEARCH
       
  1177 ---+++ SEARCH{"text"} -- search content
       
  1178 	* Inline search, shows a search result embedded in a topic
       
  1179 	* Syntax: =%<nop>SEARCH{"text" ...}%=
       
  1180 	* Supported parameters: [1]
       
  1181 	  | *Parameter:* | *Description:* | *Default:* |
       
  1182 	  | ="text"= | Search term. Is a keyword search, literal search or regular expression search, depending on the =type= parameter. SearchHelp has more | required |
       
  1183 	  | =search="text"= | (Alternative to above) | N/A |
       
  1184 	  | =web="Name"= <br /> =web="%MAINWEB%, Know"= <br /> =web="all"= | Wiki web to search: A web, a list of webs separated by comma, or =all= webs. [2] | Current web |
       
  1185 	  | =topic="%WEBPREFSTOPIC%"= <br /> =topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | All topics in a web |
       
  1186 	  | =excludetopic="Web*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None |
       
  1187 	  | =type="keyword"= <br /> =type="literal"= <br /> =type="regex"= | Do a keyword search like =soap "web service" -shampoo=; a literal search like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%<nop>SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting (%SEARCHVARDEFAULTTYPE%) |
       
  1188 	  | =scope="topic"= <br /> =scope="text"= <br /> =scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= |
       
  1189 	  | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort | Sort by topic name |
       
  1190 	  | =limit="all"= <br /> =limit="16"= | Limit the number of results returned. This is done after sorting in case =order= is specified | All results |
       
  1191 	  | =reverse="on"= | Reverse the direction of the search | Ascending search |
       
  1192 	  | =casesensitive="on"= | Case sensitive search | Ignore case |
       
  1193 	  | =nosummary="on"= | Show topic title only | Show topic summary |
       
  1194 	  | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
       
  1195 	  | =nosearch="on"= | Suppress search string | Show search string |
       
  1196 	  | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
       
  1197 	  | =nototal="on"= | Do not show number of topics found | Show number |
       
  1198 	  | =header="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables &amp; examples | Results in table |
       
  1199 	  | =expandvariables="on"= | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%<nop>CALC{}%= instead of the formula | Raw text |
       
  1200 	  | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic |
       
  1201 	  | =separator=", "= | Line separator between hits | Newline ="$n"= |
       
  1202 	* Example: =%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%=
       
  1203 	* Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"%= _(displays results in a table with header - [[FormattedSearch][details]])_
       
  1204 	* %H% If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%=
       
  1205 	* Related: [[#VarMETASEARCH][METASEARCH]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEBLIST][WEBLIST]], FormattedSearch
       
  1206 
       
  1207 	* [1] __Note__: The search form uses identical names for input fields.
       
  1208 	* [2] __Note__: A web can be excluded from a =web="all"= search if you define a =NOSEARCHALL=on= variable in its %WEBPREFSTOPIC%
       
  1209 
       
  1210 #VarSERVERTIME
       
  1211 ---+++ SERVERTIME -- server time
       
  1212 	* Syntax: =%<nop>SERVERTIME%=
       
  1213 	* Expands to: =%SERVERTIME%=
       
  1214 	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME2][SERVERTIME{"format"}]]
       
  1215 
       
  1216 #VarSERVERTIME2
       
  1217 ---+++ SERVERTIME{"format"} -- formatted server time
       
  1218 	* Same format qualifiers as =%<nop>GMTIME%=
       
  1219 	* Syntax: =%<nop>SERVERTIME{"format"}%=
       
  1220 	* Example: =%<nop>SERVERTIME{"$hou:$min"}%= expands to =%SERVERTIME{"$hou:$min"}%=
       
  1221 	* Related: [[#VarDISPLAYTIME][DISPLAYTIME]], [[#VarGMTIME][GMTIME]], [[#VarSERVERTIME][SERVERTIME]]
       
  1222 
       
  1223 #VarSPACEDTOPIC
       
  1224 ---+++ SPACEDTOPIC -- topic name, spaced and encoded
       
  1225 	* The current topic name with added spaces, for regular expression search of Ref-By
       
  1226 	* Syntax: =%<nop>SPACEDTOPIC%=
       
  1227 	* Expands to: =%SPACEDTOPIC%=
       
  1228 	* Related: [[#VarTOPIC][TOPIC]]
       
  1229 
       
  1230 #VarSTARTINCLUDE
       
  1231 ---+++ STARTINCLUDE -- start position of topic text if included
       
  1232 	* If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everyting exept the =%<nop>STARTINCLUDE%= variable itself.
       
  1233 	* Syntax: =%<nop>STARTINCLUDE%=
       
  1234 	* Related: [[#VarINCLUDE][INCLUDE]], [[#VarSTOPINCLUDE][STOPINCLUDE]]
       
  1235 
       
  1236 #VarSTATISTICSTOPIC
       
  1237 ---+++ STATISTICSTOPIC -- name of statistics topic
       
  1238 	* Syntax: =%<nop>STATISTICSTOPIC%=
       
  1239 	* Expands to: =%STATISTICSTOPIC%=, renders as [[%STATISTICSTOPIC%]]
       
  1240 	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarNOTIFYTOPIC][NOTIFYTOPIC]], [[#VarTOPIC][TOPIC]]
       
  1241 
       
  1242 #VarSTOPINCLUDE
       
  1243 ---+++ STOPINCLUDE -- end position of topic text if included
       
  1244 	* 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 =%<nop>STOPINCLUDE%= variable itself.
       
  1245 	* Syntax: =%<nop>STOPINCLUDE%=
       
  1246 	* Related: [[#VarINCLUDE][INCLUDE]], [[#VarSTARTINCLUDE][STARTINCLUDE]]
       
  1247 
       
  1248 #VarTOC
       
  1249 ---+++ TOC -- table of contents of current topic
       
  1250 	* Syntax: =%<nop>TOC%=
       
  1251 	* Related: [[#VarTOC2][TOC{"SomeTopic"}]]
       
  1252 
       
  1253 #VarTOC2
       
  1254 ---+++ TOC{"Topic"} -- table of contents
       
  1255 	* Syntax: =%<nop>TOC{"SomeTopic" ...}%=
       
  1256 	* Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. Any heading text after ="!!"= is excluded from the TOC; for example, write ="---+!! text"= if you do not want to list a header in the TOC
       
  1257 	* Supported parameters:
       
  1258 	 | *Parameter:* | *Description:* | *Default:* |
       
  1259 	 | ="TopicName"= | topic name | Current topic |
       
  1260 	 | =web="Name"= | Name of web | Current web |
       
  1261 	 | =depth="2"= | Limit depth of headings shown in TOC | 6 |
       
  1262 	 | =title="Some text"= | Title to appear at top of TOC | none |
       
  1263 	* Example: =%<nop>TOC{depth="2"}%=
       
  1264 	* Example: =%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%" title="Contents:"}%=
       
  1265 	* Related: [[#VarTOC][TOC]]
       
  1266 
       
  1267 #VarTOPIC
       
  1268 ---+++ TOPIC -- name of current topic
       
  1269 	* Syntax: =%<nop>TOPIC%=
       
  1270 	* Expands to: =%TOPIC%=, renders as [[%TOPIC%]]
       
  1271 	* Related: [[#VarBASETOPIC][BASETOPIC]], [[#VarINCLUDINGTOPIC][INCLUDINGTOPIC]], [[#VarTOPICLIST][TOPICLIST]], [[#VarWEB][WEB]]
       
  1272 
       
  1273 #VarTOPICLIST
       
  1274 ---+++ TOPICLIST{"format"} -- topic index of a web
       
  1275 	* The "format" defines the format of one topic item. It may include variables: The =$name= variable gets expanded to the topic name; the =$web= variable gets expanded to the name of the web.
       
  1276 	* Syntax: =%<nop>TOPICLIST{"format" ...}%=
       
  1277 	* Supported parameters:
       
  1278 	 | *Parameter:* | *Description:* | *Default:* |
       
  1279 	 | ="format"= | Format of one line, may include =$name= and =$web= variables | ="$name"= |
       
  1280 	 | =format="format"= | (Alternative to above) | ="$name"= |
       
  1281 	 | =separator=", "= | line separator | ="\n"= (new line) |
       
  1282 	 | =web="Name"= | Name of web | Current web |
       
  1283 	* Example: =%<nop>TOPICLIST{"	* $web.$name"}%= creates a bullet list of all topics
       
  1284 	* Example: =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics
       
  1285 	* Example: =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus)
       
  1286 	* Related: [[#VarSEARCH][SEARCH]], [[#VarWEBLIST][WEBLIST]]
       
  1287 
       
  1288 #VarTWIKIWEB
       
  1289 ---+++ TWIKIWEB -- name of TWiki documentation web
       
  1290 	* The web containing all documentation and site-wide preference settings for %WIKITOOLNAME%
       
  1291 	* Syntax: =%<nop>TWIKIWEB%=
       
  1292 	* Expands to: =%TWIKIWEB%=
       
  1293 	* Related: [[#VarMAINWEB][MAINWEB]]
       
  1294 
       
  1295 #VarURLPARAM
       
  1296 ---+++ URLPARAM{"name"} -- get value of a URL parameter
       
  1297 	* Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
       
  1298 	* Syntax: =%<nop>URLPARAM{"name"}%=
       
  1299 	* Supported parameters:
       
  1300 	  | *Parameter:* | *Description:* | *Default:* |
       
  1301 	  | ="name"= | The name of a URL parameter | required |
       
  1302 	  | =default="..."= | Default value in case parameter is empty or missing | empty string |
       
  1303 	  | =newline="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
       
  1304 	  | =encode="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;=. This is needed if text is put into an HTML form field | no encoding |
       
  1305 	  | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
       
  1306 	  | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= tag. A format can be specified, with =$item= indicating the element, e.g. =multiple="Option: $item"= | first element |
       
  1307 	  | =separator=", "= | Separator between multiple selections. Only relevant if multiple is specified | ="\n"= (new line) |
       
  1308 	* Example: =%<nop>URLPARAM{"skin"}%= returns =print= for a =.../view/%WEB%/%TOPIC%?skin=print= URL. [[%SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC%?skin=print#VarURLPARAM][Test this]]: %URLPARAM{"skin"}%
       
  1309 	* Related: [[#VarSEARCH][SEARCH]], FormattedSearch
       
  1310 
       
  1311 #VarUSERNAME
       
  1312 ---+++ USERNAME -- your login username
       
  1313 	* TWiki makes names available in three formats: USERNAME like =jsmith=, WIKINAME like =JohnSmith= and WIKIUSERNAME like =%MAINWEB%.JohnSmith=. A user is a %MAINWEB%.TWikiGuest in case the topic is not authenticated
       
  1314 	* Syntax: =%<nop>USERNAME%=
       
  1315 	* Expands to: =%USERNAME%=
       
  1316 	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarWIKINAME][WIKINAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], TWikiUserAuthentication
       
  1317 
       
  1318 #VarVAR
       
  1319 ---+++ VAR{"NAME" web="Web"} -- get a preference value from another web 
       
  1320 	* Syntax: =%<nop>VAR{"NAME" web="Web"}%=
       
  1321 	* Example: To get =%<nop>WEBBGCOLOR%= of the %MAINWEB% web write =%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, which expands to =%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=
       
  1322 	* Related: [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]]
       
  1323 
       
  1324 #VarWEB
       
  1325 ---+++ WEB -- name of current web
       
  1326 	* Syntax: =%<nop>WEB%=
       
  1327 	* Expands to: =%WEB%=
       
  1328 	* Related: [[#VarBASEWEB][BASEWEB]], [[#VarINCLUDINGWEB][INCLUDINGWEB]], [[#VarTOPIC][TOPIC]]
       
  1329 
       
  1330 #VarWEBLIST
       
  1331 ---+++ WEBLIST{"format"} -- index of all webs
       
  1332 	* List of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
       
  1333 	* Syntax: =%<nop>WEBLIST{"format" ...}%=
       
  1334 	* Supported parameters:
       
  1335 	  | *Parameter:* | *Description:* | *Default:* |
       
  1336 	  | ="format"= | Format of one line, may include =$name= variable | ="$name"= |
       
  1337 	  | =format="format"= | (Alternative to above) | ="$name"= |
       
  1338 	  | =separator=", "= | line separator | ="\n"= (new line) |
       
  1339 	  | =webs="public"=	| comma sep list of Web, public expands to all non-hidden | ="public"= |
       
  1340 	  | =marker="selected"= | Text for =$marker= where item matches =selection=, otherwise equals =""= | ="selected"= |
       
  1341 	  | =selection="%<nop>WEB%"= | Current value to be selected in list | =section="%<nop>WEB%"= |
       
  1342 	* Example: =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
       
  1343 	* Example: =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted.
       
  1344 	* Related: [[#VarTOPICLIST][TOPICLIST]], [[#VarSEARCH][SEARCH]]
       
  1345 
       
  1346 #VarWEBPREFSTOPIC
       
  1347 ---+++ WEBPREFSTOPIC -- name of web preferences topic
       
  1348 	* Syntax: =%<nop>WEBPREFSTOPIC%=
       
  1349 	* Expands to: =%WEBPREFSTOPIC%=, renders as [[%WEBPREFSTOPIC%]]
       
  1350 	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWIKIPREFSTOPIC][WIKIPREFSTOPIC]], [[#VarVAR][VAR]]
       
  1351 
       
  1352 #VarWIKIHOMEURL
       
  1353 ---+++ WIKIHOMEURL -- site home URL
       
  1354 	* The base URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
       
  1355 	* Syntax: =%<nop>WIKIHOMEURL%=
       
  1356 	* Expands to: =%WIKIHOMEURL%=
       
  1357 	* Related: [[#VarWIKITOOLNAME][WIKITOOLNAME]]
       
  1358 
       
  1359 #VarWIKINAME
       
  1360 ---+++ WIKINAME -- your Wiki username
       
  1361 	* The WikiName is the same as %<nop>USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic
       
  1362 	* Syntax: =%<nop>WIKINAME%=
       
  1363 	* Expands to: =%WIKINAME%=
       
  1364 	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKIUSERNAME][WIKIUSERNAME]], [[#VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]]
       
  1365 
       
  1366 #VarWIKIPREFSTOPIC
       
  1367 ---+++ WIKIPREFSTOPIC -- name of site-wide preferences topic
       
  1368 	* Syntax: =%<nop>WIKIPREFSTOPIC%=
       
  1369 	* Expands to: =%WIKIPREFSTOPIC%=, renders as [[%WIKIPREFSTOPIC%]]
       
  1370 	* Related: [[#VarHOMETOPIC][HOMETOPIC]], [[#VarWEBPREFSTOPIC][WEBPREFSTOPIC]]
       
  1371 
       
  1372 #VarWIKITOOLNAME
       
  1373 ---+++ WIKITOOLNAME -- name of your TWiki site
       
  1374 	* Syntax: =%<nop>WIKITOOLNAME%=
       
  1375 	* Expands to: =%WIKITOOLNAME%=
       
  1376 	* Related: [[#VarWIKIHOMEURL][WIKIHOMEURL]], [[#VarWIKIVERSION][WIKIVERSION]]
       
  1377 
       
  1378 #VarWIKIUSERNAME
       
  1379 ---+++ WIKIUSERNAME -- your Wiki username with web prefix
       
  1380 	* Your %<nop>WIKINAME% with %MAINWEB% web prefix, useful to point to your %WIKITOOLNAME% home page
       
  1381 	* Syntax: =%<nop>WIKIUSERNAME%=
       
  1382 	* Expands to: =%WIKIUSERNAME%=, renders as %WIKIUSERNAME%
       
  1383 	* Related: [[#VarREMOTEUSER][REMOTE_USER]], [[#VarUSERNAME][USERNAME]], [[#VarWIKINAME][WIKINAME]]
       
  1384 
       
  1385 #VarWIKIUSERSTOPIC
       
  1386 ---+++ WIKIUSERSTOPIC -- name of topic listing all registers users
       
  1387 	* Syntax: =%<nop>WIKIUSERSTOPIC%=
       
  1388 	* Expands to: =%WIKIUSERSTOPIC%=, with %MAINWEB% prefix renders as %MAINWEB%.%WIKIUSERSTOPIC%
       
  1389 	* Related: [[#VarWIKIUSERNAME][WIKIUSERNAME]]
       
  1390 
       
  1391 #VarWIKIVERSION
       
  1392 ---+++ WIKIVERSION -- the version of the installed TWiki engine
       
  1393 	* Syntax: =%<nop>WIKIVERSION%=
       
  1394 	* Expands to: =%WIKIVERSION%=
       
  1395 	* Related: [[#VarWIKITOOLNAME][WIKITOOLNAME]]
       
  1396 d32 4
       
  1397 a35 1
       
  1398 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):
       
  1399 d39 1
       
  1400 a39 1
       
  1401   <th width="160"> Variable: </th><th> Level: </th><th> What: </th>
       
  1402 d45 1
       
  1403 d51 1
       
  1404 d57 1
       
  1405 d63 1
       
  1406 d69 1
       
  1407 d75 1
       
  1408 d81 1
       
  1409 d87 1
       
  1410 d93 1
       
  1411 d99 1
       
  1412 d105 1
       
  1413 d111 1
       
  1414 d117 1
       
  1415 d123 1
       
  1416 d129 1
       
  1417 d135 1
       
  1418 d141 1
       
  1419 d147 1
       
  1420 d153 1
       
  1421 d159 1
       
  1422 d165 1
       
  1423 d171 1
       
  1424 d177 1
       
  1425 d183 1
       
  1426 d189 1
       
  1427 d195 1
       
  1428 d218 1
       
  1429 a218 1
       
  1430 -- TWiki:Main.PeterThoeny - 09 May 2004 %BR%
       
  1431 d220 5
       
  1432 @
       
  1433 
       
  1434 
       
  1435 1.76
       
  1436 log
       
  1437 @none
       
  1438 @
       
  1439 text
       
  1440 @d1 1
       
  1441 a1 1
       
  1442 %META:TOPICINFO{author="PeterThoeny" date="1080805858" format="1.0" version="1.76"}%
       
  1443 d21 42
       
  1444 a62 46
       
  1445 <table cellspacing="0" cellpadding="2" border="1" align="center" style="background-color:#f5f5f5">
       
  1446 <tr>
       
  1447   <th width="160"> Variable: </th><th> Expanded to: </th>
       
  1448 </tr><tr>
       
  1449   <td> =%<nop>WIKIHOMEURL%= </td>
       
  1450   <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b> </td>
       
  1451 </tr><tr>
       
  1452   <td> =%<nop>SCRIPTURL%= </td>
       
  1453   <td> The script URL of %WIKITOOLNAME%, is <b>%SCRIPTURL%</b></td>
       
  1454 </tr><tr>
       
  1455   <td> =%<nop>SCRIPTURLPATH%= </td>
       
  1456   <td> The path of the script URL of %WIKITOOLNAME%, is <b>%SCRIPTURLPATH%</b></td>
       
  1457 </tr><tr>
       
  1458   <td> =%<nop>SCRIPTSUFFIX%= </td>
       
  1459   <td> The script suffix, ex: =.pl=, =.cgi= is <b>%SCRIPTSUFFIX%</b></td>
       
  1460 </tr><tr>
       
  1461   <td> =%<nop>PUBURL%= </td>
       
  1462   <td> The public URL of TWiki, is <b>%PUBURL%</b> <br /> Example: You can refer to a file attached to another topic as =<b>%<nop>PUBURL%/%<nop>WEB%/OtherTopic/image.gif</b>=  </td>
       
  1463 </tr><tr>
       
  1464   <td> =%<nop>PUBURLPATH%= </td>
       
  1465   <td> The path of the public URL of %WIKITOOLNAME%, is <b>%PUBURLPATH%</b> </td>
       
  1466 </tr><tr>
       
  1467   <td> =%<nop>ATTACHURL%= </td>
       
  1468   <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 =<b>%<nop>ATTACHURL%/image.gif</b>= </td>
       
  1469 </tr><tr>
       
  1470   <td> =%<nop>ATTACHURLPATH%= </td>
       
  1471   <td> The path of the attachment URL of the current topic, is <b>%ATTACHURLPATH%</b> </td>
       
  1472 </tr><tr>
       
  1473   <td> =%<nop>ICON{"type"}%= </td>
       
  1474   <td> Small 16x16 pixel icon of common attachment types, like %ICON{"bmp"}% =bmp=, %ICON{"doc"}% =doc=, %ICON{"gif"}% =gif=, %ICON{"hlp"}% =hlp=, %ICON{"html"}% =html=, %ICON{"mp3"}% =mp3=, %ICON{"pdf"}% =pdf=, %ICON{"ppt"}% =ppt=, %ICON{"txt"}% =txt=, %ICON{"xls"}% =xls=, %ICON{"xml"}% =xml=, %ICON{"zip"}% =zip=, etc. Specify file type only, file name, or full path name. Example: =%<nop>ICON{"pdf"}%= returns %ICON{"pdf"}% </td>
       
  1475 </tr><tr>
       
  1476   <td> =%<nop>URLPARAM{"name"}%= </td>
       
  1477   <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:
       
  1478 	 | *Parameter:* | *Description:* | *Default:* |
       
  1479 	 | ="name"= | The name of a URL parameter | required |
       
  1480 	 | =default="..."= | Default value in case parameter is empty or missing | empty string |
       
  1481 	 | =newline="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
       
  1482 	 | =encode="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;=. This is needed if text is put into an HTML form field | no encoding |
       
  1483 	 | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
       
  1484 	 | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= tag. A format can be specified, with =$item= indicating the element, e.g. =multiple="Option: $item"= | first element |
       
  1485 	 | =separator=", "= | Separator between multiple selections. Only relevant if multiple is specified | ="\n"= (new line) |
       
  1486 	 Example: =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b>
       
  1487 </td>
       
  1488 </tr><tr>
       
  1489   <td> =%<nop>ENCODE{"string"}%= </td>
       
  1490   <td> Encodes a string. Supported parameters:
       
  1491 d67 55
       
  1492 a121 137
       
  1493 	 Example: =%<nop>ENCODE{"spaced name"}%= returns <b>%ENCODE{"spaced name"}%</b> </td>
       
  1494 </tr><tr>
       
  1495   <td> =%<nop>WIKITOOLNAME%= </td>
       
  1496   <td> The name of your TWiki site - <b>%WIKITOOLNAME%</b> </td>
       
  1497 </tr><tr>
       
  1498   <td> =%<nop>WIKIVERSION%= </td>
       
  1499   <td> Your current TWiki version - <b>%WIKIVERSION%</b> </td>
       
  1500 </tr><tr>
       
  1501   <td> =%<nop>USERNAME%= </td>
       
  1502   <td> Your login username - <b>%USERNAME%</b> </td>
       
  1503 </tr><tr>
       
  1504   <td> =%<nop>WIKINAME%= </td>
       
  1505   <td> Your Wiki username. Same as %<nop>USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic. Is <b>%WIKINAME%</b> </td>
       
  1506 </tr><tr>
       
  1507   <td> =%<nop>WIKIUSERNAME%= </td>
       
  1508   <td> Your %<nop>WIKINAME% including the %MAINWEB% web name - always use full signatures - <b>%WIKIUSERNAME%</b> </td>
       
  1509 </tr><tr>
       
  1510   <td> =%<nop>MAINWEB%= </td>
       
  1511   <td> The web containing %MAINWEB%.%WIKIUSERSTOPIC%, %MAINWEB%.OfficeLocations and %MAINWEB%.TWikiGroups is <b>%MAINWEB%</b> </td>
       
  1512 </tr><tr>
       
  1513   <td> =%<nop>TWIKIWEB%= </td>
       
  1514   <td> The web containing all documentation and site-wide preference settings for %WIKITOOLNAME% - <b>%TWIKIWEB%</b> </td>
       
  1515 </tr><tr>
       
  1516   <td> =%<nop>WEB%= </td>
       
  1517   <td> The current web is <b>%WEB%</b> </td>
       
  1518 </tr><tr>
       
  1519   <td> =%<nop>BASEWEB%= </td>
       
  1520   <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as =%<nop>WEB%= in case there is no include. </td>
       
  1521 </tr><tr>
       
  1522   <td> =%<nop>INCLUDINGWEB%= </td>
       
  1523   <td> The web name of the topic that includes the current topic -  same as =%<nop>WEB%= if there is no INCLUDE. </td>
       
  1524 </tr><tr>
       
  1525   <td> =%<nop>HOMETOPIC%= </td>
       
  1526   <td> The home topic in each web - <b>[[%HOMETOPIC%]]</b> </td>
       
  1527 </tr><tr>
       
  1528   <td> =%<nop>NOTIFYTOPIC%= </td>
       
  1529   <td> The notify topic in each web - <b>[[%NOTIFYTOPIC%]]</b> </td>
       
  1530 </tr><tr>
       
  1531   <td> =%<nop>WIKIUSERSTOPIC%= </td>
       
  1532   <td> The index topic of all registered users - <b>%WIKIUSERSTOPIC%</b></td>
       
  1533 </tr><tr>
       
  1534   <td> =%<nop>WIKIPREFSTOPIC%= </td>
       
  1535   <td> The site-wide preferences topic - <b>%WIKIPREFSTOPIC%</b> </td>
       
  1536 </tr><tr>
       
  1537   <td> =%<nop>WEBPREFSTOPIC%= </td>
       
  1538   <td> The local web preferences topic in each web - <b>%WEBPREFSTOPIC%</b> </td>
       
  1539 </tr><tr>
       
  1540   <td> =%<nop>STATISTICSTOPIC%= </td>
       
  1541   <td> The web statistics topic <b>%STATISTICSTOPIC%</b> </td>
       
  1542 </tr><tr>
       
  1543   <td> =%<nop>TOPIC%= </td>
       
  1544   <td> The current topic name - <b>%TOPIC%</b> </td>
       
  1545 </tr><tr>
       
  1546   <td> =%<nop>BASETOPIC%= </td>
       
  1547   <td> The name of the topic where a single or nested INCLUDE started - same as =%<nop>TOPIC%= if there is no INCLUDE. </td>
       
  1548 </tr><tr>
       
  1549   <td> =%<nop>INCLUDINGTOPIC%= </td>
       
  1550   <td> The name of the topic that includes the current topic. Same as =%<nop>TOPIC%= in case there is no include. </td>
       
  1551 </tr><tr>
       
  1552   <td> =%<nop>SPACEDTOPIC%= </td>
       
  1553   <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b>%SPACEDTOPIC%</b> </td>
       
  1554 </tr><tr>
       
  1555   <td> =%<nop>TOPICLIST{"format"}%= </td>
       
  1556   <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The =$name= variable gets expanded to the topic name; the =$web= variable gets expanded to the name of the web.
       
  1557 	 Parameters are format, separator and web:
       
  1558 	 | *Parameter:* | *Description:* | *Default:* |
       
  1559 	 | ="format"= | Format of one line, may include =$name= and =$web= variables | ="$name"= |
       
  1560 	 | =format="format"= | (Alternative to above) | ="$name"= |
       
  1561 	 | =separator=", "= | line separator | ="\n"= (new line) |
       
  1562 	 | =web="Name"= | Name of web | Current web |
       
  1563 	 Examples:
       
  1564 	 <br /> =%<nop>TOPICLIST{"	* $web.$name"}%= creates a bullet list of all topics.
       
  1565 	 <br /> =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics.
       
  1566 	 <br /> =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus). </td>
       
  1567 </tr><tr>
       
  1568   <td> =%<nop>WEBLIST{"format"}%= </td>
       
  1569   <td> Web index, ex: list of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
       
  1570 	 Parameters are format, separator and web:
       
  1571 	 | *Parameter:* | *Description:* | *Default:* |
       
  1572 	 | ="format"= | Format of one line, may include =$name= variable | ="$name"= |
       
  1573 	 | =format="format"= | (Alternative to above) | ="$name"= |
       
  1574 	 | =separator=", "= | line separator | ="\n"= (new line) |
       
  1575 	 | =webs="public"=	| comma sep list of Web, public expands to all non-hidden | ="public"= |
       
  1576 	 | =marker="selected"= | Text for =$marker= where item matches =selection=, otherwise equals =""= | ="selected"= |
       
  1577 	 | =selection="%<nop>WEB%"= | Current value to be selected in list | =section="%<nop>WEB%"= |
       
  1578 	 Examples: <br /> =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
       
  1579 <br />
       
  1580 =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted.
       
  1581 </td>
       
  1582 </tr><tr>
       
  1583   <td> =%<nop>GMTIME%= </td>
       
  1584   <td> GM time, is <b>%GMTIME%</b> </td>
       
  1585 </tr><tr>
       
  1586   <td> =%<nop>GMTIME{"format"}%= </td>
       
  1587   <td> Formatted GM time based on time variables.
       
  1588 	 | *Variable:* | *Unit:* | *Example* |
       
  1589 	 | =$seconds= | seconds | 59 |
       
  1590 	 | =$minutes= | minutes | 59 |
       
  1591 	 | =$hours= | hours | 23 |
       
  1592 	 | =$day= | day of month | 31 |
       
  1593 	 | =$wday= | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu |
       
  1594 	 | =$month= | month in ISO format | Dec |
       
  1595 	 | =$mo= | 2 digit month | 12 |
       
  1596 	 | =$year= | 4 digit year | 1999 |
       
  1597 	 | =$ye= | 2 digit year | 99 |
       
  1598 	 | =$tz= | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT |
       
  1599 	 | =$iso= | ISO format timestamp | %GMTIME{"$iso"}% |
       
  1600 	 | =$rcs= | RCS format timestamp | %GMTIME{"$rcs"}% |
       
  1601 	 | =$http= | E-mail & http format timestamp | %GMTIME{"$http"}% |
       
  1602 	 Variables can be shortened to 3 characters. Example: <br /> =%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}%= is <br /> <b>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</b> </td>
       
  1603 </tr><tr>
       
  1604   <td> =%<nop>SERVERTIME%= </td>
       
  1605   <td> Server time, is <b>%SERVERTIME%</b> </td>
       
  1606 </tr><tr>
       
  1607   <td> =%<nop>SERVERTIME{"format"}%= </td>
       
  1608   <td> Formatted server time. Same format qualifiers as =%<nop>GMTIME%= <br /> Example: =%<nop>SERVERTIME{"$hou:$min"}%= is <b>%SERVERTIME{"$hou:$min"}%</b> </td>
       
  1609 </tr><tr>
       
  1610   <td> =%<nop>DISPLAYTIME%= </td>
       
  1611   <td> Display time, is <b>%DISPLAYTIME%</b> </td>
       
  1612 </tr><tr>
       
  1613   <td> =%<nop>DISPLAYTIME{"format"}%= </td>
       
  1614   <td> Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as =%<nop>GMTIME%= <br /> Example: =%<nop>DISPLAYTIME{"$hou:$min"}%= is <b>%DISPLAYTIME{"$hou:$min"}%</b> </td>
       
  1615 </tr><tr>
       
  1616   <td> =%<nop>HTTP_HOST%= </td>
       
  1617   <td> HTTP_HOST environment variable, is <b>%HTTP_HOST%</b> </td>
       
  1618 </tr><tr>
       
  1619   <td> =%<nop>REMOTE_ADDR%= </td>
       
  1620   <td> REMOTE_ADDR environment variable, is <b>%REMOTE_ADDR%</b> </td>
       
  1621 </tr><tr>
       
  1622   <td> =%<nop>REMOTE_PORT%= </td>
       
  1623   <td> REMOTE_PORT environment variable, is <b>%REMOTE_PORT%</b> </td>
       
  1624 </tr><tr>
       
  1625   <td> =%<nop>REMOTE_USER%= </td>
       
  1626   <td> REMOTE_USER environment variable, is <b>%REMOTE_USER%</b> </td>
       
  1627 </tr><tr>
       
  1628   <td> =%<nop>INCLUDE{"page" ...}%= </td>
       
  1629   <td> Server side include to IncludeTopicsAndWebPages:
       
  1630 d129 1
       
  1631 a129 65
       
  1632   </td>
       
  1633 </tr><tr>
       
  1634   <td> =%<nop>STARTINCLUDE%= </td>
       
  1635   <td> If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everyting exept the =%<nop>STARTINCLUDE%= variable itself. </td>
       
  1636 </tr><tr>
       
  1637   <td> =%<nop>STOPINCLUDE%= </td>
       
  1638   <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 =%<nop>STOPINCLUDE%= variable itself. </td>
       
  1639 </tr><tr>
       
  1640   <td> =%<nop>TOC%= </td>
       
  1641   <td> Table of Contents of current topic. </td>
       
  1642 </tr><tr>
       
  1643   <td> =%<nop>TOC{"SomeTopic" ...}%= </td>
       
  1644   <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. Any heading text after ="!!"= is excluded from the TOC; for example, write ="---+!! text"= if you do not want to list a header in the TOC. Supported parameters:
       
  1645 | *Parameter:* | *Description:* | *Default:* |
       
  1646 | ="TopicName"= | topic name | Current topic |
       
  1647 | =web="Name"= | Name of web | Current web |
       
  1648 | =depth="2"= | Limit depth of headings shown in TOC | 6 |
       
  1649 | =title="Some text"= | Title to appear at top of TOC | none |
       
  1650 Examples: =<b>%<nop>TOC{depth="2"}%</b>=, =<b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%" title="Contents:"}%</b>=
       
  1651 </tr><tr>
       
  1652   <td> =%<nop>SEARCH{"text" ...}%= </td>
       
  1653   <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
       
  1654 | *Parameter:* | *Description:* | *Default:* |
       
  1655 | ="text"= | Search term. Is a keyword search, literal search or regular expression search, depending on the =type= parameter. SearchHelp has more | required |
       
  1656 | =search="text"= | (Alternative to above) | N/A |
       
  1657 | =web="Name"= <br /> =web="%MAINWEB%, Know"= <br /> =web="all"= | Wiki web to search: A web, a list of webs separated by comma, or =all= webs. [2] | Current web |
       
  1658 | =topic="%WEBPREFSTOPIC%"= <br /> =topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | All topics in a web |
       
  1659 | =excludetopic="Web*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None |
       
  1660 | =type="keyword"= <br /> =type="literal"= <br /> =type="regex"= | Do a keyword search like =soap "web service" -shampoo=; a literal search like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%<nop>SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting |
       
  1661 | =scope="topic"= <br /> =scope="text"= <br /> =scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= |
       
  1662 | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort | Sort by topic name |
       
  1663 | =limit="all"= <br /> =limit="16"= | Limit the number of results returned. This is done after sorting in case =order= is specified | All results |
       
  1664 | =reverse="on"= | Reverse the direction of the search | Ascending search |
       
  1665 | =casesensitive="on"= | Case sensitive search | Ignore case |
       
  1666 | =nosummary="on"= | Show topic title only | Show topic summary |
       
  1667 | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
       
  1668 | =nosearch="on"= | Suppress search string | Show search string |
       
  1669 | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
       
  1670 | =nototal="on"= | Do not show number of topics found | Show number |
       
  1671 | =header="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables &amp; examples | Results in table |
       
  1672 | =expandvariables="on"= | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%<nop>CALC{}%= instead of the formula | Raw text |
       
  1673 | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic |
       
  1674 | =separator=", "= | Line separator between hits | Newline ="$n"= |
       
  1675 Example: =<b>%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%</b>= <br />
       
  1676 Formatted example: ==%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"%== _(displays results in a table with header - [[FormattedSearch][details]])_ <br />
       
  1677 %H% If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: ==%<nop>TABLE{ tablewidth="90%" }%==
       
  1678 </td>
       
  1679 </tr>
       
  1680 <tr>
       
  1681   <td> =%<nop>METASEARCH{...}%= </td>
       
  1682   <td> Special search of meta data
       
  1683 | *Parameter:* | *Description:* | *Default:* |
       
  1684 | =type="topicmoved"= | What sort of search is required? <br /> \
       
  1685 								="topicmoved"= if search for a topic that may have been moved <br /> \
       
  1686 								="parent"= if searching for topics that have a specific parent i.e. its \
       
  1687 								children | required |
       
  1688 | =web="%<nop>WEB%"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. | required |
       
  1689 | =topic="%<nop>TOPIC%"= | The topic the search relates to | required |
       
  1690 | =title="Title"= | Text that is prepended to any search results | required |
       
  1691 Example: ==%<nop>METASEARCH{type="topicmoved" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="This topic used to exist and was moved to: "}%==, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate<br />
       
  1692 ==%<nop>METASEARCH{type="parent" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="Children: "}%== 
       
  1693 </tr><tr>
       
  1694   <td> =%<nop>VAR{"NAME" web="Web"}%= </td>
       
  1695   <td> Get a preference value from a web other then the current one. Example: To get =%<nop>WEBBGCOLOR%= of the %MAINWEB% web write =%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, is =<b>%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%</b>= </td>
       
  1696 </tr></table>
       
  1697 d131 310
       
  1698 a440 2
       
  1699 <blockquote>
       
  1700 [1] __Note__: The search form uses identical names for input fields.
       
  1701 a441 2
       
  1702 [2] __Note__: A web can be excluded from a ==web="all"== search if you define a ==NOSEARCHALL=on== variable in its %WEBPREFSTOPIC%.
       
  1703 </blockquote>
       
  1704 d451 18
       
  1705 a468 10
       
  1706 </tr><tr>
       
  1707   <td> =%<nop>WIKIWEBMASTER%= </td>
       
  1708   <td> __SL__ </td>
       
  1709   <td> Webmaster email address (sender of email notifications) , is <b>%WIKIWEBMASTER%</b> </td>
       
  1710 </tr><tr>
       
  1711   <td> =%<nop>WIKIWEBLIST%= </td>
       
  1712   <td> __SL__ </td>
       
  1713   <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
       
  1714 </tr><tr>
       
  1715   <td> =%<nop>WEBTOPICLIST%= </td>
       
  1716 d470 19
       
  1717 a488 7
       
  1718   <td> Common links of web (second line of topics) </td>
       
  1719 </tr><tr>
       
  1720   <td> =%<nop>WEBCOPYRIGHT%= </td>
       
  1721   <td> __SL__ , __WL__ </td>
       
  1722   <td> Copyright notice (bottom right corner of topics) </td>
       
  1723 </tr><tr>
       
  1724   <td> =%<nop>WEBBGCOLOR%= </td>
       
  1725 d490 4
       
  1726 a493 3
       
  1727   <td> Background color of web </td>
       
  1728 </tr><tr>
       
  1729   <td> =%<nop>NOSEARCHALL%= </td>
       
  1730 d495 4
       
  1731 a498 11
       
  1732   <td> Exclude web from a =web="all"= search (set variable to =on= for hidden webs) </td>
       
  1733 </tr><tr>
       
  1734   <td> =%<nop>NEWTOPICBGCOLOR%= </td>
       
  1735   <td> __SL__ , _UL_ </td>
       
  1736   <td> Background color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
  1737 </tr><tr>
       
  1738   <td> =%<nop>NEWTOPICFONTCOLOR%= </td>
       
  1739   <td> __SL__ , _UL_ </td>
       
  1740   <td> Font color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
  1741 </tr><tr>
       
  1742   <td> =%<nop>EDITBOXWIDTH%= </td>
       
  1743 d500 3
       
  1744 a502 2
       
  1745   <td> Horizontal size of edit box, is <b> =%EDITBOXWIDTH%= </b> </td>
       
  1746 </tr><tr>
       
  1747 d506 7
       
  1748 a512 1
       
  1749 </tr><tr>
       
  1750 d516 7
       
  1751 a522 17
       
  1752 </tr><tr>
       
  1753   <td> =%<nop>RELEASEEDITLOCKCHECKBOX%= </td>
       
  1754   <td> __SL__ , __UL__ </td>
       
  1755   <td> Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if =Set RELEASEEDITLOCKCHECKBOX = checked="checked"=, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do *not* 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>
       
  1756 </tr><tr>
       
  1757   <td> =%<nop>DONTNOTIFYCHECKBOX%= </td>
       
  1758   <td> __SL__ , __UL__ </td>
       
  1759   <td> Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if =Set DONTNOTIFYCHECKBOX = checked="checked"=, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b> </td>
       
  1760 </tr><tr>
       
  1761   <td> =%<nop>ATTACHLINKBOX%= </td>
       
  1762   <td> __SL__ , __UL__ </td>
       
  1763   <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to =CHECKED= , 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>
       
  1764 </tr><tr>
       
  1765   <td> =%<nop>HTTP_EQUIV_ON_VIEW%= </td>
       
  1766   <td> __SL__ </td>
       
  1767   <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
       
  1768 </tr><tr>
       
  1769 d526 2
       
  1770 a527 1
       
  1771 </tr><tr>
       
  1772 d531 18
       
  1773 a548 2
       
  1774 </tr><tr>
       
  1775   <td> =%<nop>DENYWEBCHANGE%= </td>
       
  1776 d550 9
       
  1777 a558 3
       
  1778   <td> List of users and groups who are *not allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  1779 </tr><tr>
       
  1780   <td> =%<nop>ALLOWWEBCHANGE%= </td>
       
  1781 d560 9
       
  1782 a568 11
       
  1783   <td> List of users and groups who are *allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  1784 </tr><tr>
       
  1785   <td> =%<nop>DENYTOPICCHANGE%= </td>
       
  1786   <td> __(any topic)__ </td>
       
  1787   <td> List of users and groups who are *not allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
  1788 </tr><tr>
       
  1789   <td> =%<nop>ALLOWTOPICCHANGE%= </td>
       
  1790   <td> __(any topic)__ </td>
       
  1791   <td> List of users and groups who are *allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
  1792 </tr><tr>
       
  1793   <td> =%<nop>DENYWEBRENAME%= </td>
       
  1794 d570 13
       
  1795 a582 18
       
  1796   <td> List of users and groups who are *not allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  1797 </tr><tr>
       
  1798   <td> =%<nop>ALLOWWEBRENAME%= </td>
       
  1799   <td> __WL__ </td>
       
  1800   <td> List of users and groups who are *allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  1801 </tr><tr>
       
  1802   <td> =%<nop>DENYTOPICRENAME%= </td>
       
  1803   <td> __(any topic)__ </td>
       
  1804   <td> List of users and groups who are *not allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
  1805 </tr><tr>
       
  1806   <td> =%<nop>ALLOWTOPICRENAME%= </td>
       
  1807   <td> __(any topic)__ </td>
       
  1808   <td> List of users and groups who are *allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
  1809 </tr><tr>
       
  1810   <td> =%<nop>FINALPREFERENCES%= </td>
       
  1811   <td> __SL__ , __WL__ </td>
       
  1812   <td> List of preferences that are not allowed to be overridden by next level preferences</td>
       
  1813 </tr></table>
       
  1814 d603 1
       
  1815 a603 1
       
  1816 -- TWiki:Main.PeterThoeny - 16 Mar 2004 <br />
       
  1817 @
       
  1818 
       
  1819 
       
  1820 1.75
       
  1821 log
       
  1822 @none
       
  1823 @
       
  1824 text
       
  1825 @d1 1
       
  1826 a1 1
       
  1827 %META:TOPICINFO{author="PeterThoeny" date="1079505060" format="1.0" version="1.75"}%
       
  1828 d3 420
       
  1829 a422 417
       
  1830 %TOC%
       
  1831 %STARTINCLUDE%
       
  1832 ---# TWiki Variables
       
  1833 
       
  1834 _Special text strings expand on the fly to display user data or system info_
       
  1835 
       
  1836 <nop>TWikiVariables are text strings - =%<nop>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.
       
  1837 
       
  1838 ---++ Predefined Variables
       
  1839 
       
  1840 Most predefined variables return values that were either set in the ==lib/twiki.cfg== 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.
       
  1841 
       
  1842 	* %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 ==%<nop>INCLUDINGTOPIC%==, ==%<nop>INCLUDE%==, and the mighty ==%<nop>SEARCH%==.
       
  1843 
       
  1844 This version of TWiki - %WIKIVERSION% - expands the following variables (enclosed in ==%== percent signs):
       
  1845 
       
  1846 <table cellspacing="0" cellpadding="2" border="1" align="center" style="background-color:#f5f5f5">
       
  1847 <tr>
       
  1848   <th width="160"> Variable: </th><th> Expanded to: </th>
       
  1849 </tr><tr>
       
  1850   <td> =%<nop>WIKIHOMEURL%= </td>
       
  1851   <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b> </td>
       
  1852 </tr><tr>
       
  1853   <td> =%<nop>SCRIPTURL%= </td>
       
  1854   <td> The script URL of %WIKITOOLNAME%, is <b>%SCRIPTURL%</b></td>
       
  1855 </tr><tr>
       
  1856   <td> =%<nop>SCRIPTURLPATH%= </td>
       
  1857   <td> The path of the script URL of %WIKITOOLNAME%, is <b>%SCRIPTURLPATH%</b></td>
       
  1858 </tr><tr>
       
  1859   <td> =%<nop>SCRIPTSUFFIX%= </td>
       
  1860   <td> The script suffix, ex: =.pl=, =.cgi= is <b>%SCRIPTSUFFIX%</b></td>
       
  1861 </tr><tr>
       
  1862   <td> =%<nop>PUBURL%= </td>
       
  1863   <td> The public URL of TWiki, is <b>%PUBURL%</b> <br /> Example: You can refer to a file attached to another topic as =<b>%<nop>PUBURL%/%<nop>WEB%/OtherTopic/image.gif</b>=  </td>
       
  1864 </tr><tr>
       
  1865   <td> =%<nop>PUBURLPATH%= </td>
       
  1866   <td> The path of the public URL of %WIKITOOLNAME%, is <b>%PUBURLPATH%</b> </td>
       
  1867 </tr><tr>
       
  1868   <td> =%<nop>ATTACHURL%= </td>
       
  1869   <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 =<b>%<nop>ATTACHURL%/image.gif</b>= </td>
       
  1870 </tr><tr>
       
  1871   <td> =%<nop>ATTACHURLPATH%= </td>
       
  1872   <td> The path of the attachment URL of the current topic, is <b>%ATTACHURLPATH%</b> </td>
       
  1873 </tr><tr>
       
  1874   <td> =%<nop>ICON{"type"}%= </td>
       
  1875   <td> Small 16x16 pixel icon of common attachment types, like %ICON{"bmp"}% =bmp=, %ICON{"doc"}% =doc=, %ICON{"gif"}% =gif=, %ICON{"hlp"}% =hlp=, %ICON{"html"}% =html=, %ICON{"mp3"}% =mp3=, %ICON{"pdf"}% =pdf=, %ICON{"ppt"}% =ppt=, %ICON{"txt"}% =txt=, %ICON{"xls"}% =xls=, %ICON{"xml"}% =xml=, %ICON{"zip"}% =zip=, etc. Specify file type only, file name, or full path name. Example: =%<nop>ICON{"pdf"}%= returns %ICON{"pdf"}% </td>
       
  1876 </tr><tr>
       
  1877   <td> =%<nop>URLPARAM{"name"}%= </td>
       
  1878   <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:
       
  1879 	 | *Parameter:* | *Description:* | *Default:* |
       
  1880 	 | ="name"= | The name of a URL parameter | required |
       
  1881 	 | =default="..."= | Default value in case parameter is empty or missing | empty string |
       
  1882 	 | =newline="&lt;br /&gt;"= | Convert newlines in textarea to other delimiters | no conversion |
       
  1883 	 | =encode="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;=. This is needed if text is put into an HTML form field | no encoding |
       
  1884 	 | =encode="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | no encoding |
       
  1885 	 | =multiple="on"= %BR% =multiple="[<nop>[$item]]"= | If set, gets all selected elements of a =&lt;select multiple="multiple"&gt;= tag. A format can be specified, with =$item= indicating the element, e.g. =multiple="Option: $item"= | first element |
       
  1886 	 | =separator=", "= | Separator between multiple selections. Only relevant if multiple is specified | ="\n"= (new line) |
       
  1887 	 Example: =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b>
       
  1888 </td>
       
  1889 </tr><tr>
       
  1890   <td> =%<nop>ENCODE{"string"}%= </td>
       
  1891   <td> Encodes a string. Supported parameters:
       
  1892 	 | *Parameter:* | *Description:* | *Default:* |
       
  1893 	 | ="string"= | String to encode | required (can be empty) |
       
  1894 	 | =type="entity"= | Encode special characters into HTML entities, like a double quote into =&amp;#034;= | URL encoding |
       
  1895 	 | =type="url"= | Encode special characters for URL parameter use, like a double quote into =%22= | (this is the default) |
       
  1896 	 Example: =%<nop>ENCODE{"spaced name"}%= returns <b>%ENCODE{"spaced name"}%</b> </td>
       
  1897 </tr><tr>
       
  1898   <td> =%<nop>WIKITOOLNAME%= </td>
       
  1899   <td> The name of your TWiki site - <b>%WIKITOOLNAME%</b> </td>
       
  1900 </tr><tr>
       
  1901   <td> =%<nop>WIKIVERSION%= </td>
       
  1902   <td> Your current TWiki version - <b>%WIKIVERSION%</b> </td>
       
  1903 </tr><tr>
       
  1904   <td> =%<nop>USERNAME%= </td>
       
  1905   <td> Your login username - <b>%USERNAME%</b> </td>
       
  1906 </tr><tr>
       
  1907   <td> =%<nop>WIKINAME%= </td>
       
  1908   <td> Your Wiki username. Same as %<nop>USERNAME% if not defined in the %MAINWEB%.%WIKIUSERSTOPIC% topic. Is <b>%WIKINAME%</b> </td>
       
  1909 </tr><tr>
       
  1910   <td> =%<nop>WIKIUSERNAME%= </td>
       
  1911   <td> Your %<nop>WIKINAME% including the %MAINWEB% web name - always use full signatures - <b>%WIKIUSERNAME%</b> </td>
       
  1912 </tr><tr>
       
  1913   <td> =%<nop>MAINWEB%= </td>
       
  1914   <td> The web containing %MAINWEB%.%WIKIUSERSTOPIC%, %MAINWEB%.OfficeLocations and %MAINWEB%.TWikiGroups is <b>%MAINWEB%</b> </td>
       
  1915 </tr><tr>
       
  1916   <td> =%<nop>TWIKIWEB%= </td>
       
  1917   <td> The web containing all documentation and site-wide preference settings for %WIKITOOLNAME% - <b>%TWIKIWEB%</b> </td>
       
  1918 </tr><tr>
       
  1919   <td> =%<nop>WEB%= </td>
       
  1920   <td> The current web is <b>%WEB%</b> </td>
       
  1921 </tr><tr>
       
  1922   <td> =%<nop>BASEWEB%= </td>
       
  1923   <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as =%<nop>WEB%= in case there is no include. </td>
       
  1924 </tr><tr>
       
  1925   <td> =%<nop>INCLUDINGWEB%= </td>
       
  1926   <td> The web name of the topic that includes the current topic -  same as =%<nop>WEB%= if there is no INCLUDE. </td>
       
  1927 </tr><tr>
       
  1928   <td> =%<nop>HOMETOPIC%= </td>
       
  1929   <td> The home topic in each web - <b>[[%HOMETOPIC%]]</b> </td>
       
  1930 </tr><tr>
       
  1931   <td> =%<nop>NOTIFYTOPIC%= </td>
       
  1932   <td> The notify topic in each web - <b>[[%NOTIFYTOPIC%]]</b> </td>
       
  1933 </tr><tr>
       
  1934   <td> =%<nop>WIKIUSERSTOPIC%= </td>
       
  1935   <td> The index topic of all registered users - <b>%WIKIUSERSTOPIC%</b></td>
       
  1936 </tr><tr>
       
  1937   <td> =%<nop>WIKIPREFSTOPIC%= </td>
       
  1938   <td> The site-wide preferences topic - <b>%WIKIPREFSTOPIC%</b> </td>
       
  1939 </tr><tr>
       
  1940   <td> =%<nop>WEBPREFSTOPIC%= </td>
       
  1941   <td> The local web preferences topic in each web - <b>%WEBPREFSTOPIC%</b> </td>
       
  1942 </tr><tr>
       
  1943   <td> =%<nop>STATISTICSTOPIC%= </td>
       
  1944   <td> The web statistics topic <b>%STATISTICSTOPIC%</b> </td>
       
  1945 </tr><tr>
       
  1946   <td> =%<nop>TOPIC%= </td>
       
  1947   <td> The current topic name - <b>%TOPIC%</b> </td>
       
  1948 </tr><tr>
       
  1949   <td> =%<nop>BASETOPIC%= </td>
       
  1950   <td> The name of the topic where a single or nested INCLUDE started - same as =%<nop>TOPIC%= if there is no INCLUDE. </td>
       
  1951 </tr><tr>
       
  1952   <td> =%<nop>INCLUDINGTOPIC%= </td>
       
  1953   <td> The name of the topic that includes the current topic. Same as =%<nop>TOPIC%= in case there is no include. </td>
       
  1954 </tr><tr>
       
  1955   <td> =%<nop>SPACEDTOPIC%= </td>
       
  1956   <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b>%SPACEDTOPIC%</b> </td>
       
  1957 </tr><tr>
       
  1958   <td> =%<nop>TOPICLIST{"format"}%= </td>
       
  1959   <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The =$name= variable gets expanded to the topic name; the =$web= variable gets expanded to the name of the web.
       
  1960 	 Parameters are format, separator and web:
       
  1961 	 | *Parameter:* | *Description:* | *Default:* |
       
  1962 	 | ="format"= | Format of one line, may include =$name= and =$web= variables | ="$name"= |
       
  1963 	 | =format="format"= | (Alternative to above) | ="$name"= |
       
  1964 	 | =separator=", "= | line separator | ="\n"= (new line) |
       
  1965 	 | =web="Name"= | Name of web | Current web |
       
  1966 	 Examples:
       
  1967 	 <br /> =%<nop>TOPICLIST{"	* $web.$name"}%= creates a bullet list of all topics.
       
  1968 	 <br /> =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics.
       
  1969 	 <br /> =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus). </td>
       
  1970 </tr><tr>
       
  1971   <td> =%<nop>WEBLIST{"format"}%= </td>
       
  1972   <td> Web index, ex: list of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
       
  1973 	 Parameters are format, separator and web:
       
  1974 	 | *Parameter:* | *Description:* | *Default:* |
       
  1975 	 | ="format"= | Format of one line, may include =$name= variable | ="$name"= |
       
  1976 	 | =format="format"= | (Alternative to above) | ="$name"= |
       
  1977 	 | =separator=", "= | line separator | ="\n"= (new line) |
       
  1978 	 | =webs="public"=	| comma sep list of Web, public expands to all non-hidden | ="public"= |
       
  1979 	 | =marker="selected"= | Text for =$marker= where item matches =selection=, otherwise equals =""= | ="selected"= |
       
  1980 	 | =selection="%<nop>WEB%"= | Current value to be selected in list | =section="%<nop>WEB%"= |
       
  1981 	 Examples: <br /> =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
       
  1982 <br />
       
  1983 =%<nop>WEBLIST{"&lt;option $marker value=$qname&gt;$name&lt;/option&gt;" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted.
       
  1984 </td>
       
  1985 </tr><tr>
       
  1986   <td> =%<nop>GMTIME%= </td>
       
  1987   <td> GM time, is <b>%GMTIME%</b> </td>
       
  1988 </tr><tr>
       
  1989   <td> =%<nop>GMTIME{"format"}%= </td>
       
  1990   <td> Formatted GM time based on time variables.
       
  1991 	 | *Variable:* | *Unit:* | *Example* |
       
  1992 	 | =$seconds= | seconds | 59 |
       
  1993 	 | =$minutes= | minutes | 59 |
       
  1994 	 | =$hours= | hours | 23 |
       
  1995 	 | =$day= | day of month | 31 |
       
  1996 	 | =$wday= | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu |
       
  1997 	 | =$month= | month in ISO format | Dec |
       
  1998 	 | =$mo= | 2 digit month | 12 |
       
  1999 	 | =$year= | 4 digit year | 1999 |
       
  2000 	 | =$ye= | 2 digit year | 99 |
       
  2001 	 | =$tz= | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT |
       
  2002 	 | =$iso= | ISO format timestamp | %GMTIME{"$iso"}% |
       
  2003 	 | =$rcs= | RCS format timestamp | %GMTIME{"$rcs"}% |
       
  2004 	 | =$http= | E-mail & http format timestamp | %GMTIME{"$http"}% |
       
  2005 	 Variables can be shortened to 3 characters. Example: <br /> =%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}%= is <br /> <b>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</b> </td>
       
  2006 </tr><tr>
       
  2007   <td> =%<nop>SERVERTIME%= </td>
       
  2008   <td> Server time, is <b>%SERVERTIME%</b> </td>
       
  2009 </tr><tr>
       
  2010   <td> =%<nop>SERVERTIME{"format"}%= </td>
       
  2011   <td> Formatted server time. Same format qualifiers as =%<nop>GMTIME%= <br /> Example: =%<nop>SERVERTIME{"$hou:$min"}%= is <b>%SERVERTIME{"$hou:$min"}%</b> </td>
       
  2012 </tr><tr>
       
  2013   <td> =%<nop>DISPLAYTIME%= </td>
       
  2014   <td> Display time, is <b>%DISPLAYTIME%</b> </td>
       
  2015 </tr><tr>
       
  2016   <td> =%<nop>DISPLAYTIME{"format"}%= </td>
       
  2017   <td> Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as =%<nop>GMTIME%= <br /> Example: =%<nop>DISPLAYTIME{"$hou:$min"}%= is <b>%DISPLAYTIME{"$hou:$min"}%</b> </td>
       
  2018 </tr><tr>
       
  2019   <td> =%<nop>HTTP_HOST%= </td>
       
  2020   <td> HTTP_HOST environment variable, is <b>%HTTP_HOST%</b> </td>
       
  2021 </tr><tr>
       
  2022   <td> =%<nop>REMOTE_ADDR%= </td>
       
  2023   <td> REMOTE_ADDR environment variable, is <b>%REMOTE_ADDR%</b> </td>
       
  2024 </tr><tr>
       
  2025   <td> =%<nop>REMOTE_PORT%= </td>
       
  2026   <td> REMOTE_PORT environment variable, is <b>%REMOTE_PORT%</b> </td>
       
  2027 </tr><tr>
       
  2028   <td> =%<nop>REMOTE_USER%= </td>
       
  2029   <td> REMOTE_USER environment variable, is <b>%REMOTE_USER%</b> </td>
       
  2030 </tr><tr>
       
  2031   <td> =%<nop>INCLUDE{"page" ...}%= </td>
       
  2032   <td> Server side include to IncludeTopicsAndWebPages:
       
  2033 	| *Parameter:* | *Description:* | *Default:* |
       
  2034 	| ="SomeTopic"= | The name of a topic located in the current web, i.e. =%<nop>INCLUDE{"WebNotify"}%= | |
       
  2035 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%= | |
       
  2036 	| ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://twiki.org/"}%= | |
       
  2037 	| =pattern="..."= | A RegularExpression pattern to include a subset of a topic or page | none |
       
  2038 	| =rev="1.2"= | Include a previous topic revision; N/A for URLs | top revision |
       
  2039 	| =warn="off"= | Warn if topic include fails: Fail silently (if =off=); output default warning (if set to =on=); else, output specific text (use =$topic= for topic name) | =%INCLUDE- WARNING%= [[TWikiPreferences][preferences]] setting |
       
  2040   </td>
       
  2041 </tr><tr>
       
  2042   <td> =%<nop>STARTINCLUDE%= </td>
       
  2043   <td> If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everyting exept the =%<nop>STARTINCLUDE%= variable itself. </td>
       
  2044 </tr><tr>
       
  2045   <td> =%<nop>STOPINCLUDE%= </td>
       
  2046   <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 =%<nop>STOPINCLUDE%= variable itself. </td>
       
  2047 </tr><tr>
       
  2048   <td> =%<nop>TOC%= </td>
       
  2049   <td> Table of Contents of current topic. </td>
       
  2050 </tr><tr>
       
  2051   <td> =%<nop>TOC{"SomeTopic" ...}%= </td>
       
  2052   <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. Any heading text after ="!!"= is excluded from the TOC; for example, write ="---+!! text"= if you do not want to list a header in the TOC. Supported parameters:
       
  2053 | *Parameter:* | *Description:* | *Default:* |
       
  2054 | ="TopicName"= | topic name | Current topic |
       
  2055 | =web="Name"= | Name of web | Current web |
       
  2056 | =depth="2"= | Limit depth of headings shown in TOC | 6 |
       
  2057 | =title="Some text"= | Title to appear at top of TOC | none |
       
  2058 Examples: =<b>%<nop>TOC{depth="2"}%</b>=, =<b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%" title="Contents:"}%</b>=
       
  2059 </tr><tr>
       
  2060   <td> =%<nop>SEARCH{"text" ...}%= </td>
       
  2061   <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
       
  2062 | *Parameter:* | *Description:* | *Default:* |
       
  2063 | ="text"= | Search term. Is a keyword search, literal search or regular expression search, depending on the =type= parameter. SearchHelp has more | required |
       
  2064 | =search="text"= | (Alternative to above) | N/A |
       
  2065 | =web="Name"= <br /> =web="%MAINWEB%, Know"= <br /> =web="all"= | Wiki web to search: A web, a list of webs separated by comma, or =all= webs. [2] | Current web |
       
  2066 | =topic="%WEBPREFSTOPIC%"= <br /> =topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | All topics in a web |
       
  2067 | =excludetopic="Web*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. | None |
       
  2068 | =type="keyword"= <br /> =type="literal"= <br /> =type="regex"= | Do a keyword search like =soap "web service" -shampoo=; a literal search like =web service=; or RegularExpression search like =soap;web service;!shampoo= | =%<nop>SEARCHVAR- DEFAULTTYPE%= [[TWikiPreferences][preferences]] setting |
       
  2069 | =scope="topic"= <br /> =scope="text"= <br /> =scope="all"= | Search topic name (title); the text (body) of topic; or all (both) | ="text"= |
       
  2070 | =order="topic"= <br /> =order="created"= <br />  =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"formfield(name)"= | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a [[FormattedSearch][formatted]] table and sort it with TablePlugin's initsort | Sort by topic name |
       
  2071 | =limit="all"= <br /> =limit="16"= | Limit the number of results returned. This is done after sorting in case =order= is specified | All results |
       
  2072 | =reverse="on"= | Reverse the direction of the search | Ascending search |
       
  2073 | =casesensitive="on"= | Case sensitive search | Ignore case |
       
  2074 | =nosummary="on"= | Show topic title only | Show topic summary |
       
  2075 | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
       
  2076 | =nosearch="on"= | Suppress search string | Show search string |
       
  2077 | =noheader="on"= | Suppress search header <br /> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
       
  2078 | =nototal="on"= | Do not show number of topics found | Show number |
       
  2079 | =header="..."= <br /> =format="..."= | Custom format results: see *[[FormattedSearch]]* for usage, variables &amp; examples | Results in table |
       
  2080 | =expandvariables="on"= | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%<nop>CALC{}%= instead of the formula | Raw text |
       
  2081 | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic |
       
  2082 | =separator=", "= | Line separator between hits | Newline ="$n"= |
       
  2083 Example: =<b>%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%</b>= <br />
       
  2084 Formatted example: ==%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"%== _(displays results in a table with header - [[FormattedSearch][details]])_ <br />
       
  2085 %H% If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: ==%<nop>TABLE{ tablewidth="90%" }%==
       
  2086 </td>
       
  2087 </tr>
       
  2088 <tr>
       
  2089   <td> =%<nop>METASEARCH{...}%= </td>
       
  2090   <td> Special search of meta data
       
  2091 | *Parameter:* | *Description:* | *Default:* |
       
  2092 | =type="topicmoved"= | What sort of search is required? <br /> \
       
  2093 								="topicmoved"= if search for a topic that may have been moved <br /> \
       
  2094 								="parent"= if searching for topics that have a specific parent i.e. its \
       
  2095 								children | required |
       
  2096 | =web="%<nop>WEB%"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. | required |
       
  2097 | =topic="%<nop>TOPIC%"= | The topic the search relates to | required |
       
  2098 | =title="Title"= | Text that is prepended to any search results | required |
       
  2099 Example: ==%<nop>METASEARCH{type="topicmoved" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="This topic used to exist and was moved to: "}%==, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate<br />
       
  2100 ==%<nop>METASEARCH{type="parent" web="%<nop>WEB%" topic="%<nop>TOPIC%" title="Children: "}%== 
       
  2101 </tr><tr>
       
  2102   <td> =%<nop>VAR{"NAME" web="Web"}%= </td>
       
  2103   <td> Get a preference value from a web other then the current one. Example: To get =%<nop>WEBBGCOLOR%= of the %MAINWEB% web write =%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, is =<b>%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%</b>= </td>
       
  2104 </tr></table>
       
  2105 
       
  2106 <blockquote>
       
  2107 [1] __Note__: The search form uses identical names for input fields.
       
  2108 
       
  2109 [2] __Note__: A web can be excluded from a ==web="all"== search if you define a ==NOSEARCHALL=on== variable in its %WEBPREFSTOPIC%.
       
  2110 </blockquote>
       
  2111 
       
  2112 #PreferencesVariables
       
  2113 ---++ Preferences Variables
       
  2114 
       
  2115 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):
       
  2116 
       
  2117 <table cellspacing="0" cellpadding="2" border="1" align="center" style="background-color:#f5f5f5">
       
  2118 <tr>
       
  2119   <th width="160"> Variable: </th><th> Level: </th><th> What: </th>
       
  2120 </tr><tr>
       
  2121   <td> =%<nop>WIKIWEBMASTER%= </td>
       
  2122   <td> __SL__ </td>
       
  2123   <td> Webmaster email address (sender of email notifications) , is <b>%WIKIWEBMASTER%</b> </td>
       
  2124 </tr><tr>
       
  2125   <td> =%<nop>WIKIWEBLIST%= </td>
       
  2126   <td> __SL__ </td>
       
  2127   <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
       
  2128 </tr><tr>
       
  2129   <td> =%<nop>WEBTOPICLIST%= </td>
       
  2130   <td> __WL__ </td>
       
  2131   <td> Common links of web (second line of topics) </td>
       
  2132 </tr><tr>
       
  2133   <td> =%<nop>WEBCOPYRIGHT%= </td>
       
  2134   <td> __SL__ , __WL__ </td>
       
  2135   <td> Copyright notice (bottom right corner of topics) </td>
       
  2136 </tr><tr>
       
  2137   <td> =%<nop>WEBBGCOLOR%= </td>
       
  2138   <td> __WL__ </td>
       
  2139   <td> Background color of web </td>
       
  2140 </tr><tr>
       
  2141   <td> =%<nop>NOSEARCHALL%= </td>
       
  2142   <td> __WL__ </td>
       
  2143   <td> Exclude web from a =web="all"= search (set variable to =on= for hidden webs) </td>
       
  2144 </tr><tr>
       
  2145   <td> =%<nop>NEWTOPICBGCOLOR%= </td>
       
  2146   <td> __SL__ , _UL_ </td>
       
  2147   <td> Background color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
  2148 </tr><tr>
       
  2149   <td> =%<nop>NEWTOPICFONTCOLOR%= </td>
       
  2150   <td> __SL__ , _UL_ </td>
       
  2151   <td> Font color of non existing topic. ( __UL__ needs authentication for topic views ) </td>
       
  2152 </tr><tr>
       
  2153   <td> =%<nop>EDITBOXWIDTH%= </td>
       
  2154   <td> __SL__ , __UL__ </td>
       
  2155   <td> Horizontal size of edit box, is <b> =%EDITBOXWIDTH%= </b> </td>
       
  2156 </tr><tr>
       
  2157   <td> =%<nop>EDITBOXHEIGHT%= </td>
       
  2158   <td> __SL__ , __UL__ </td>
       
  2159   <td> Vertical size of edit box, is <b> =%EDITBOXHEIGHT%= </b> </td>
       
  2160 </tr><tr>
       
  2161   <td> =%<nop>EDITBOXSTYLE%= </td>
       
  2162   <td> __SL__ , __UL__ </td>
       
  2163   <td> Style of text edit box. Set to =width: 99%= for full window width (default; overwrites the EDITBOXWIDTH setting), or =width: auto= to disable. Value is: <b><code>%EDITBOXSTYLE%</code></b> </td>
       
  2164 </tr><tr>
       
  2165   <td> =%<nop>RELEASEEDITLOCKCHECKBOX%= </td>
       
  2166   <td> __SL__ , __UL__ </td>
       
  2167   <td> Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if =Set RELEASEEDITLOCKCHECKBOX = checked="checked"=, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do *not* 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>
       
  2168 </tr><tr>
       
  2169   <td> =%<nop>DONTNOTIFYCHECKBOX%= </td>
       
  2170   <td> __SL__ , __UL__ </td>
       
  2171   <td> Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if =Set DONTNOTIFYCHECKBOX = checked="checked"=, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b> </td>
       
  2172 </tr><tr>
       
  2173   <td> =%<nop>ATTACHLINKBOX%= </td>
       
  2174   <td> __SL__ , __UL__ </td>
       
  2175   <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to =CHECKED= , 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>
       
  2176 </tr><tr>
       
  2177   <td> =%<nop>HTTP_EQUIV_ON_VIEW%= </td>
       
  2178   <td> __SL__ </td>
       
  2179   <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
       
  2180 </tr><tr>
       
  2181   <td> =%<nop>HTTP_EQUIV_ON_EDIT%= </td>
       
  2182   <td> __SL__ , __UL__ </td>
       
  2183   <td> http-equiv meta tags for edit script. </td>
       
  2184 </tr><tr>
       
  2185   <td> =%<nop>HTTP_EQUIV_ON_PREVIEW%= </td>
       
  2186   <td> __SL__ , __UL__ </td>
       
  2187   <td> http-equiv meta tags for preview script. </td>
       
  2188 </tr><tr>
       
  2189   <td> =%<nop>DENYWEBCHANGE%= </td>
       
  2190   <td> __WL__ </td>
       
  2191   <td> List of users and groups who are *not allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  2192 </tr><tr>
       
  2193   <td> =%<nop>ALLOWWEBCHANGE%= </td>
       
  2194   <td> __WL__ </td>
       
  2195   <td> List of users and groups who are *allowed* to change topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  2196 </tr><tr>
       
  2197   <td> =%<nop>DENYTOPICCHANGE%= </td>
       
  2198   <td> __(any topic)__ </td>
       
  2199   <td> List of users and groups who are *not allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
  2200 </tr><tr>
       
  2201   <td> =%<nop>ALLOWTOPICCHANGE%= </td>
       
  2202   <td> __(any topic)__ </td>
       
  2203   <td> List of users and groups who are *allowed* to change the current topic. (More in TWikiAccessControl) </td>
       
  2204 </tr><tr>
       
  2205   <td> =%<nop>DENYWEBRENAME%= </td>
       
  2206   <td> __WL__ </td>
       
  2207   <td> List of users and groups who are *not allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  2208 </tr><tr>
       
  2209   <td> =%<nop>ALLOWWEBRENAME%= </td>
       
  2210   <td> __WL__ </td>
       
  2211   <td> List of users and groups who are *allowed* to rename topics in the %WIKITOOLNAME% web. (More in TWikiAccessControl) </td>
       
  2212 </tr><tr>
       
  2213   <td> =%<nop>DENYTOPICRENAME%= </td>
       
  2214   <td> __(any topic)__ </td>
       
  2215   <td> List of users and groups who are *not allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
  2216 </tr><tr>
       
  2217   <td> =%<nop>ALLOWTOPICRENAME%= </td>
       
  2218   <td> __(any topic)__ </td>
       
  2219   <td> List of users and groups who are *allowed* to rename the current topic. (More in TWikiAccessControl) </td>
       
  2220 </tr><tr>
       
  2221   <td> =%<nop>FINALPREFERENCES%= </td>
       
  2222   <td> __SL__ , __WL__ </td>
       
  2223   <td> List of preferences that are not allowed to be overridden by next level preferences</td>
       
  2224 </tr></table>
       
  2225 
       
  2226 __Note:__ There are some more useful variables defined in the TWikiPreferences like =%<nop>BR%= for line break, colors like =%<nop>RED%= for colored text and small icons like =%<nop>H%= for a %H% Help icon.
       
  2227 
       
  2228 #SettingPrefs
       
  2229 ---++ Setting Preferences
       
  2230 
       
  2231 	* 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:__ 
       
  2232 	* ==<nop>Set VARIABLENAME = value==
       
  2233 		* ==<nop>Set VARIABLENAME = value==
       
  2234 
       
  2235 ---++ Creating Custom Variables
       
  2236 
       
  2237 	* You can add your own Preference Variables for us across an entire site or a single web, using the standard [[#SettingPrefs][Preferences syntax]]. 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.
       
  2238 
       
  2239 <blockquote style="background-color:#ffffff">
       
  2240 *Example: Create a custom logo variable the <nop>%WEB% web* <br />
       
  2241 	* To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the Variable on the web's WebPreferences page, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: =LogoTopic=:
       
  2242 		* ==<nop>Set MYLOGO = %<nop>PUBURL%/<nop>TWiki/LogoTopic/mylogo.gif== 
       
  2243 </blockquote>
       
  2244 
       
  2245 -- TWiki:Main.PeterThoeny - 16 Mar 2004 <br />
       
  2246 -- TWiki:Main.MikeMannix - 12 May 2002
       
  2247 @
       
  2248 
       
  2249 
       
  2250 1.74
       
  2251 log
       
  2252 @none
       
  2253 @
       
  2254 text
       
  2255 @d1 1
       
  2256 a1 1
       
  2257 %META:TOPICINFO{author="PeterThoeny" date="1074472194" format="1.0" version="1.74"}%
       
  2258 d55 1
       
  2259 a55 1
       
  2260 	 | =newline="&lt;br /&gt;"= | Convert newlines to other delimiters | no conversion |
       
  2261 d58 2
       
  2262 d165 13
       
  2263 a177 8
       
  2264 	 | $seconds | seconds | 59 |
       
  2265 	 | $minutes | minutes | 59 |
       
  2266 	 | $hours | hours | 23 |
       
  2267 	 | $day | day of month | 31 |
       
  2268 	 | $month | month in ISO format | Dec |
       
  2269 	 | $mo | 2 digit month | 12 |
       
  2270 	 | $year | 4 digit year | 1999 |
       
  2271 	 | $ye | 2 digit year | 99 |
       
  2272 d184 7
       
  2273 a190 1
       
  2274   <td> Formatted server time. <br /> Example: =%<nop>SERVERTIME{"$hou:$min"}%= is <b>%SERVERTIME{"$hou:$min"}%</b> </td>
       
  2275 d243 2
       
  2276 a244 2
       
  2277 | =order="topic"= <br /> =order="modified"= <br /> =order="editby"= <br /> =order=<br />&nbsp;"formfield(name)"= | Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms | Sort by topic name |
       
  2278 | =limit="all"= <br /> =limit="16"= | Limit the number of results returned | All results |
       
  2279 d253 1
       
  2280 d418 1
       
  2281 a418 1
       
  2282 -- TWiki:Main.PeterThoeny - 14 Jan 2004 <br />
       
  2283 @
       
  2284 
       
  2285 
       
  2286 1.73
       
  2287 log
       
  2288 @none
       
  2289 @
       
  2290 text
       
  2291 @d1 1
       
  2292 a1 1
       
  2293 %META:TOPICINFO{author="PeterThoeny" date="1074417117" format="1.0" version="1.73"}%
       
  2294 d50 1
       
  2295 a50 1
       
  2296   <td> =%<nop>PARAM{"name"}%= </td>
       
  2297 d58 1
       
  2298 a58 1
       
  2299 	 Example: =%<nop>PARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%PARAM{"skin"}%</b>
       
  2300 @
       
  2301 
       
  2302 
       
  2303 1.72
       
  2304 log
       
  2305 @none
       
  2306 @
       
  2307 text
       
  2308 @d1 1
       
  2309 a1 1
       
  2310 %META:TOPICINFO{author="PeterThoeny" date="1074237929" format="1.0" version="1.72"}%
       
  2311 d9 1
       
  2312 a9 1
       
  2313 <nop>TWikiVariables are text strings - =%<nop>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. 
       
  2314 d19 1
       
  2315 a19 1
       
  2316 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="background-color:#f5f5f5">
       
  2317 d199 1
       
  2318 a199 1
       
  2319 	| =warn="off"= | Warn if topic include fails: Fail silently (if =off=); output default warning (if set to =on=); else, output specific text (use =$topic= for topic name) | =%INCLUDE- WARNING%= preferences setting |
       
  2320 d223 1
       
  2321 a223 1
       
  2322 | ="text"= | Search term. Is a regular expression or literal, depending on the =regex= parameter. For regular expressions ";" is used to mean _and_ e.g. "search;agrep" will find all topic containing search _and_ agrep. | required |
       
  2323 d228 2
       
  2324 a229 1
       
  2325 | =scope="topic"= <br /> =scope="text"= | Search topic name (title) or in the text (body) of the topic | Topic text (body) |
       
  2326 a231 1
       
  2327 | =regex="on"= | RegularExpression search; also enables ";" as _and_ | Literal search |
       
  2328 d242 1
       
  2329 a242 1
       
  2330 Regular example: =<b>%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%</b>= <br />
       
  2331 d276 1
       
  2332 a276 1
       
  2333 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="background-color:#f5f5f5">
       
  2334 a379 1
       
  2335 
       
  2336 a384 1
       
  2337 <blockquote>
       
  2338 a385 1
       
  2339 </blockquote>
       
  2340 @
       
  2341 
       
  2342 
       
  2343 1.71
       
  2344 log
       
  2345 @none
       
  2346 @
       
  2347 text
       
  2348 @d1 1
       
  2349 a1 1
       
  2350 %META:TOPICINFO{author="PeterThoeny" date="1073719550" format="1.0" version="1.71"}%
       
  2351 d50 2
       
  2352 a51 2
       
  2353   <td> =%<nop>URLPARAM{"name"}%= </td>
       
  2354   <td> Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name, default and newline:
       
  2355 d56 3
       
  2356 a58 1
       
  2357 	 Example: =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b>
       
  2358 d61 7
       
  2359 a67 2
       
  2360   <td> =%<nop>URLENCODE{"string"}%= </td>
       
  2361   <td> Encodes a string for use as a URL parameter. Ex: =%<nop>URLENCODE{"spaced name"}%= returns <b>%URLENCODE{"spaced name"}%</b> </td>
       
  2362 d212 1
       
  2363 a212 1
       
  2364   <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. Any heading text after ="!!"= is excluded from the TOC; for example, write ="---+!! text"= if you do not want to list a header in the TOC. Parameters are topic name, web and depth:
       
  2365 d217 2
       
  2366 a218 1
       
  2367 Examples: =<b>%<nop>TOC{depth="2"}%</b>=, =<b>%<nop>TOC{"TWikiDocumentation" web="%TWIKIWEB%"}%</b>=
       
  2368 d407 2
       
  2369 a408 2
       
  2370 -- PeterThoeny - 19 Jan 2003 <br />
       
  2371 -- Main.MikeMannix - 12 May 2002
       
  2372 @
       
  2373 
       
  2374 
       
  2375 1.70
       
  2376 log
       
  2377 @none
       
  2378 @
       
  2379 text
       
  2380 @d1 1
       
  2381 a1 1
       
  2382 %META:TOPICINFO{author="PeterThoeny" date="1067684884" format="1.0" version="1.70"}%
       
  2383 d48 1
       
  2384 a48 1
       
  2385   <td> Small 16x16 pixel icon of common attachment types, like =bmp=, =doc=, =gif=, =hlp=, =html=, =pdf=, =ppt=, =txt=, =wav=, =xml=, =zip=, etc. Specify file type only, file name, or full path name. Example: =%<nop>ICON{"pdf"}%= returns %ICON{"pdf"}% </td>
       
  2386 @
       
  2387 
       
  2388 
       
  2389 1.69
       
  2390 log
       
  2391 @none
       
  2392 @
       
  2393 text
       
  2394 @d1 1
       
  2395 a1 1
       
  2396 %META:TOPICINFO{author="PeterThoeny" date="1064795307" format="1.0" version="1.69"}%
       
  2397 d217 3
       
  2398 a219 1
       
  2399 | =web="Name"= <br /> =web="%MAINWEB% Know"= <br /> =web="all"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. [2] | Current web |
       
  2400 @
       
  2401 
       
  2402 
       
  2403 1.68
       
  2404 log
       
  2405 @none
       
  2406 @
       
  2407 text
       
  2408 @d1 1
       
  2409 a1 1
       
  2410 %META:TOPICINFO{author="PeterThoeny" date="1062139775" format="1.0" version="1.68"}%
       
  2411 d51 1
       
  2412 a51 1
       
  2413   <td> Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name and newline:
       
  2414 d230 2
       
  2415 @
       
  2416 
       
  2417 
       
  2418 1.67
       
  2419 log
       
  2420 @none
       
  2421 @
       
  2422 text
       
  2423 @d1 1
       
  2424 a1 1
       
  2425 %META:TOPICINFO{author="PeterThoeny" date="1061625101" format="1.0" version="1.67"}%
       
  2426 d52 4
       
  2427 a55 3
       
  2428 	 | *Parameter:* | *Description:* |
       
  2429 	 | ="name"= | The name of a URL parameter |
       
  2430 	 | =newline="&lt;br /&gt;"= | Convert newlines to other delimiters |
       
  2431 @
       
  2432 
       
  2433 
       
  2434 1.66
       
  2435 log
       
  2436 @none
       
  2437 @
       
  2438 text
       
  2439 @d1 1
       
  2440 a1 1
       
  2441 %META:TOPICINFO{author="PeterThoeny" date="1061617140" format="1.0" version="1.66"}%
       
  2442 d191 1
       
  2443 @
       
  2444 
       
  2445 
       
  2446 1.65
       
  2447 log
       
  2448 @none
       
  2449 @
       
  2450 text
       
  2451 @d1 1
       
  2452 a1 1
       
  2453 %META:TOPICINFO{author="PeterThoeny" date="1057016404" format="1.0" version="1.65"}%
       
  2454 d51 6
       
  2455 a56 1
       
  2456   <td> Returns the value of a URL parameter. Note that there is a low risk that this variable could be misused for cross-scripting. Ex: =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b> </td>
       
  2457 @
       
  2458 
       
  2459 
       
  2460 1.64
       
  2461 log
       
  2462 @none
       
  2463 @
       
  2464 text
       
  2465 @d1 1
       
  2466 a1 1
       
  2467 %META:TOPICINFO{author="PeterThoeny" date="1048314917" format="1.0" version="1.64"}%
       
  2468 d46 3
       
  2469 @
       
  2470 
       
  2471 
       
  2472 1.63
       
  2473 log
       
  2474 @none
       
  2475 @
       
  2476 text
       
  2477 @d1 1
       
  2478 a1 1
       
  2479 %META:TOPICINFO{author="PeterThoeny" date="1044751568" format="1.0" version="1.63"}%
       
  2480 d380 1
       
  2481 a380 1
       
  2482 *Example: Create a custom logo variable the %WEB% web* <br />
       
  2483 @
       
  2484 
       
  2485 
       
  2486 1.62
       
  2487 log
       
  2488 @none
       
  2489 @
       
  2490 text
       
  2491 @d1 1
       
  2492 a1 1
       
  2493 %META:TOPICINFO{author="PeterThoeny" date="1043655738" format="1.0" version="1.62"}%
       
  2494 d297 4
       
  2495 @
       
  2496 
       
  2497 
       
  2498 1.61
       
  2499 log
       
  2500 @none
       
  2501 @
       
  2502 text
       
  2503 @d1 1
       
  2504 a1 1
       
  2505 %META:TOPICINFO{author="PeterThoeny" date="1042964469" format="1.0" version="1.61"}%
       
  2506 d249 1
       
  2507 @
       
  2508 
       
  2509 
       
  2510 1.60
       
  2511 log
       
  2512 @none
       
  2513 @
       
  2514 text
       
  2515 @d1 1
       
  2516 a1 1
       
  2517 %META:TOPICINFO{author="PeterThoeny" date="1039594200" format="1.0" version="1.60"}%
       
  2518 d221 2
       
  2519 a222 1
       
  2520 Formatted example: ==%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"%== _(displays results in a table with header - [[FormattedSearch][details]])_
       
  2521 d380 1
       
  2522 a380 1
       
  2523 -- PeterThoeny - 13 Sep 2001 <br />
       
  2524 @
       
  2525 
       
  2526 
       
  2527 1.59
       
  2528 log
       
  2529 @none
       
  2530 @
       
  2531 text
       
  2532 @d1 1
       
  2533 a1 1
       
  2534 %META:TOPICINFO{author="PeterThoeny" date="1038026520" format="1.0" version="1.59"}%
       
  2535 d176 7
       
  2536 a182 4
       
  2537   <td> Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional =pattern="(reg-exp)"=. The page name is:
       
  2538 	| ="SomeTopic"= | The name of a topic located in the current web, i.e. =%<nop>INCLUDE{"WebNotify"}%= |
       
  2539 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%= |
       
  2540 	| ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://twiki.org/"}%= |
       
  2541 d219 1
       
  2542 a219 1
       
  2543 | ==header="..."== <br /> ==format="..."== | Custom format results: see *[[FormattedSearch]]* for usage, variables & examples | Results in table |
       
  2544 @
       
  2545 
       
  2546 
       
  2547 1.58
       
  2548 log
       
  2549 @none
       
  2550 @
       
  2551 text
       
  2552 @d1 1
       
  2553 a1 1
       
  2554 %META:TOPICINFO{author="PeterThoeny" date="1033867260" format="1.0" version="1.58"}%
       
  2555 d202 1
       
  2556 a202 1
       
  2557 | ="text"= | Search term. (Is a regular expression or literal, depending on the =regex= parameter) [TWikiAlphaRelease - for regular expressions ";" can be used to mean _and_ e.g. "search;agrep" will find all topic containing search _and_ agrep ] | required |
       
  2558 d208 1
       
  2559 a208 1
       
  2560 | =regex="on"= | RegularExpression search | Literal search |
       
  2561 @
       
  2562 
       
  2563 
       
  2564 1.57
       
  2565 log
       
  2566 @none
       
  2567 @
       
  2568 text
       
  2569 @d1 1
       
  2570 a1 1
       
  2571 %META:TOPICINFO{author="PeterThoeny" date="1030259897" format="1.0" version="1.57"}%
       
  2572 d48 1
       
  2573 a48 1
       
  2574   <td> Returns the value of a URL parameter. Ex: =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b> </td>
       
  2575 d354 5
       
  2576 d362 3
       
  2577 a364 3
       
  2578 	* The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br />[3 spaces] * [space] Set [space] VARIABLENAME [space] = [value]<br /> __Examples:__ 
       
  2579 	* ==<nop>Set VARIABLENAME = =value===
       
  2580 		* ==<nop>Set VARIABLENAME = =value===
       
  2581 @
       
  2582 
       
  2583 
       
  2584 1.56
       
  2585 log
       
  2586 @none
       
  2587 @
       
  2588 text
       
  2589 @d1 1
       
  2590 a1 1
       
  2591 %META:TOPICINFO{author="PeterThoeny" date="1023240035" format="1.0" version="1.56"}%
       
  2592 d138 1
       
  2593 a138 1
       
  2594 =%<nop>WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%= Dropdown of all public Webs + Trash Web, current Web highlighted.
       
  2595 @
       
  2596 
       
  2597 
       
  2598 1.55
       
  2599 log
       
  2600 @none
       
  2601 @
       
  2602 text
       
  2603 @d1 1
       
  2604 a1 1
       
  2605 %META:TOPICINFO{author="PeterThoeny" date="1022256244" format="1.0" version="1.55"}%
       
  2606 d192 1
       
  2607 a192 1
       
  2608   <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. (But not ="&lt;H2&gt;text&lt;/H2&gt;"=, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
       
  2609 @
       
  2610 
       
  2611 
       
  2612 1.54
       
  2613 log
       
  2614 @none
       
  2615 @
       
  2616 text
       
  2617 @d1 1
       
  2618 a1 1
       
  2619 %META:TOPICINFO{author="PeterThoeny" date="1021679280" format="1.0" version="1.54"}%
       
  2620 d357 1
       
  2621 a357 1
       
  2622 	* The syntax for Preferences Bariables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br />[3 spaces] * [space] Set [space] VARIABLENAME [space] = [value]<br /> __Examples:__ 
       
  2623 @
       
  2624 
       
  2625 
       
  2626 1.53
       
  2627 log
       
  2628 @none
       
  2629 @
       
  2630 text
       
  2631 @d1 1
       
  2632 a1 1
       
  2633 %META:TOPICINFO{author="PeterThoeny" date="1021445972" format="1.0" version="1.53"}%
       
  2634 d36 1
       
  2635 a36 1
       
  2636   <td> The public URL of TWiki, is <b>%PUBURL%</b> </td>
       
  2637 d49 3
       
  2638 @
       
  2639 
       
  2640 
       
  2641 1.52
       
  2642 log
       
  2643 @none
       
  2644 @
       
  2645 text
       
  2646 @d1 1
       
  2647 a1 1
       
  2648 %META:TOPICINFO{author="MikeMannix" date="1021201634" format="1.0" version="1.52"}%
       
  2649 d175 1
       
  2650 a175 1
       
  2651 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.TWikiSiteMap"}%= |
       
  2652 d369 1
       
  2653 a369 1
       
  2654 -- Main.MikeMannix - 12 May 2002
       
  2655 @
       
  2656 
       
  2657 
       
  2658 1.51
       
  2659 log
       
  2660 @none
       
  2661 @
       
  2662 text
       
  2663 @d1 1
       
  2664 a1 1
       
  2665 %META:TOPICINFO{author="PeterThoeny" date="1018175400" format="1.0" version="1.51"}%
       
  2666 d175 1
       
  2667 a175 1
       
  2668 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%= |
       
  2669 d199 1
       
  2670 a199 1
       
  2671 | ="text"= | Search term. (Is a regular expression or literal, depending on the =regex= parameter) | required |
       
  2672 d228 1
       
  2673 a228 1
       
  2674 | =title="Title"= | Text the is prepended to any search results | required |
       
  2675 d351 1
       
  2676 a351 1
       
  2677 
       
  2678 d354 1
       
  2679 a354 1
       
  2680 	* The syntax for Preferences variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br />[3 spaces] * [space] Set [space] VARIABLENAME [space] = [value]<br /> __Examples:__ 
       
  2681 d360 1
       
  2682 a360 1
       
  2683 	* 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.
       
  2684 d362 4
       
  2685 a365 4
       
  2686 <blockquote style="background-color:#f5f5f5">
       
  2687 *Example: Create a custom logo variable* <br />
       
  2688 	* To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, simply define the variable on the web's WebPreferences page. You also have to upload =logo.gif= - this can be done by [[FileAttachment][attaching a file]] to =LogoTopic= (any topic name you choose):
       
  2689 		* ==<nop>Set MYLOGO = %<nop>PUBURL%/%<nop>MAINWEB%/LogoTopic/logo.gif== 
       
  2690 d369 1
       
  2691 a369 1
       
  2692 -- Main.MikeMannix - 07 Mar 2002
       
  2693 @
       
  2694 
       
  2695 
       
  2696 1.50
       
  2697 log
       
  2698 @none
       
  2699 @
       
  2700 text
       
  2701 @d1 1
       
  2702 a1 1
       
  2703 %META:TOPICINFO{author="MikeMannix" date="1015559520" format="1.0" version="1.50"}%
       
  2704 d175 1
       
  2705 a175 1
       
  2706 	| ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%= |
       
  2707 @
       
  2708 
       
  2709 
       
  2710 1.49
       
  2711 log
       
  2712 @none
       
  2713 @
       
  2714 text
       
  2715 @d1 1
       
  2716 a1 1
       
  2717 %META:TOPICINFO{author="PeterThoeny" date="1013855830" format="1.0" version="1.49"}%
       
  2718 d189 1
       
  2719 a189 1
       
  2720   <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;h2&gt;"=) are taken into account. (But not ="&lt;H2&gt;text&lt;/H2&gt;"=, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
       
  2721 d369 1
       
  2722 a369 1
       
  2723 -- Main.MikeMannix - 23 Jan 2002
       
  2724 @
       
  2725 
       
  2726 
       
  2727 1.48
       
  2728 log
       
  2729 @none
       
  2730 @
       
  2731 text
       
  2732 @d1 1
       
  2733 a1 1
       
  2734 %META:TOPICINFO{author="MikeMannix" date="1011781320" format="1.0" version="1.48"}%
       
  2735 d203 1
       
  2736 a203 1
       
  2737 | =order="topic"= <br /> =order="modified"= <br /> =order="editby"= | Sort the results of search by the topic names, last modified time, or last editor | Sort by topic name |
       
  2738 @
       
  2739 
       
  2740 
       
  2741 1.47
       
  2742 log
       
  2743 @none
       
  2744 @
       
  2745 text
       
  2746 @d1 1
       
  2747 a1 1
       
  2748 %META:TOPICINFO{author="MikeMannix" date="1010288700" format="1.0" version="1.47"}%
       
  2749 d7 1
       
  2750 a7 3
       
  2751 _Text strings expanded on the fly to display data or system info_
       
  2752 
       
  2753 ---++ Overview
       
  2754 d213 4
       
  2755 a216 2
       
  2756 | ==format="..."== | Flexible custom result formatting: see *[[FormattedSearch]]* for usage | Results in table |
       
  2757 Example: =<b>%<nop>SEARCH{"wiki" web="%MAINWEB%" scope="topic"}%</b>= </td>
       
  2758 d224 1
       
  2759 a224 1
       
  2760 								="parent"= if searcing for topics that have a specific parent i.e. its \
       
  2761 d228 1
       
  2762 a228 1
       
  2763 | =title="Title"= | Text the is pre-pended to any search results | required |
       
  2764 d369 1
       
  2765 a369 1
       
  2766 -- Main.MikeMannix - 05 Jan 2002	
       
  2767 @
       
  2768 
       
  2769 
       
  2770 1.46
       
  2771 log
       
  2772 @none
       
  2773 @
       
  2774 text
       
  2775 @d1 1
       
  2776 a1 1
       
  2777 %META:TOPICINFO{author="MikeMannix" date="1007294280" format="1.0" version="1.46"}%
       
  2778 d11 1
       
  2779 a11 1
       
  2780 <nop>TWikiVariables are text strings - =%<nop>VARIABLE%= - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.
       
  2781 d15 1
       
  2782 a15 1
       
  2783 Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.
       
  2784 d17 3
       
  2785 a19 1
       
  2786 %WIKITOOLNAME% expands the following variables (enclosed in ==%== percent signs):
       
  2787 d53 1
       
  2788 a53 1
       
  2789   <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b> </td>
       
  2790 d56 1
       
  2791 a56 1
       
  2792   <td> Wiki tool version is <b>%WIKIVERSION%</b> </td>
       
  2793 d59 1
       
  2794 a59 1
       
  2795   <td> Your login username is <b>%USERNAME%</b> </td>
       
  2796 d65 1
       
  2797 a65 1
       
  2798   <td> Your %<nop>WIKINAME% including the %MAINWEB% web name. Usefull for signatures. Is <b>%WIKIUSERNAME%</b> </td>
       
  2799 d68 1
       
  2800 a68 1
       
  2801   <td> The Main web containing %MAINWEB%.%WIKIUSERSTOPIC%, %MAINWEB%.OfficeLocations and %MAINWEB%.TWikiGroups. Is <b>%MAINWEB%</b> </td>
       
  2802 d71 1
       
  2803 a71 1
       
  2804   <td> The web containing all documentation and configuration of %WIKITOOLNAME% is <b>%TWIKIWEB%</b> </td>
       
  2805 d80 1
       
  2806 a80 1
       
  2807   <td> The web name of the topic that includes the current topic. Same as =%<nop>WEB%= in case there is no include. </td>
       
  2808 d83 1
       
  2809 a83 1
       
  2810   <td> The home topic in each web. Is <b>[[%HOMETOPIC%]]</b> </td>
       
  2811 d86 1
       
  2812 a86 1
       
  2813   <td> The notify topic in each web. Is <b>[[%NOTIFYTOPIC%]]</b> </td>
       
  2814 d89 1
       
  2815 a89 1
       
  2816   <td> The index topic of all registered users. Is <b>%WIKIUSERSTOPIC%</b></td>
       
  2817 d92 1
       
  2818 a92 1
       
  2819   <td> The web preferences topic. Is <b>%WIKIPREFSTOPIC%</b> </td>
       
  2820 d95 1
       
  2821 a95 1
       
  2822   <td> The web preferences topic. Is <b>%WEBPREFSTOPIC%</b> </td>
       
  2823 d98 1
       
  2824 a98 1
       
  2825   <td> The web statistics topic. Is <b>%STATISTICSTOPIC%</b> </td>
       
  2826 d101 1
       
  2827 a101 1
       
  2828   <td> The current topic name, is <b>%TOPIC%</b> </td>
       
  2829 d104 1
       
  2830 a104 1
       
  2831   <td> The name of the topic where the includes started, e.g. the first topic of nested includes. Same as =%<nop>TOPIC%= in case there is no include. </td>
       
  2832 d126 1
       
  2833 a126 1
       
  2834   <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=.
       
  2835 d239 1
       
  2836 a239 1
       
  2837 [2] __Note__: A web can be excluded from a =web="all"= search if you define a =NOSEARCHALL=on= variable in its %WEBPREFSTOPIC%.
       
  2838 d354 3
       
  2839 a356 2
       
  2840 	* 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:__ 
       
  2841 		* ==<nop>Set VARIABLENAME = value==
       
  2842 d369 1
       
  2843 a369 1
       
  2844 -- MikeMannix - 30 Nov 2001	
       
  2845 @
       
  2846 
       
  2847 
       
  2848 1.45
       
  2849 log
       
  2850 @none
       
  2851 @
       
  2852 text
       
  2853 @d1 1
       
  2854 a1 1
       
  2855 %META:TOPICINFO{author="MikeMannix" date="1007115240" format="1.0" version="1.45"}%
       
  2856 d19 1
       
  2857 a19 1
       
  2858 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="font-family:sans-serif;font-size:13px;background-color:#f5f5f5">
       
  2859 d213 1
       
  2860 a216 26
       
  2861 <td> =%<nop>SEARCH{... format="..."}%= </td>
       
  2862 <td> *Control the formatting of an embedded search.* By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the =format="..."= parameter to specify a custom format, typically, a bullet list or table row containing variables <br />
       
  2863 Ex: =%<nop>SEARCH{ "food" format="| $topic | $summary |" }%=) <br />
       
  2864  *Two paramters can be used to specify a customized search result:* <br />
       
  2865 *1.* =header="..."= parameter <br />
       
  2866 Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. Ex: =header="| <nop>*Topic:*<nop> | <nop>*Summary:*<nop> |"= <br />
       
  2867 *2.* =format="..."= parameter <br />
       
  2868 *Use the format paramter to specify the format of one search hit.* <br />
       
  2869 Ex: =format="| $topic | $summary |"= <br />
       
  2870 *Variables that can be used in the format string:*
       
  2871 | *Name:* | *Expands To:* |
       
  2872 | =$web= | Name of the web |
       
  2873 | =$topic= | Topic name |
       
  2874 | =$locked= | LOCKED flag (if any) |
       
  2875 | =$date= | Time stamp of last topic update |
       
  2876 | =$rev= | Number of last topic revision, i.e. =1.4= |
       
  2877 | =$wikiusername= | Wiki user name of last topic update, i.e. =%MAINWEB%.<nop>JohnSmith= |
       
  2878 | =$summary= | Topic summary |
       
  2879 | =$formfield(name)= | The field value of a form field, i.e. =$formfield(TopicClassification)= would get expanded to =PublicFAQ=. This applies only to topics that have a [[TWiki.TWikiForms][TWikiForm]] |
       
  2880 | =$pattern(reg-exp)= | A regular expression pattern to extract some text from a topic, i.e. =$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)= extracts the email address from a bullet of format =* Email: ...=. |
       
  2881 __Note:__ For =$pattern(reg-exp)=, specify a TWiki.RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, ex: =$pattern(.*?(from here.*?to here).*)=. You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag. <br />
       
  2882 *NOTE:* Sorting is nicely covered by the TWiki.TablePlugin. <br />
       
  2883 __For how-to tips and tricks, see: TWikiVariablesExamples__
       
  2884 </td>
       
  2885 </tr>
       
  2886 <tr>
       
  2887 d244 1
       
  2888 a244 1
       
  2889 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="font-family:sans-serif;font-size:13px;background-color:#f5f5f5">
       
  2890 d355 1
       
  2891 a355 1
       
  2892 ---++ Customizing Variables
       
  2893 d357 7
       
  2894 a363 1
       
  2895 __See:__ [[TWikiVariablesExamples][<nop>TWikiVariables Examples]]
       
  2896 @
       
  2897 
       
  2898 
       
  2899 1.44
       
  2900 log
       
  2901 @none
       
  2902 @
       
  2903 text
       
  2904 @d1 1
       
  2905 a1 1
       
  2906 %META:TOPICINFO{author="PeterThoeny" date="1003975824" format="1.0" version="1.44"}%
       
  2907 d15 1
       
  2908 a15 1
       
  2909 With a couple of notable exceptions, predefined variables return  set values that are defined 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. 
       
  2910 d208 2
       
  2911 a209 4
       
  2912 | =nosummary="on"= | Show topic title only. [3] | Show topic summary |
       
  2913 | =bookview="on"= | BookView search, e.g. show complete topic text. [3] | Show topic summary. |
       
  2914 | =format="..."= | Define a FormattedSearch, i.e. <br /> ="	* [<nop>[$topic]]: $summary"=. [3] | Show regular search result with topic summary |
       
  2915 | =header="..."= | Specify header of FormattedSearch, i.e. <br /> ="	* <nop>*Topic: Summary:*"=. | Show regular header |
       
  2916 d214 28
       
  2917 a241 1
       
  2918 </tr><tr>
       
  2919 a262 2
       
  2920 
       
  2921 [3] __Note__: Regular search, no summary, BookView and FormattedSearch are exclusive.
       
  2922 d380 1
       
  2923 a380 3
       
  2924 ---++ Creating Custom Variables
       
  2925 
       
  2926 	* 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.
       
  2927 d382 1
       
  2928 a382 5
       
  2929 <blockquote style="background-color:#f5f5f5">
       
  2930 *Example: Create a custom logo variable* <br />
       
  2931 	* To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, simply define the variable on the web's WebPreferences page. You also have to upload =logo.gif= - this can be done by [[FileAttachment][attaching a file]] to =LogoTopic= (any topic name you choose):
       
  2932 		* ==<nop>Set MYLOGO = %<nop>PUBURL%/%<nop>MAINWEB%/LogoTopic/logo.gif== 
       
  2933 </blockquote>
       
  2934 a383 1
       
  2935 -- MikeMannix - 30 Aug 2001 <br />	
       
  2936 d385 1
       
  2937 @
       
  2938 
       
  2939 
       
  2940 1.43
       
  2941 log
       
  2942 @none
       
  2943 @
       
  2944 text
       
  2945 @d1 1
       
  2946 a1 1
       
  2947 %META:TOPICINFO{author="MikeMannix" date="1000548079" format="1.0" version="1.43"}%
       
  2948 d208 4
       
  2949 a211 2
       
  2950 | =nosummary="on"= | Show topic title only | Show topic summary |
       
  2951 | =bookview="on"= | BookView search, e.g. show complete topic text | Show topic summary |
       
  2952 d238 2
       
  2953 @
       
  2954 
       
  2955 
       
  2956 1.42
       
  2957 log
       
  2958 @none
       
  2959 @
       
  2960 text
       
  2961 @d1 1
       
  2962 a1 1
       
  2963 %META:TOPICINFO{author="PeterThoeny" date="1000447660" format="1.0" version="1.42"}%
       
  2964 a2 2
       
  2965 %INCLUDE{"UtilTempDocNote"}%
       
  2966 
       
  2967 d7 1
       
  2968 a7 1
       
  2969 _Text strings expanded on the fly include predefined, preference-driven and custom-defined data_
       
  2970 d11 1
       
  2971 a11 1
       
  2972 <nop>TWikiVariables are text strings enclosed in percentage signs: ==%<no>VARIABLE%== 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!
       
  2973 d15 1
       
  2974 a15 1
       
  2975 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. 
       
  2976 d17 1
       
  2977 a17 1
       
  2978 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
       
  2979 d19 1
       
  2980 a19 1
       
  2981 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="font-family:sans-serif;font-size:13px;background-color:#fafafa">
       
  2982 d87 4
       
  2983 a90 1
       
  2984   <td> The index topic of all registered users. Is <b>%WIKIUSERSTOPIC%</b> </td>
       
  2985 d242 1
       
  2986 a242 1
       
  2987 <table cellspacing="0" cellpadding="2" width="90%" border="1" align="center" style="font-family:sans-serif;font-size:13px;background-color:#fafafa">
       
  2988 d357 1
       
  2989 a357 1
       
  2990 <blockquote style="background-color:#f0f0f0">
       
  2991 @
       
  2992 
       
  2993 
       
  2994 1.41
       
  2995 log
       
  2996 @none
       
  2997 @
       
  2998 text
       
  2999 @d1 1
       
  3000 a1 1
       
  3001 %META:TOPICINFO{author="JohnTalintyre" date="1000368971" format="1.0" version="1.41"}%
       
  3002 d359 1
       
  3003 a359 1
       
  3004 		* ==<nop>Set MYLOGO = %<nop>PUBURLPATH%/%<nop>MAINWEB%/LogoTopic/logo.gif== 
       
  3005 d363 1
       
  3006 @
       
  3007 
       
  3008 
       
  3009 1.40
       
  3010 log
       
  3011 @none
       
  3012 @
       
  3013 text
       
  3014 @d1 2
       
  3015 a2 1
       
  3016 %META:TOPICINFO{author="MikeMannix" date="1000280274" format="1.0" version="1.40"}%
       
  3017 d44 1
       
  3018 a44 1
       
  3019   <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 =<b>%<nop>ATTACHURL%/image.gif</b>= </td>
       
  3020 d118 3
       
  3021 a120 3
       
  3022 	 <br> =%<nop>TOPICLIST{"	* $web.$name"}%= creates a bullet list of all topics.
       
  3023 	 <br> =%<nop>TOPICLIST{separator=", "}%= creates a comma separated list of all topics.
       
  3024 	 <br> =%<nop>TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%= creates an option list (for drop down menus). </td>
       
  3025 d131 2
       
  3026 a132 2
       
  3027 	 | =selection= | Current value e.g. current for current Web, =section="%<nop>WEB%" |
       
  3028 	 Examples: <br> =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs.
       
  3029 d151 1
       
  3030 a151 1
       
  3031 	 Variables can be shortened to 3 characters. Example: <br> =%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}%= is <br> <b>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</b> </td>
       
  3032 d157 1
       
  3033 a157 1
       
  3034   <td> Formatted server time. <br> Example: =%<nop>SERVERTIME{"$hou:$min"}%= is <b>%SERVERTIME{"$hou:$min"}%</b> </td>
       
  3035 d200 4
       
  3036 a203 4
       
  3037 | =web="Name"= <br> =web="%MAINWEB% Know"= <br> =web="all"= | Wiki web to search: A web, a list of webs separated by whitespace, or =all= webs. [2] | Current web |
       
  3038 | =scope="topic"= <br> =scope="text"= | Search topic name (title) or in the text (body) of the topic | Topic text (body) |
       
  3039 | =order="topic"= <br> =order="modified"= <br> =order="editby"= | Sort the results of search by the topic names, last modified time, or last editor | Sort by topic name |
       
  3040 | =limit="all"= <br> =limit="16"= | Limit the number of results returned | All results |
       
  3041 d210 1
       
  3042 a210 1
       
  3043 | =noheader="on"= | Suppress search header <br> <span style='background: #FFB0B0;'> *Topics: Changed: By:* </span> | Show search header |
       
  3044 d214 13
       
  3045 d349 1
       
  3046 a349 1
       
  3047 	* 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:__ 
       
  3048 d357 1
       
  3049 a357 1
       
  3050 *Example: Create a custom logo variable* <br>
       
  3051 d362 1
       
  3052 a362 1
       
  3053 -- MikeMannix - 30 Aug 2001 <br>	
       
  3054 @
       
  3055 
       
  3056 
       
  3057 1.39
       
  3058 log
       
  3059 @none
       
  3060 @
       
  3061 text
       
  3062 @d1 3
       
  3063 a3 1
       
  3064 %META:TOPICINFO{author="MikeMannix" date="999858969" format="1.0" version="1.39"}%
       
  3065 @
       
  3066 
       
  3067 
       
  3068 1.38
       
  3069 log
       
  3070 @none
       
  3071 @
       
  3072 text
       
  3073 @d1 1
       
  3074 a1 1
       
  3075 %META:TOPICINFO{author="MikeMannix" date="999839991" format="1.0" version="1.38"}%
       
  3076 d4 5
       
  3077 a8 1
       
  3078 ---## TWiki Variables
       
  3079 d12 1
       
  3080 a12 1
       
  3081 ---+++ Predefined Variables
       
  3082 d221 1
       
  3083 a221 1
       
  3084 ---+++ Preferences Variables
       
  3085 d331 1
       
  3086 a331 1
       
  3087 ---+++ Setting Preferences
       
  3088 d336 1
       
  3089 a336 1
       
  3090 ---+++ Creating Custom Variables
       
  3091 @
       
  3092 
       
  3093 
       
  3094 1.37
       
  3095 log
       
  3096 @none
       
  3097 @
       
  3098 text
       
  3099 @d1 1
       
  3100 a1 1
       
  3101 %META:TOPICINFO{author="MikeMannix" date="999315578" format="1.0" version="1.37"}%
       
  3102 d337 2
       
  3103 a338 2
       
  3104 <span style="color:#0000ff"><b>HOW-TO: Create a custom logo variable</b></span><br>
       
  3105 To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, simply define the variable on the web's WebPreferences page. In this case, you also have to upload ==logo.gif== to the same directory.: 
       
  3106 @
       
  3107 
       
  3108 
       
  3109 1.36
       
  3110 log
       
  3111 @none
       
  3112 @
       
  3113 text
       
  3114 @d1 1
       
  3115 a1 1
       
  3116 %META:TOPICINFO{author="MikeMannix" date="999237983" format="1.0" version="1.36"}%
       
  3117 d6 1
       
  3118 a6 1
       
  3119 <nop>TWikiVariables are text strings enclosed in percentage signs: ==%<no>VARIABLE%== that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
       
  3120 d10 2
       
  3121 d14 3
       
  3122 a16 2
       
  3123 <table border="1"><tr>
       
  3124   <th> Variable: </th><th> Expanded to: </th>
       
  3125 a208 1
       
  3126 
       
  3127 d211 1
       
  3128 d215 1
       
  3129 d221 3
       
  3130 a223 2
       
  3131 <table border="1"><tr>
       
  3132   <th> Variable: </th><th> Level: </th><th> What: </th>
       
  3133 d326 2
       
  3134 a327 1
       
  3135 ---+++ Setting Variable Preferences
       
  3136 d334 7
       
  3137 a340 2
       
  3138 	* 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.<br> __Example:__ To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload ==logo.gif== to the same directory): 
       
  3139 		* ==<nop>Set MYLOGO = %<nop>PUBURLPATH%/%<nop>MAINWEB%/LogoTopic/logo.gif==
       
  3140 @
       
  3141 
       
  3142 
       
  3143 1.35
       
  3144 log
       
  3145 @none
       
  3146 @
       
  3147 text
       
  3148 @d1 1
       
  3149 a1 1
       
  3150 %META:TOPICINFO{author="MikeMannix" date="999187591" format="1.0" version="1.35"}%
       
  3151 a4 2
       
  3152 
       
  3153 ---+++ About Variables
       
  3154 @
       
  3155 
       
  3156 
       
  3157 1.34
       
  3158 log
       
  3159 @none
       
  3160 @
       
  3161 text
       
  3162 @d1 1
       
  3163 a1 1
       
  3164 %META:TOPICINFO{author="MikeMannix" date="999182965" format="1.0" version="1.34"}%
       
  3165 d8 1
       
  3166 a8 1
       
  3167 __Include/write if not found elsewhere.__
       
  3168 d27 1
       
  3169 a27 1
       
  3170   <td> The script suffix, i.e. =.pl=, is <b>%SCRIPTSUFFIX%</b></td>
       
  3171 d42 1
       
  3172 a42 1
       
  3173   <td> Returns the value of a URL parameter. I.e. =%<nop>URLPARAM{"skin"}%= returns <b>print</b> for a =.../view/%WEB%/%TOPIC%?skin=print= URL. Is <b>%URLPARAM{"skin"}%</b> </td>
       
  3174 d48 1
       
  3175 a48 1
       
  3176   <td> Wiki tool version, is <b>%WIKIVERSION%</b> </td>
       
  3177 d51 1
       
  3178 a51 1
       
  3179   <td> Your login username, is <b>%USERNAME%</b> </td>
       
  3180 d63 1
       
  3181 a63 1
       
  3182   <td> The web containing all documentation and configuration of %WIKITOOLNAME%. Is <b>%TWIKIWEB%</b> </td>
       
  3183 d66 1
       
  3184 a66 1
       
  3185   <td> The current web, is <b>%WEB%</b> </td>
       
  3186 d323 1
       
  3187 a323 2
       
  3188 
       
  3189 ---+++ Setting and Creating New Preferences
       
  3190 d327 4
       
  3191 a330 1
       
  3192 	* 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, images.<br> __Example:__ To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload ==logo.gif== to the same directory): 
       
  3193 d333 1
       
  3194 a333 1
       
  3195 -- MikeMannix - 26 Aug 2001 <br>	
       
  3196 @
       
  3197 
       
  3198 
       
  3199 1.33
       
  3200 log
       
  3201 @none
       
  3202 @
       
  3203 text
       
  3204 @d1 1
       
  3205 a1 1
       
  3206 %META:TOPICINFO{author="MikeMannix" date="999044161" format="1.0" version="1.33"}%
       
  3207 @
       
  3208 
       
  3209 
       
  3210 1.32
       
  3211 log
       
  3212 @none
       
  3213 @
       
  3214 text
       
  3215 @d1 1
       
  3216 a1 1
       
  3217 %META:TOPICINFO{author="MikeMannix" date="998886670" format="1.0" version="1.32"}%
       
  3218 d6 4
       
  3219 d324 1
       
  3220 a324 1
       
  3221 __Notes:__
       
  3222 d326 4
       
  3223 a329 4
       
  3224 	* Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax: 
       
  3225 		* =<nop>Set VARIABLENAME = value=
       
  3226 	* Additional preferences variables can be defined on all three level as needed. Example:
       
  3227 		* =<nop>Set MYLOGO = %<nop>PUBURLPATH%/%<nop>MAINWEB%/LogoTopic/logo.gif=
       
  3228 a330 1
       
  3229 -- PeterThoeny - 23 Jul 2001 <br>
       
  3230 @
       
  3231 
       
  3232 
       
  3233 1.31
       
  3234 log
       
  3235 @none
       
  3236 @
       
  3237 text
       
  3238 @d1 1
       
  3239 a1 1
       
  3240 %META:TOPICINFO{author="MikeMannix" date="998863709" format="1.0" version="1.31"}%
       
  3241 d328 1
       
  3242 a328 1
       
  3243 -- Main.MikeMannix - 26 Aug 2001 <br />	
       
  3244 @
       
  3245 
       
  3246 
       
  3247 1.30
       
  3248 log
       
  3249 @none
       
  3250 @
       
  3251 text
       
  3252 @d1 3
       
  3253 a3 1
       
  3254 %META:TOPICINFO{author="PeterThoeny" date="997885781" format="1.0beta2" version="1.30"}%
       
  3255 d173 1
       
  3256 a173 1
       
  3257   <td> Table of Content of current topic. </td>
       
  3258 d176 1
       
  3259 a176 1
       
  3260   <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;h2&gt;"=) are taken into account. (But not ="&lt;H2&gt;text&lt;H2&gt;"=, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
       
  3261 d328 1
       
  3262 @
       
  3263 
       
  3264 
       
  3265 1.29
       
  3266 log
       
  3267 @none
       
  3268 @
       
  3269 text
       
  3270 @d1 1
       
  3271 a1 1
       
  3272 %META:TOPICINFO{author="JohnTalintyre" date="997197916" format="1.0beta2" version="1.29"}%
       
  3273 d174 1
       
  3274 a174 1
       
  3275   <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;h2&gt;"=) are taken into account. Parameters are topic name, web and depth:
       
  3276 @
       
  3277 
       
  3278 
       
  3279 1.28
       
  3280 log
       
  3281 @none
       
  3282 @
       
  3283 text
       
  3284 @d1 1
       
  3285 a1 1
       
  3286 %META:TOPICINFO{author="PeterThoeny" date="995873452" format="1.0beta2" version="1.28"}%
       
  3287 d109 1
       
  3288 a109 1
       
  3289   <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable gets expanded to the name of the web.
       
  3290 d115 7
       
  3291 a121 1
       
  3292 	 Example: <br> =%<nop>WEBLIST{"	* [<nop>[$name.%HOMETOPIC%]]"}%= creates a bullet list of all webs. </td>
       
  3293 d296 17
       
  3294 @
       
  3295 
       
  3296 
       
  3297 1.27
       
  3298 log
       
  3299 @none
       
  3300 @
       
  3301 text
       
  3302 @d1 1
       
  3303 a1 1
       
  3304 %META:TOPICINFO{author="PeterThoeny" date="995164458" format="1.0beta2" version="1.27"}%
       
  3305 d53 6
       
  3306 d68 15
       
  3307 d302 1
       
  3308 a302 1
       
  3309 -- PeterThoeny - 14 Jul 2001 <br>
       
  3310 @
       
  3311 
       
  3312 
       
  3313 1.26
       
  3314 log
       
  3315 @none
       
  3316 @
       
  3317 text
       
  3318 @d1 1
       
  3319 a1 1
       
  3320 %META:TOPICINFO{version="1.26" date="994871489" author="PeterThoeny" format="1.0beta2"}%
       
  3321 d75 7
       
  3322 a81 1
       
  3323   <td> Topic index of a web. Parameter is composed of the format, followed by an optional =web="Name"=. The ="format"= defines the format of one topic item; use it to create any formatting you need. The =$name= variable is expanded to the topic name; the =$web= variable is expanded to the name of the web.
       
  3324 d84 1
       
  3325 d88 6
       
  3326 a93 1
       
  3327   <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a =NOSEARCHALL=on= preference variable. The ="format"= defines the format of one web item. The =$name= variable is expanded to the name of the web.
       
  3328 d131 1
       
  3329 a131 1
       
  3330   <td> Server side include to IncludeTopicsAndWebPages. The parameter is composed of the page name, followed by an optional =pattern="(reg-exp)"= pair. The page name is:
       
  3331 d147 3
       
  3332 a149 2
       
  3333   <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;h2&gt;"=) are taken into account. Parameter is composed of the topic name, followed by optional =name="value"= pairs:
       
  3334 | *Pair:* | *Description:* | *Default:* |
       
  3335 d154 5
       
  3336 a158 4
       
  3337   <td> =%<nop>SEARCH{"str" ...}%= </td>
       
  3338   <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional =name="value"= pairs: [1]
       
  3339 | *Pair:* | *Description:* | *Default:* |
       
  3340 | =search="food"= | Search term, (either regex or literal, depending on the =regex= parameter) | (used if initial search term is missing) |
       
  3341 d229 8
       
  3342 d281 1
       
  3343 a281 1
       
  3344 -- PeterThoeny - 25 Jun 2001 <br>
       
  3345 @
       
  3346 
       
  3347 
       
  3348 1.25
       
  3349 log
       
  3350 @none
       
  3351 @
       
  3352 text
       
  3353 @d1 1
       
  3354 d47 3
       
  3355 d51 1
       
  3356 a51 1
       
  3357   <td> Your Wiki username, if defined in %MAINWEB%.%WIKIUSERSTOPIC%. Same as %<nop>USERNAME% if not defined. Is <b>%WIKIUSERNAME%</b> </td>
       
  3358 @
       
  3359 
       
  3360 
       
  3361 1.24
       
  3362 log
       
  3363 @none
       
  3364 @
       
  3365 text
       
  3366 @d114 6
       
  3367 a119 2
       
  3368   <td> =%<nop>INCLUDE{"SomeTopic"}%= </td>
       
  3369   <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%</b>= </td>
       
  3370 d141 1
       
  3371 a141 1
       
  3372 | =web="Name"= <br> =web="%MAINWEB% Know"= <br> =web="all"= | Wiki web to search: A web, a list of webs separated by whitespace, or all webs =[2]= | Current web |
       
  3373 d255 1
       
  3374 a255 1
       
  3375 -- PeterThoeny - 24 Mar 2001 <br>
       
  3376 @
       
  3377 
       
  3378 
       
  3379 1.23
       
  3380 log
       
  3381 @none
       
  3382 @
       
  3383 text
       
  3384 @d70 10
       
  3385 @
       
  3386 
       
  3387 
       
  3388 1.22
       
  3389 log
       
  3390 @none
       
  3391 @
       
  3392 text
       
  3393 @d34 3
       
  3394 @
       
  3395 
       
  3396 
       
  3397 1.21
       
  3398 log
       
  3399 @none
       
  3400 @
       
  3401 text
       
  3402 @d121 1
       
  3403 a121 1
       
  3404   <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional =name="value"= pairs:
       
  3405 d123 2
       
  3406 a124 1
       
  3407 | =web="Name"= <br> =web="%MAINWEB% Know"= <br> =web="all"= | Wiki web to search: A web, a list of webs separated by whitespace, or all webs =[1]= | Current web |
       
  3408 d143 3
       
  3409 a145 1
       
  3410 [1] __Note__: A web can be excluded from a =web="all"= search if you define a =NOSEARCHALL=on= variable in its %WEBPREFSTOPIC%.
       
  3411 d238 1
       
  3412 a238 1
       
  3413 -- PeterThoeny - 15 Mar 2001 <br>
       
  3414 @
       
  3415 
       
  3416 
       
  3417 1.20
       
  3418 log
       
  3419 @none
       
  3420 @
       
  3421 text
       
  3422 @d1 4
       
  3423 d138 1
       
  3424 a138 1
       
  3425   <td> Get a preference value from another web then the current one. Example: To get =%<nop>WEBBGCOLOR%= of the %MAINWEB% web write =%<nop>VAR{"WEBBGCOLOR" web="%MAINWEB%"}%=, is =<b>%VAR{"WEBBGCOLOR" web="%MAINWEB%"}%</b>= </td>
       
  3426 d144 2
       
  3427 d235 1
       
  3428 a235 1
       
  3429 -- %MAINWEB%.PeterThoeny - 01 Mar 2001 <br>
       
  3430 @
       
  3431 
       
  3432 
       
  3433 1.19
       
  3434 log
       
  3435 @none
       
  3436 @
       
  3437 text
       
  3438 @d106 10
       
  3439 d229 1
       
  3440 a229 1
       
  3441 -- %MAINWEB%.PeterThoeny - 19 Jan 2001 <br>
       
  3442 @
       
  3443 
       
  3444 
       
  3445 1.18
       
  3446 log
       
  3447 @none
       
  3448 @
       
  3449 text
       
  3450 @d45 6
       
  3451 d54 6
       
  3452 d67 11
       
  3453 a77 1
       
  3454   <td> Formatted GM time based on keywords (first three characters needed.) <br> Example: =%<nop>GMTIME{"day month, year - hour:min:sec"}%= is <b>%GMTIME{"day month, year - hour:min:sec"}%</b> </td>
       
  3455 d83 1
       
  3456 a83 1
       
  3457   <td> Formatted server time. Example: =%<nop>SERVERTIME{"hou:min"}%= is <b>%SERVERTIME{"hou:min"}%</b> </td>
       
  3458 @
       
  3459 
       
  3460 
       
  3461 1.17
       
  3462 log
       
  3463 @none
       
  3464 @
       
  3465 text
       
  3466 @d97 1
       
  3467 a97 1
       
  3468 | =noheader="on"= | Suppress search header <br> <span style='background: #FFB0B0;'>Topics: Changed: By: </span> | Show search header |
       
  3469 d197 1
       
  3470 a197 1
       
  3471 -- %MAINWEB%.PeterThoeny - 10 Nov 2000 <br>
       
  3472 @
       
  3473 
       
  3474 
       
  3475 1.16
       
  3476 log
       
  3477 @none
       
  3478 @
       
  3479 text
       
  3480 @d78 6
       
  3481 @
       
  3482 
       
  3483 
       
  3484 1.15
       
  3485 log
       
  3486 @none
       
  3487 @
       
  3488 text
       
  3489 @d91 1
       
  3490 @
       
  3491 
       
  3492 
       
  3493 1.14
       
  3494 log
       
  3495 @none
       
  3496 @
       
  3497 text
       
  3498 @d15 3
       
  3499 @
       
  3500 
       
  3501 
       
  3502 1.13
       
  3503 log
       
  3504 @none
       
  3505 @
       
  3506 text
       
  3507 @d37 1
       
  3508 a37 1
       
  3509   <td> Your Wiki username, if defined in %MAINWEB%.TWikiUsers. Same as %<nop>USERNAME% if not defined. Is <b>%WIKIUSERNAME%</b> </td>
       
  3510 d96 1
       
  3511 a96 1
       
  3512 [1] __Note__: A web can be excluded from a =web="all"= search if you define a =NOSEARCHALL=on= variable in its WebPreferences.
       
  3513 @
       
  3514 
       
  3515 
       
  3516 1.12
       
  3517 log
       
  3518 @none
       
  3519 @
       
  3520 text
       
  3521 @d1 1
       
  3522 a1 1
       
  3523 TWiki expands the following variables enclosed in % percent signs:
       
  3524 d7 1
       
  3525 a7 1
       
  3526   <td> The base script URL of TWiki, link of Home icon in upper left corner, is <b>%WIKIHOMEURL%</b> </td>
       
  3527 d10 1
       
  3528 a10 1
       
  3529   <td> The script URL of TWiki, is <b>%SCRIPTURL%</b></td>
       
  3530 d13 1
       
  3531 a13 1
       
  3532   <td> The path of the script URL of TWiki, is <b>%SCRIPTURLPATH%</b></td>
       
  3533 d19 1
       
  3534 a19 1
       
  3535   <td> The path of the public URL of TWiki, is <b>%PUBURLPATH%</b> </td>
       
  3536 d73 1
       
  3537 a73 1
       
  3538   <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: =<b>%<nop>INCLUDE{"TWiki.TWikiWebsTable"}%</b>= </td>
       
  3539 d78 1
       
  3540 a78 1
       
  3541 | =web="Name"= <br> =web="Main Know"= <br> =web="all"= | Wiki web to search: A web, a list of webs separated by whitespace, or all webs =[1]= | Current web |
       
  3542 d89 1
       
  3543 a89 1
       
  3544 Example: =<b>%<nop>SEARCH{"wiki" web="Main" scope="topic"}%</b>= </td>
       
  3545 d92 1
       
  3546 a92 1
       
  3547   <td> Get a preference value from another web then the current one. Example: To get =%<nop>WEBBGCOLOR%= of the Main web write =%<nop>VAR{"WEBBGCOLOR" web="Main"}%=, is =<b>%VAR{"WEBBGCOLOR" web="Main"}%</b>= </td>
       
  3548 d158 20
       
  3549 d187 1
       
  3550 a187 1
       
  3551 -- Main.PeterThoeny - 01 Nov 2000 <br>
       
  3552 @
       
  3553 
       
  3554 
       
  3555 1.11
       
  3556 log
       
  3557 @none
       
  3558 @
       
  3559 text
       
  3560 @d90 4
       
  3561 d160 8
       
  3562 a167 1
       
  3563 -- Main.PeterThoeny - 18 Sep 2000 <br>
       
  3564 @
       
  3565 
       
  3566 
       
  3567 1.10
       
  3568 log
       
  3569 @none
       
  3570 @
       
  3571 text
       
  3572 @d123 8
       
  3573 d149 1
       
  3574 a149 1
       
  3575   <td> http-equiv meta tags for edit script. </tr><tr>
       
  3576 @
       
  3577 
       
  3578 
       
  3579 1.9
       
  3580 log
       
  3581 @none
       
  3582 @
       
  3583 text
       
  3584 @d45 3
       
  3585 d148 1
       
  3586 a148 1
       
  3587 -- Main.PeterThoeny - 17 Aug 2000 <br>
       
  3588 @
       
  3589 
       
  3590 
       
  3591 1.8
       
  3592 log
       
  3593 @none
       
  3594 @
       
  3595 text
       
  3596 @d69 2
       
  3597 a70 2
       
  3598   <td> =%<nop>INCLUDE{"file.ext"}%= </td>
       
  3599   <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: =<b>%<nop>INCLUDE{"../Know/TopicName.txt"}%</b>= </td>
       
  3600 d75 4
       
  3601 a78 2
       
  3602 | =web="Name"= | Specify Wiki web to search | Current web |
       
  3603 | =scope="topic"= | Search topic name (title) | Topic text (body) |
       
  3604 d80 1
       
  3605 d83 1
       
  3606 d89 2
       
  3607 d116 4
       
  3608 d131 12
       
  3609 d145 1
       
  3610 a145 1
       
  3611 -- Main.PeterThoeny - 29 May 2000 <br>
       
  3612 @
       
  3613 
       
  3614 
       
  3615 1.7
       
  3616 log
       
  3617 @none
       
  3618 @
       
  3619 text
       
  3620 @d37 1
       
  3621 a37 1
       
  3622   <td> Your Wiki username, if defined in TWikiUsers. Same as %<nop>USERNAME% if not defined. Is <b>%WIKIUSERNAME%</b> </td>
       
  3623 d45 5
       
  3624 a49 2
       
  3625   <td> =%<nop>DATE%= </td>
       
  3626   <td> Todays date (local server time), is <b>%DATE%</b> </td>
       
  3627 d51 5
       
  3628 a55 2
       
  3629   <td> =%<nop>GMTIME%= </td>
       
  3630   <td> Todays date (GM time), is <b>%GMTIME%</b> </td>
       
  3631 d85 1
       
  3632 a85 1
       
  3633 Additional variables are defined in the preferences ( site-level ( __SL__ ) in %MAINWEB%.%WIKIPREFSTOPIC%, web-level ( __WL__ ) in %WEBPREFSTOPIC% of each web, and user level ( __UL__ ) preferences in individual user topics):
       
  3634 @
       
  3635 
       
  3636 
       
  3637 1.6
       
  3638 log
       
  3639 @none
       
  3640 @
       
  3641 text
       
  3642 @d46 4
       
  3643 a49 1
       
  3644   <td> Todays date, is <b>%DATE%</b> </td>
       
  3645 d117 1
       
  3646 a117 1
       
  3647 -- Main.PeterThoeny - 21 Apr 2000 <br>
       
  3648 @
       
  3649 
       
  3650 
       
  3651 1.5
       
  3652 log
       
  3653 @none
       
  3654 @
       
  3655 text
       
  3656 @d7 1
       
  3657 a7 1
       
  3658   <td> The base script URL of TWiki, link of Home icon in upper left corner is <b>%WIKIHOMEURL%</b> </td>
       
  3659 d48 12
       
  3660 d113 2
       
  3661 @
       
  3662 
       
  3663 
       
  3664 1.4
       
  3665 log
       
  3666 @none
       
  3667 @
       
  3668 text
       
  3669 @d96 4
       
  3670 @
       
  3671 
       
  3672 
       
  3673 1.3
       
  3674 log
       
  3675 @none
       
  3676 @
       
  3677 text
       
  3678 @d10 4
       
  3679 a13 1
       
  3680   <td> The base script URL of TWiki, is <b>%SCRIPTURL%</b></td>
       
  3681 d16 4
       
  3682 a19 1
       
  3683   <td> The base public URL of TWiki, is <b>%PUBURL%</b> </td>
       
  3684 d23 3
       
  3685 @
       
  3686 
       
  3687 
       
  3688 1.2
       
  3689 log
       
  3690 @none
       
  3691 @
       
  3692 text
       
  3693 @a17 3
       
  3694   <td> =%<nop>WIKIWEBMASTER%= </td>
       
  3695   <td> The email address of the Wiki webmaster, is <b>%WIKIWEBMASTER%</b> </td>
       
  3696 </tr><tr>
       
  3697 d53 34
       
  3698 @
       
  3699 
       
  3700 
       
  3701 1.1
       
  3702 log
       
  3703 @none
       
  3704 @
       
  3705 text
       
  3706 @d42 14
       
  3707 a55 2
       
  3708   <td> =%<nop>INCLUDE:"file.ext"%= </td>
       
  3709   <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: =<b>%<nop>INCLUDE:"../Know/TopicName.txt"%</b>= </td>
       
  3710 @