107294392b7e5bc30630d26b75b18919e57f9320
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
1 TWiki 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 TWiki, link of Home icon in upper left corner, is <b>%WIKIHOMEURL%</b></td>
11   </tr>
12   <tr>
13     <td><code>%SCRIPTURL%</code></td>
14     <td> The script URL of TWiki, 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 TWiki, is <b>http://www.dementia.org/twiki/</b></td>
19   </tr>
20   <tr>
21     <td><code>%PUBURL%</code></td>
22     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
23   </tr>
24   <tr>
25     <td><code>%PUBURLPATH%</code></td>
26     <td> The path of the public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
27   </tr>
28   <tr>
29     <td><code>%ATTACHURL%</code></td>
30     <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>
31   </tr>
32   <tr>
33     <td><code>%ATTACHURLPATH%</code></td>
34     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
35   </tr>
36   <tr>
37     <td><code>%WIKITOOLNAME%</code></td>
38     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
39   </tr>
40   <tr>
41     <td><code>%WIKIVERSION%</code></td>
42     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
43   </tr>
44   <tr>
45     <td><code>%USERNAME%</code></td>
46     <td> Your login username, is <b>admin</b></td>
47   </tr>
48   <tr>
49     <td><code>%WIKIUSERNAME%</code></td>
50     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
51   </tr>
52   <tr>
53     <td><code>%WEB%</code></td>
54     <td> The current web, is <b>%WEB%</b></td>
55   </tr>
56   <tr>
57     <td><code>%TOPIC%</code></td>
58     <td> The current topic name, is <b>%TOPIC%</b></td>
59   </tr>
60   <tr>
61     <td><code>%GMTIME%</code></td>
62     <td> GM time, is <b>29 Jun 2010 - 15:24</b></td>
63   </tr>
64   <tr>
65     <td><code>%GMTIME{"format"}%</code></td>
66     <td> Formatted GM time based on keywords (first three characters needed.) <br /> Example: <code>%GMTIME{"day month, year - hour:min:sec"}%</code> is <b>day month, year - hour:min:sec</b></td>
67   </tr>
68   <tr>
69     <td><code>%SERVERTIME%</code></td>
70     <td> Server time, is <b>29 Jun 2010 - 11:24</b></td>
71   </tr>
72   <tr>
73     <td><code>%SERVERTIME{"format"}%</code></td>
74     <td> Formatted server time. Example: <code>%SERVERTIME{"hou:min"}%</code> is <b>hou:min</b></td>
75   </tr>
76   <tr>
77     <td><code>%HTTP_HOST%</code></td>
78     <td> HTTP_HOST environment variable, is <b></b></td>
79   </tr>
80   <tr>
81     <td><code>%REMOTE_ADDR%</code></td>
82     <td> REMOTE_ADDR environment variable, is <b></b></td>
83   </tr>
84   <tr>
85     <td><code>%REMOTE_PORT%</code></td>
86     <td> REMOTE_PORT environment variable, is <b></b></td>
87   </tr>
88   <tr>
89     <td><code>%REMOTE_USER%</code></td>
90     <td> REMOTE_USER environment variable, is <b></b></td>
91   </tr>
92   <tr>
93     <td><code>%INCLUDE{"file.ext"}%</code></td>
94     <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%INCLUDE{"../Know/TopicName.txt"}%</b></code></td>
95   </tr>
96   <tr>
97     <td><code>%SEARCH{"str" ...}%</code></td>
98     <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">
99         <tr>
100           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
101           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
102           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
103         </tr>
104         <tr>
105           <td><code>web="Name"</code></td>
106           <td> Specify Wiki web to search </td>
107           <td> Current web </td>
108         </tr>
109         <tr>
110           <td><code>scope="topic"</code></td>
111           <td> Search topic name (title) </td>
112           <td> Topic text (body) </td>
113         </tr>
114         <tr>
115           <td><code>regex="on"</code></td>
116           <td>[[Main/RegularExpression]] search </td>
117           <td> Literal search </td>
118         </tr>
119         <tr>
120           <td><code>casesensitive="on"</code></td>
121           <td> Case sensitive search </td>
122           <td> Ignore case </td>
123         </tr>
124         <tr>
125           <td><code>nosummary="on"</code></td>
126           <td> Show topic title only </td>
127           <td> Show topic summary </td>
128         </tr>
129         <tr>
130           <td><code>nosearch="on"</code></td>
131           <td> Suppress search string </td>
132           <td> Show search string </td>
133         </tr>
134         <tr>
135           <td><code>nototal="on"</code></td>
136           <td> Do not show number of topics found </td>
137           <td> Show number </td>
138         </tr>
139       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
140   </tr>
141 </table>
142
143 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):
144
145 <table border="1">
146   <tr>
147     <th> Variable: </th>
148     <th> Level: </th>
149     <th> What: </th>
150   </tr>
151   <tr>
152     <td><code>%WIKIWEBMASTER%</code></td>
153     <td><strong><em>SL</em></strong></td>
154     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
155   </tr>
156   <tr>
157     <td><code>%WIKIWEBLIST%</code></td>
158     <td><strong><em>SL</em></strong></td>
159     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
160   </tr>
161   <tr>
162     <td><code>%WEBTOPICLIST%</code></td>
163     <td><strong><em>WL</em></strong></td>
164     <td> Common links of web (second line of topics) </td>
165   </tr>
166   <tr>
167     <td><code>%WEBCOPYRIGHT%</code></td>
168     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
169     <td> Copyright notice (bottom right corner of topics) </td>
170   </tr>
171   <tr>
172     <td><code>%WEBBGCOLOR%</code></td>
173     <td><strong><em>WL</em></strong></td>
174     <td> Background color of web </td>
175   </tr>
176   <tr>
177     <td><code>%EDITBOXWIDTH%</code></td>
178     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
179     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
180   </tr>
181   <tr>
182     <td><code>%EDITBOXHEIGHT%</code></td>
183     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
184     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
185   </tr>
186   <tr>
187     <td><code>%ATTACHLINKBOX%</code></td>
188     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
189     <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>
190   </tr>
191 </table>
192
193 -- [[PeterThoeny]] - 29 May 2000 <br />