none
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
index 1c75e5a..1072943 100644 (file)
@@ -7,23 +7,31 @@ TWiki expands the following variables enclosed in % percent signs:
   </tr>
   <tr>
     <td><code>%WIKIHOMEURL%</code></td>
-    <td> The base script URL of TWiki, link of Home icon in upper left corner is <b>%WIKIHOMEURL%</b></td>
+    <td> The base script URL of TWiki, link of Home icon in upper left corner, is <b>%WIKIHOMEURL%</b></td>
   </tr>
   <tr>
     <td><code>%SCRIPTURL%</code></td>
-    <td> The base script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
+    <td> The script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
+  </tr>
+  <tr>
+    <td><code>%SCRIPTURLPATH%</code></td>
+    <td> The path of the script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
   </tr>
   <tr>
     <td><code>%PUBURL%</code></td>
-    <td> The base public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
+    <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
+  </tr>
+  <tr>
+    <td><code>%PUBURLPATH%</code></td>
+    <td> The path of the public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
   </tr>
   <tr>
     <td><code>%ATTACHURL%</code></td>
     <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>
   </tr>
   <tr>
-    <td><code>%WIKIWEBMASTER%</code></td>
-    <td> The email address of the Wiki webmaster, is <b></b></td>
+    <td><code>%ATTACHURLPATH%</code></td>
+    <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
   </tr>
   <tr>
     <td><code>%WIKITOOLNAME%</code></td>
@@ -50,8 +58,36 @@ TWiki expands the following variables enclosed in % percent signs:
     <td> The current topic name, is <b>%TOPIC%</b></td>
   </tr>
   <tr>
-    <td><code>%DATE%</code></td>
-    <td> Todays date, is <b>29 Jun 2010</b></td>
+    <td><code>%GMTIME%</code></td>
+    <td> GM time, is <b>29 Jun 2010 - 15:24</b></td>
+  </tr>
+  <tr>
+    <td><code>%GMTIME{"format"}%</code></td>
+    <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>
+  </tr>
+  <tr>
+    <td><code>%SERVERTIME%</code></td>
+    <td> Server time, is <b>29 Jun 2010 - 11:24</b></td>
+  </tr>
+  <tr>
+    <td><code>%SERVERTIME{"format"}%</code></td>
+    <td> Formatted server time. Example: <code>%SERVERTIME{"hou:min"}%</code> is <b>hou:min</b></td>
+  </tr>
+  <tr>
+    <td><code>%HTTP_HOST%</code></td>
+    <td> HTTP_HOST environment variable, is <b></b></td>
+  </tr>
+  <tr>
+    <td><code>%REMOTE_ADDR%</code></td>
+    <td> REMOTE_ADDR environment variable, is <b></b></td>
+  </tr>
+  <tr>
+    <td><code>%REMOTE_PORT%</code></td>
+    <td> REMOTE_PORT environment variable, is <b></b></td>
+  </tr>
+  <tr>
+    <td><code>%REMOTE_USER%</code></td>
+    <td> REMOTE_USER environment variable, is <b></b></td>
   </tr>
   <tr>
     <td><code>%INCLUDE{"file.ext"}%</code></td>
@@ -103,3 +139,55 @@ TWiki expands the following variables enclosed in % percent signs:
       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
   </tr>
 </table>
+
+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):
+
+<table border="1">
+  <tr>
+    <th> Variable: </th>
+    <th> Level: </th>
+    <th> What: </th>
+  </tr>
+  <tr>
+    <td><code>%WIKIWEBMASTER%</code></td>
+    <td><strong><em>SL</em></strong></td>
+    <td> Webmaster email address (sender of email notifications) , is <b></b></td>
+  </tr>
+  <tr>
+    <td><code>%WIKIWEBLIST%</code></td>
+    <td><strong><em>SL</em></strong></td>
+    <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
+  </tr>
+  <tr>
+    <td><code>%WEBTOPICLIST%</code></td>
+    <td><strong><em>WL</em></strong></td>
+    <td> Common links of web (second line of topics) </td>
+  </tr>
+  <tr>
+    <td><code>%WEBCOPYRIGHT%</code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
+    <td> Copyright notice (bottom right corner of topics) </td>
+  </tr>
+  <tr>
+    <td><code>%WEBBGCOLOR%</code></td>
+    <td><strong><em>WL</em></strong></td>
+    <td> Background color of web </td>
+  </tr>
+  <tr>
+    <td><code>%EDITBOXWIDTH%</code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
+  </tr>
+  <tr>
+    <td><code>%EDITBOXHEIGHT%</code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
+  </tr>
+  <tr>
+    <td><code>%ATTACHLINKBOX%</code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+    <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>
+  </tr>
+</table>
+
+-- [[PeterThoeny]] - 29 May 2000 <br />