buildrelease
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Variables"> TWiki Variables</a><ul>
4         <li><a href="#Using Variables"> Using Variables</a></li>
5         <li><a href="#Variable Names"> Variable Names</a></li>
6         <li><a href="#Preferences Variables"> Preferences Variables</a><ul>
7             <li><a href="#Setting Preferences Variables"> Setting Preferences Variables</a></li>
8             <li><a href="#Access Control Variables"> Access Control Variables</a></li>
9             <li><a href="#Local values for variables"> Local values for variables</a></li>
10             <li><a href="#Frequently Used Preferences Vari"> Frequently Used Preferences Variables</a></li>
11           </ul>
12         </li>
13         <li><a href="#Predefined Variables"> Predefined Variables</a></li>
14       </ul>
15     </li>
16     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
17   </ul>
18 </div>
19
20 # <a name="TWiki Variables"></a> TWiki Variables
21
22 _Special text strings expand on the fly to display user data or system info_
23
24 TWikiVariables are text strings - `%VARIABLE%` or `%VARIABLE{ parameter="value" }%` - that expand into content whenever a topic is rendered for viewing. There are two types of variables:
25
26 1. Preferences variables: Can be defined and changed by the user
27 2. Predefined variables: Defined by the TWiki system or by Plugins (for example, the [[SpreadSheetPlugin]] introduces a `%CALC{}%` variable)
28
29 ## <a name="Using Variables"></a> Using Variables
30
31 To use a variable type its name. For example,
32
33 - type `%T%` to get %T% (a preferences variable)
34 - type `%TOPIC%` to get `%TOPIC%` (a predefined variable)
35 - type `%CALC{ "$UPPER(Text)" }%` to get `TEXT` (a variable defined by Plugin)
36
37 **_Note:_**
38
39 - To leave a variable unexpanded, precede it with an exclamation point, e.g. type `!%TOPIC%` to get `%TOPIC%`
40 - Variables are expanded relative to the topic they are _used_ in, not the topic they are _defined_ in
41 - Type `%ALLVARIABLES%` to get a full listing of all variables defined for a particular topic
42
43 ## <a name="Variable Names"></a> Variable Names
44
45 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. `%MYVAR%`, `%MyVar%`, `%My2ndVar%`, and `%My_Var%` are all valid variable names. Variables are case sensitive. `%MyVAR%` and `%MYVAR%` are not the same variable.
46
47 By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.
48
49 <a name="SettingPrefs"></a> <a name="PreferencesVariables"></a>
50
51 ## <a name="Preferences Variables"></a> Preferences Variables
52
53 Unlike predefined variables, preferences variables can be defined by the user in various places.
54
55 ### <a name="Setting Preferences Variables"></a> Setting Preferences Variables
56
57 You can set variables in all the following places:
58
59 1. local site level in [[TWikiPreferences]]
60 2. user level in individual user topics in Main web
61 3. web level in [[WebPreferences]] of each web
62 4. topic level in topics in webs
63 5. plugin topics (see [[TWikiPlugins]])
64 6. session variables (if sessions are enabled)
65
66 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.
67
68 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`
69
70 > **Examples:**
71 >
72 > - <code>**Set VARIABLENAME = value**</code>
73 >   - <code>**Set VARIABLENAME = value**</code>
74
75 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.
76
77 > **Example:**
78 >
79 >        * Set VARIABLENAME = value starts here
80 >          and continues here
81
82 Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
83
84 > **Example: Create a custom logo variable**
85 >
86 > <br />
87 >
88 > - To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, define the Variable on the web's [[WebPreferences]] topic, and upload a logo file, ex: `mylogo.gif`. You can upload by [[attaching the file|Main/FileAttachment]] to [[WebPreferences]], or, to avoid clutter, to any other topic in the same web, e.g. `LogoTopic`. Sample variable setting in [[WebPreferences]]:
89 >   - <code>**Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif**</code>
90
91 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.
92
93 ### <a name="Access Control Variables"></a> Access Control Variables
94
95 These are special types of preferences variables to control access to content. [[TWikiAccessControl]] explains these security settings in detail.
96
97 ### <a name="Local values for variables"></a> Local values for variables
98
99 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:
100
101        * Set EDITBOXHEIGHT = 10
102        * Local EDITBOXHEIGHT = 20
103
104 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. `Local` can be used wherever a preference needs to take a different value depending on where the current operation is being performed.
105
106 Use this powerful feature with great care! `%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.
107
108 ### <a name="Frequently Used Preferences Vari"></a> Frequently Used Preferences Variables
109
110 The following preferences variables are frequently used. They are defined in [[TWikiPreferences#Miscellaneous_Settings]]:
111
112 - `%BR%` - line break
113 - `%BULLET%` - bullet sign
114 - `%BB%` - line break and bullet combined
115 - `%BB2%` - indented line break and bullet
116 - `%RED% text %ENDCOLOR%` - colored text (also `%YELLOW%`, `%ORANGE%`, `%PINK%`, `%PURPLE%`, `%TEAL%`, `%NAVY%`, `%BLUE%`, `%AQUA%`, `%LIME%`, `%GREEN%`, `%OLIVE%`, `%MAROON%`, `%BROWN%`, `%BLACK%`, `%GRAY%`, `%SILVER%`, `%WHITE%`)
117 - `%H%` - %H% Help icon
118 - `%I%` - %I% Idea icon
119 - `%M%` - %M% Moved to icon
120 - `%N%` - %N% New icon
121 - `%P%` - %P% Refactor icon
122 - `%Q%` - %Q% Question icon
123 - `%S%` - %S% Pick icon
124 - `%T%` - %T% Tip icon
125 - `%U%` - %U% Updated icon
126 - `%X%` - %X% Alert icon
127 - `%Y%` - %Y% Done icon
128
129 There are additional useful preferences variables defined in [[TWikiPreferences]], in [[Main.TWikiPreferences|Main/TWikiPreferences]], and in [[WebPreferences]] of every web.
130
131 <a name="PreDef"></a>
132
133 ## <a name="Predefined Variables"></a> Predefined Variables
134
135 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 `%SEARCH%`, are powerful and general tools.
136
137 - %X% Predefined variables can be overridden by [[preferences variables|Main/WebHome#PreferencesVariables]]
138 - %X% Plugins may extend the set of predefined variables (see individual Plugins topics for details)
139 - %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 `%INCLUDINGTOPIC%`, `%INCLUDE%`, and the mighty `%SEARCH%`.
140
141 This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - predefines the following variables:
142
143 # <a name="TWiki Installation Error"></a> TWiki Installation Error
144
145 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
146
147 **_Related Topics:_** [[UserDocumentationCategory]]