Difference: TWikiVariables (38 vs. 39)

Revision 3907 Sep 2001 - MikeMannix

Line: 1 to 1
 
Changed:
<
<

TWiki Variables

>
>

TWiki Variables

Text strings expanded on the fly include predefined, preference-driven and custom-defined data

Overview

  TWikiVariables are text strings enclosed in percentage signs: %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!
Changed:
<
<

Predefined Variables

>
>

Predefined Variables

  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.
Line: 214 to 218
 [2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Changed:
<
<

Preferences Variables

>
>

Preferences Variables

  Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):
Line: 324 to 328
 
List of preferences that are not allowed to be overridden by next level preferences
Changed:
<
<

Setting Preferences

>
>

Setting Preferences

 
  • The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
    [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
    Example:
    • Set VARIABLENAME = value
Changed:
<
<

Creating Custom Variables

>
>

Creating Custom Variables

 
  • 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.
View topic | History: r84 < r83 < r82 < r81 | More topic actions...
 
This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables