none
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
2
3 <table border="1">
4   <tr>
5     <th> Variable: </th>
6     <th> Expanded to: </th>
7   </tr>
8   <tr>
9     <td><code>%WIKIHOMEURL%</code></td>
10     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
11   </tr>
12   <tr>
13     <td><code>%SCRIPTURL%</code></td>
14     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
15   </tr>
16   <tr>
17     <td><code>%SCRIPTURLPATH%</code></td>
18     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
19   </tr>
20   <tr>
21     <td><code>%SCRIPTSUFFIX%</code></td>
22     <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
23   </tr>
24   <tr>
25     <td><code>%PUBURL%</code></td>
26     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
27   </tr>
28   <tr>
29     <td><code>%PUBURLPATH%</code></td>
30     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
31   </tr>
32   <tr>
33     <td><code>%ATTACHURL%</code></td>
34     <td> The attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b><br /> Example: If you attach a file you can refer to it as <code><b>%ATTACHURL%/image.gif</b></code></td>
35   </tr>
36   <tr>
37     <td><code>%ATTACHURLPATH%</code></td>
38     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
39   </tr>
40   <tr>
41     <td><code>%WIKITOOLNAME%</code></td>
42     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
43   </tr>
44   <tr>
45     <td><code>%WIKIVERSION%</code></td>
46     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
47   </tr>
48   <tr>
49     <td><code>%USERNAME%</code></td>
50     <td> Your login username, is <b>admin</b></td>
51   </tr>
52   <tr>
53     <td><code>%WIKIUSERNAME%</code></td>
54     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
55   </tr>
56   <tr>
57     <td><code>%WEB%</code></td>
58     <td> The current web, is <b>%WEB%</b></td>
59   </tr>
60   <tr>
61     <td><code>%BASEWEB%</code></td>
62     <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as <code>%WEB%</code> in case there is no include. </td>
63   </tr>
64   <tr>
65     <td><code>%INCLUDINGWEB%</code></td>
66     <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
67   </tr>
68   <tr>
69     <td><code>%TOPIC%</code></td>
70     <td> The current topic name, is <b>%TOPIC%</b></td>
71   </tr>
72   <tr>
73     <td><code>%BASETOPIC%</code></td>
74     <td> The name of the topic where the includes started, e.g. the first topic of nested includes. Same as <code>%TOPIC%</code> in case there is no include. </td>
75   </tr>
76   <tr>
77     <td><code>%INCLUDINGTOPIC%</code></td>
78     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
79   </tr>
80   <tr>
81     <td><code>%SPACEDTOPIC%</code></td>
82     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
83   </tr>
84   <tr>
85     <td><code>%GMTIME%</code></td>
86     <td> GM time, is <b>29 Jun 2010 - 15:25</b></td>
87   </tr>
88   <tr>
89     <td><code>%GMTIME{"format"}%</code></td>
90     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
91         <tr>
92           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
93           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
94           <th bgcolor="#99CCCC"><strong> Example </strong></th>
95         </tr>
96         <tr>
97           <td> $seconds </td>
98           <td> seconds </td>
99           <td> 59 </td>
100         </tr>
101         <tr>
102           <td> $minutes </td>
103           <td> minutes </td>
104           <td> 59 </td>
105         </tr>
106         <tr>
107           <td> $hours </td>
108           <td> hours </td>
109           <td> 23 </td>
110         </tr>
111         <tr>
112           <td> $day </td>
113           <td> day of month </td>
114           <td> 31 </td>
115         </tr>
116         <tr>
117           <td> $month </td>
118           <td> month in ISO format </td>
119           <td> Dec </td>
120         </tr>
121         <tr>
122           <td> $mo </td>
123           <td> 2 digit month </td>
124           <td> 12 </td>
125         </tr>
126         <tr>
127           <td> $year </td>
128           <td> 4 digit year </td>
129           <td> 1999 </td>
130         </tr>
131         <tr>
132           <td> $ye </td>
133           <td> 2 digit year </td>
134           <td> 99 </td>
135         </tr>
136       </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:25:46</b></td>
137   </tr>
138   <tr>
139     <td><code>%SERVERTIME%</code></td>
140     <td> Server time, is <b>29 Jun 2010 - 11:25</b></td>
141   </tr>
142   <tr>
143     <td><code>%SERVERTIME{"format"}%</code></td>
144     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:25</b></td>
145   </tr>
146   <tr>
147     <td><code>%HTTP_HOST%</code></td>
148     <td> HTTP_HOST environment variable, is <b></b></td>
149   </tr>
150   <tr>
151     <td><code>%REMOTE_ADDR%</code></td>
152     <td> REMOTE_ADDR environment variable, is <b></b></td>
153   </tr>
154   <tr>
155     <td><code>%REMOTE_PORT%</code></td>
156     <td> REMOTE_PORT environment variable, is <b></b></td>
157   </tr>
158   <tr>
159     <td><code>%REMOTE_USER%</code></td>
160     <td> REMOTE_USER environment variable, is <b></b></td>
161   </tr>
162   <tr>
163     <td><code>%INCLUDE{"SomeTopic"}%</code></td>
164     <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
165   </tr>
166   <tr>
167     <td><code>%STARTINCLUDE%</code></td>
168     <td> If present in included topic, start to include text from this location up to the end, or up to the location of the <code>%STOPINCLUDE%</code> variable. A normal view of the topic shows everyting exept the <code>%STARTINCLUDE%</code> variable itself. </td>
169   </tr>
170   <tr>
171     <td><code>%STOPINCLUDE%</code></td>
172     <td> If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the <code>%STOPINCLUDE%</code> variable itself. </td>
173   </tr>
174   <tr>
175     <td><code>%SEARCH{"str" ...}%</code></td>
176     <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
177         <tr>
178           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
179           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
180           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
181         </tr>
182         <tr>
183           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
184           <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[1]</code></td>
185           <td> Current web </td>
186         </tr>
187         <tr>
188           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
189           <td> Search topic name (title) or in the text (body) of the topic </td>
190           <td> Topic text (body) </td>
191         </tr>
192         <tr>
193           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
194           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
195           <td> Sort by topic name </td>
196         </tr>
197         <tr>
198           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
199           <td> Limit the number of results returned </td>
200           <td> All results </td>
201         </tr>
202         <tr>
203           <td><code>regex="on"</code></td>
204           <td>[[Main/RegularExpression]] search </td>
205           <td> Literal search </td>
206         </tr>
207         <tr>
208           <td><code>reverse="on"</code></td>
209           <td> Reverse the direction of the search </td>
210           <td> Ascending search </td>
211         </tr>
212         <tr>
213           <td><code>casesensitive="on"</code></td>
214           <td> Case sensitive search </td>
215           <td> Ignore case </td>
216         </tr>
217         <tr>
218           <td><code>nosummary="on"</code></td>
219           <td> Show topic title only </td>
220           <td> Show topic summary </td>
221         </tr>
222         <tr>
223           <td><code>bookview="on"</code></td>
224           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
225           <td> Show topic summary </td>
226         </tr>
227         <tr>
228           <td><code>nosearch="on"</code></td>
229           <td> Suppress search string </td>
230           <td> Show search string </td>
231         </tr>
232         <tr>
233           <td><code>noheader="on"</code></td>
234           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
235           <td> Show search header </td>
236         </tr>
237         <tr>
238           <td><code>nototal="on"</code></td>
239           <td> Do not show number of topics found </td>
240           <td> Show number </td>
241         </tr>
242       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
243   </tr>
244   <tr>
245     <td><code>%VAR{"NAME" web="Web"}%</code></td>
246     <td> Get a preference value from another web then the current one. Example: To get <code>%WEBBGCOLOR%</code> of the Main web write <code>%VAR{"WEBBGCOLOR" web="Main"}%</code>, is <code><b></b></code></td>
247     <td>
248       <p>
249       </p>
250     </td>
251   </tr>
252 </table>
253
254 [1] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
255
256 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):
257
258 <table border="1">
259   <tr>
260     <th> Variable: </th>
261     <th> Level: </th>
262     <th> What: </th>
263   </tr>
264   <tr>
265     <td><code>%WIKIWEBMASTER%</code></td>
266     <td><strong><em>SL</em></strong></td>
267     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
268   </tr>
269   <tr>
270     <td><code>%WIKIWEBLIST%</code></td>
271     <td><strong><em>SL</em></strong></td>
272     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
273   </tr>
274   <tr>
275     <td><code>%WEBTOPICLIST%</code></td>
276     <td><strong><em>WL</em></strong></td>
277     <td> Common links of web (second line of topics) </td>
278   </tr>
279   <tr>
280     <td><code>%WEBCOPYRIGHT%</code></td>
281     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
282     <td> Copyright notice (bottom right corner of topics) </td>
283   </tr>
284   <tr>
285     <td><code>%WEBBGCOLOR%</code></td>
286     <td><strong><em>WL</em></strong></td>
287     <td> Background color of web </td>
288   </tr>
289   <tr>
290     <td><code>%NOSEARCHALL%</code></td>
291     <td><strong><em>WL</em></strong></td>
292     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
293   </tr>
294   <tr>
295     <td><code>%NEWTOPICBGCOLOR%</code></td>
296     <td><strong><em>SL</em></strong> , <em>UL</em></td>
297     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
298   </tr>
299   <tr>
300     <td><code>%NEWTOPICFONTCOLOR%</code></td>
301     <td><strong><em>SL</em></strong> , <em>UL</em></td>
302     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
303   </tr>
304   <tr>
305     <td><code>%EDITBOXWIDTH%</code></td>
306     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
307     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
308   </tr>
309   <tr>
310     <td><code>%EDITBOXHEIGHT%</code></td>
311     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
312     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
313   </tr>
314   <tr>
315     <td><code>%ATTACHLINKBOX%</code></td>
316     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
317     <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to <code>CHECKED</code> , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: <b><code>%ATTACHLINKBOX%</code></b></td>
318   </tr>
319   <tr>
320     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
321     <td><strong><em>SL</em></strong></td>
322     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
323   </tr>
324   <tr>
325     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
326     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
327     <td> http-equiv meta tags for edit script. </td>
328   </tr>
329   <tr>
330     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
331     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
332     <td> http-equiv meta tags for preview script. </td>
333   </tr>
334   <tr>
335     <td><code>%DENYWEBCHANGE%</code></td>
336     <td><strong><em>WL</em></strong></td>
337     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
338   </tr>
339   <tr>
340     <td><code>%ALLOWWEBCHANGE%</code></td>
341     <td><strong><em>WL</em></strong></td>
342     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
343   </tr>
344   <tr>
345     <td><code>%DENYTOPICCHANGE%</code></td>
346     <td><strong><em>(any topic)</em></strong></td>
347     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
348   </tr>
349   <tr>
350     <td><code>%ALLOWTOPICCHANGE%</code></td>
351     <td><strong><em>(any topic)</em></strong></td>
352     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
353   </tr>
354   <tr>
355     <td><code>%FINALPREFERENCES%</code></td>
356     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
357     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
358   </tr>
359 </table>
360
361 **_Notes:_**
362
363 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
364   - `Set VARIABLENAME = value`
365 - Additional preferences variables can be defined on all three level as needed. Example:
366   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
367
368 -- [[PeterThoeny]] - 19 Jan 2001 <br />