none

[openafs-wiki.git] / TWiki / TWikiVariables.mdwn

diff --git a/TWiki/TWikiVariables.mdwn b/TWiki/TWikiVariables.mdwn
index e69de29..1c75e5a 100644 (file)
--- a/TWiki/TWikiVariables.mdwn
+++ b/TWiki/TWikiVariables.mdwn
@@ -0,0 +1,105 @@
+TWiki expands the following variables enclosed in % percent signs:
+
+<table border="1">
+  <tr>
+    <th> Variable: </th>
+    <th> Expanded to: </th>
+  </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>
+  </tr>
+  <tr>
+    <td><code>%SCRIPTURL%</code></td>
+    <td> The base 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>
+  </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>
+  </tr>
+  <tr>
+    <td><code>%WIKITOOLNAME%</code></td>
+    <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
+  </tr>
+  <tr>
+    <td><code>%WIKIVERSION%</code></td>
+    <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
+  </tr>
+  <tr>
+    <td><code>%USERNAME%</code></td>
+    <td> Your login username, is <b>admin</b></td>
+  </tr>
+  <tr>
+    <td><code>%WIKIUSERNAME%</code></td>
+    <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
+  </tr>
+  <tr>
+    <td><code>%WEB%</code></td>
+    <td> The current web, is <b>%WEB%</b></td>
+  </tr>
+  <tr>
+    <td><code>%TOPIC%</code></td>
+    <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>
+  </tr>
+  <tr>
+    <td><code>%INCLUDE{"file.ext"}%</code></td>
+    <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>
+  </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>
+          <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+        </tr>
+        <tr>
+          <td><code>web="Name"</code></td>
+          <td> Specify Wiki web to search </td>
+          <td> Current web </td>
+        </tr>
+        <tr>
+          <td><code>scope="topic"</code></td>
+          <td> Search topic name (title) </td>
+          <td> Topic text (body) </td>
+        </tr>
+        <tr>
+          <td><code>regex="on"</code></td>
+          <td>[[Main/RegularExpression]] search </td>
+          <td> Literal search </td>
+        </tr>
+        <tr>
+          <td><code>casesensitive="on"</code></td>
+          <td> Case sensitive search </td>
+          <td> Ignore case </td>
+        </tr>
+        <tr>
+          <td><code>nosummary="on"</code></td>
+          <td> Show topic title only </td>
+          <td> Show topic summary </td>
+        </tr>
+        <tr>
+          <td><code>nosearch="on"</code></td>
+          <td> Suppress search string </td>
+          <td> Show search string </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>
+</table>