git://git.openafs.org / openafs-wiki.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw
none
[openafs-wiki.git] / TWiki / TWikiVariables.mdwn
diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn
index fe7a3a8..d33048b 100644 (file)
--- a/TWiki/TWikiVariables.mdwn
+++ b/TWiki/TWikiVariables.mdwn
@@ -1,4 +1,4 @@
-TWiki expands the following variables enclosed in % percent signs:
+%WIKITOOLNAME% expands the following variables enclosed in % percent signs:
 
 <table border="1">
   <tr>
@@ -7,15 +7,19 @@ 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 %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
   </tr>
   <tr>
     <td><code>%SCRIPTURL%</code></td>
-    <td> The script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
+    <td> The script URL of %WIKITOOLNAME%, 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>
+    <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
+  </tr>
+  <tr>
+    <td><code>%SCRIPTSUFFIX%</code></td>
+    <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
   </tr>
   <tr>
     <td><code>%PUBURL%</code></td>
@@ -23,7 +27,7 @@ TWiki expands the following variables enclosed in % percent signs:
   </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>
+    <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
   </tr>
   <tr>
     <td><code>%ATTACHURL%</code></td>
@@ -63,7 +67,7 @@ TWiki expands the following variables enclosed in % percent signs:
   </tr>
   <tr>
     <td><code>%GMTIME%</code></td>
-    <td> GM time, is <b>29 Jun 2010 - 15:24</b></td>
+    <td> GM time, is <b>29 Jun 2010 - 15:25</b></td>
   </tr>
   <tr>
     <td><code>%GMTIME{"format"}%</code></td>
@@ -71,7 +75,7 @@ TWiki expands the following variables enclosed in % percent signs:
   </tr>
   <tr>
     <td><code>%SERVERTIME%</code></td>
-    <td> Server time, is <b>29 Jun 2010 - 11:24</b></td>
+    <td> Server time, is <b>29 Jun 2010 - 11:25</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME{"format"}%</code></td>
@@ -98,6 +102,14 @@ TWiki expands the following variables enclosed in % percent signs:
     <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
   </tr>
   <tr>
+    <td><code>%STARTINCLUDE%</code></td>
+    <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>
+  </tr>
+  <tr>
+    <td><code>%STOPINCLUDE%</code></td>
+    <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>
+  </tr>
+  <tr>
     <td><code>%SEARCH{"str" ...}%</code></td>
     <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">
         <tr>
@@ -156,12 +168,25 @@ TWiki expands the following variables enclosed in % percent signs:
           <td> Show search string </td>
         </tr>
         <tr>
+          <td><code>noheader="on"</code></td>
+          <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
+          <td> Show search header </td>
+        </tr>
+        <tr>
           <td><code>nototal="on"</code></td>
           <td> Do not show number of topics found </td>
           <td> Show number </td>
         </tr>
       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
   </tr>
+  <tr>
+    <td><code>%VAR{"NAME" web="Web"}%</code></td>
+    <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>
+    <td>
+      <p>
+      </p>
+    </td>
+  </tr>
 </table>
 
 [1] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
@@ -205,6 +230,16 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
   </tr>
   <tr>
+    <td><code>%NEWTOPICBGCOLOR%</code></td>
+    <td><strong><em>SL</em></strong> , <em>UL</em></td>
+    <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
+  </tr>
+  <tr>
+    <td><code>%NEWTOPICFONTCOLOR%</code></td>
+    <td><strong><em>SL</em></strong> , <em>UL</em></td>
+    <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </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>
@@ -230,12 +265,42 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
     <td> http-equiv meta tags for edit script. </td>
   </tr>
   <tr>
-  </tr>
-  <tr>
     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
     <td> http-equiv meta tags for preview script. </td>
   </tr>
+  <tr>
+    <td><code>%DENYWEBCHANGE%</code></td>
+    <td><strong><em>WL</em></strong></td>
+    <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
+  </tr>
+  <tr>
+    <td><code>%ALLOWWEBCHANGE%</code></td>
+    <td><strong><em>WL</em></strong></td>
+    <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
+  </tr>
+  <tr>
+    <td><code>%DENYTOPICCHANGE%</code></td>
+    <td><strong><em>(any topic)</em></strong></td>
+    <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
+  </tr>
+  <tr>
+    <td><code>%ALLOWTOPICCHANGE%</code></td>
+    <td><strong><em>(any topic)</em></strong></td>
+    <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
+  </tr>
+  <tr>
+    <td><code>%FINALPREFERENCES%</code></td>
+    <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
+    <td> List of preferences that are not allowed to be overridden by next level preferences</td>
+  </tr>
 </table>
 
--- [[PeterThoeny]] - 18 Sep 2000 <br />
+**_Notes:_**
+
+- Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
+  - `Set VARIABLENAME = value`
+- Additional preferences variables can be defined on all three level as needed. Example:
+  - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
+
+-- [[PeterThoeny]] - 19 Jan 2001 <br />
OpenAFS Wiki Source