none
authorMikeMannix <MikeMannix>
Sat, 1 Sep 2001 03:52:16 +0000 (03:52 +0000)
committerMikeMannix <MikeMannix>
Sat, 1 Sep 2001 03:52:16 +0000 (03:52 +0000)
TWiki/TWikiPlugins.mdwn
TWiki/TWikiVariables.mdwn
TWiki/WebChangesAlert.mdwn

index 72b0a3c..13d1f94 100644 (file)
@@ -2,20 +2,20 @@
   <ul>
     <li><a href="#TWiki Plugins"> TWiki Plugins</a><ul>
         <li><a href="#Installing Plugins"> Installing Plugins</a></li>
-        <li><a href="#Pre-Installed Plugins"> Pre-Installed Plugins</a></li>
-        <li><a href="#Managing Installed Plugins"> Managing Installed Plugins</a><ul>
-            <li><a href="#Set Preferences for Individual P"> Set Preferences for Individual Plugins</a></li>
-            <li><a href="#List Active Plugins Automaticall"> List Active Plugins Automatically </a></li>
+        <li><a href="#Preinstalled Plugins"> Preinstalled Plugins</a></li>
+        <li><a href="#Managing Plugins"> Managing Plugins</a><ul>
+            <li><a href="#Setting Preferences"> Setting Preferences</a></li>
+            <li><a href="#Listing Active Plugins"> Listing Active Plugins</a></li>
           </ul>
         </li>
-        <li><a href="#Creating New Plugins"> Creating New Plugins</a><ul>
+        <li><a href="#Creating Plugins"> Creating Plugins</a><ul>
             <li><a href="#Anatomy of a Plugin"> Anatomy of a Plugin</a></li>
             <li><a href="#TWiki Plugin API"> TWiki Plugin API</a></li>
-            <li><a href="#Customize the _DefaultPlugin"> Customize the DefaultPlugin</a></li>
-            <li><a href="#Create a Plugin Module in Perl"> Create a Plugin Module in Perl</a></li>
-            <li><a href="#Create a Plugin Documentation To"> Create a Plugin Documentation Topic</a></li>
-            <li><a href="#Package a Plugin for Distributio"> Package a Plugin for Distribution</a></li>
-            <li><a href="#Publish a Plugin for General Use"> Publish a Plugin for General Use</a></li>
+            <li><a href="#The _DefaultPlugin Alternative"> The DefaultPlugin Alternative</a></li>
+            <li><a href="#Creating the Perl Module"> Creating the Perl Module </a></li>
+            <li><a href="#Writing the Documentation Topic"> Writing the Documentation Topic</a></li>
+            <li><a href="#Packaging for Distribution"> Packaging for Distribution</a></li>
+            <li><a href="#Publishing for Public Use"> Publishing for Public Use</a></li>
           </ul>
         </li>
       </ul>
@@ -53,7 +53,7 @@ TWikiPlugin documentation pages are located at TWiki.org, in TWiki:Plugins web.
 - **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in <code>**Dev**</code> (ex: <code>**SomePluginDev**</code>).
 - **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web.
 
-### <a name="Pre-Installed Plugins"></a> Pre-Installed Plugins
+### <a name="Preinstalled Plugins"></a> Preinstalled Plugins
 
 TWiki comes with three Plugins as part of the standard installation.
 
@@ -63,11 +63,11 @@ TWiki comes with three Plugins as part of the standard installation.
 
 - **InterwikiPlugin** is included but can be disabled or removed. Use it for quick linking to frequently linked to remote sites. Ex: <code>**TWiki:Plugins**</code> expands to TWiki:Plugins - on TWiki.org. You can add your own shortcuts and URLs to the existing directory of Wiki-related sites.
 
-### <a name="Managing Installed Plugins"></a> Managing Installed Plugins
+### <a name="Managing Plugins"></a> Managing Plugins
 
 Ideally, after you've [[installed a Plugin|Main/WebHome#InstallPlugin]], just read the instructions and you're set. In fact, some Plugins require additional settings or offer extra options that you can modify on Preferences pages. You may want to make a Plugin available only in certain webs, or temporarily disable it. And having to list all available Plugins will probably come up. You can handle all of these with simple procedures.
 
-#### <a name="Set Preferences for Individual P"></a> Set Preferences for Individual Plugins
+#### <a name="Setting Preferences"></a> Setting Preferences
 
 Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences:
 
@@ -86,7 +86,7 @@ Installed Plugins can be **toggled on or off**, site-wide or by web, through TWi
 
 - The settings can be retrieved as Preferences variables like <code>**%&lt;pluginname&gt;\_&lt;var&gt;%**</code>, ex: <code>**%DEFAULTPLUGIN\_SHORTDESCRIPTION%**</code> shows the description of the DefaultPlugin.
 
-#### <a name="List Active Plugins Automaticall"></a> List Active Plugins Automatically
+#### <a name="Listing Active Plugins"></a> Listing Active Plugins
 
 Plugin status variables let you list all active Plugins wherever needed. There are two list formats:
 
@@ -117,7 +117,7 @@ Plugin status variables let you list all active Plugins wherever needed. There a
 
 <a name="CreatePlugins"></a>
 
-### <a name="Creating New Plugins"></a> Creating New Plugins
+### <a name="Creating Plugins"></a> Creating Plugins
 
 With a reasonable knowledge of the Perl scripting language, you can create new Plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The [[TWiki Plugin API|Main/WebHome#PluginAPI]] Plugins by providing a programming interface for TWiki.
 
@@ -148,17 +148,17 @@ In addition to TWiki core functions, Plugins can use **predefined hooks**, or **
 
 - For improve performance, enable only the functions you really need. NOTE: <code>**outsidePREHandler**</code> and <code>**insidePREHandler**</code> are particularly expensive.
 
-#### <a name="Customize the _DefaultPlugin"></a> Customize the DefaultPlugin
+#### <a name="The _DefaultPlugin Alternative"></a> The DefaultPlugin Alternative
 
 - **DefaultPlugin** can handle some outdated TWiki variables, found, for example, in sites recently updated from an old version. Settings are in [[TWikiPreferences]]. You can also add your own simple custom processing rules here, though in all but very simple cases, writing a new Plugin is preferable.
 
-#### <a name="Create a Plugin Module in Perl"></a> Create a Plugin Module in Perl
+#### <a name="Creating the Perl Module"></a> Creating the Perl Module
 
 Copy file ([`EmptyPlugin.pm`](http://twiki.org/lib/TWiki/Plugins/EmptyPlugin.pm) to <code>**&lt;name&gt;Plugin.pm**</code> <code>**EmptyPlugin.pm**</code> contains no executable code, so it does nothing, but it's ready to be used. Customize it. Refer to the [[Plugin API|Main/WebHome#PluginAPI]] specs for more information.
 
 <a name="CreatePluginTopic"></a>
 
-#### <a name="Create a Plugin Documentation To"></a> Create a Plugin Documentation Topic
+#### <a name="Writing the Documentation Topic"></a> Writing the Documentation Topic
 
 The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as [[FileAttachments]] for downloading. (The doc topic is also included _in_ the [[distribution package|Main/WebHome#CreatePluginPackage]].) To create a documentation topic:
 
@@ -196,7 +196,7 @@ The Plugin documentation topic contains usage instructions and version details.
 
 <a name="CreatePluginPackage"></a>
 
-#### <a name="Package a Plugin for Distributio"></a> Package a Plugin for Distribution
+#### <a name="Packaging for Distribution"></a> Packaging for Distribution
 
 A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends in <code>**Plugin**</code>, ex: <code>**YourPlugin.pm**</code>, and a documentation page with the same name(<code>**YourPlugin.txt**</code>).
 
@@ -211,7 +211,7 @@ A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends
 
 <a name="PublishPlugin"></a>
 
-#### <a name="Publish a Plugin for General Use"></a> Publish a Plugin for General Use
+#### <a name="Publishing for Public Use"></a> Publishing for Public Use
 
 You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web, where all Plugins submitted to TWiki.org are available for download and further development discussion. Publish your Plugin in three steps:
 
index 5a6e4a5..2234bf2 100644 (file)
@@ -3,7 +3,7 @@
     <li><a href="#TWiki Variables"> TWiki Variables</a><ul>
         <li><a href="#Predefined Variables"> Predefined Variables</a></li>
         <li><a href="#Preferences Variables"> Preferences Variables</a></li>
-        <li><a href="#Setting Variable Preferences"> Setting Variable Preferences</a></li>
+        <li><a href="#Setting Preferences"> Setting Preferences</a></li>
         <li><a href="#Creating Custom Variables"> Creating Custom Variables</a></li>
       </ul>
     </li>
 
 ## <a name="TWiki Variables"></a> TWiki Variables
 
-TWikiVariables are text strings enclosed in percentage signs: <code>**%VARIABLE%**</code> that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
+TWikiVariables are text strings enclosed in percentage signs: <code>**%VARIABLE%**</code> that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!
 
 ### <a name="Predefined Variables"></a> Predefined Variables
 
-%WIKITOOLNAME% expands the following variables enclosed in % percent signs:
+With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
 
-<table border="1">
-  <tr>
-    <th> Variable: </th>
-    <th> Expanded to: </th>
-  </tr>
-  <tr>
-    <td><code>%WIKIHOMEURL%</code></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 %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 %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
-  </tr>
-  <tr>
-    <td><code>%SCRIPTSUFFIX%</code></td>
-    <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code> is <b></b></td>
-  </tr>
-  <tr>
-    <td><code>%PUBURL%</code></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 %WIKITOOLNAME%, 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>%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>%URLPARAM{"name"}%</code></td>
-    <td> Returns the value of a URL parameter. Ex: <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. 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>%WIKINAME%</code></td>
-    <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
-  </tr>
-  <tr>
-    <td><code>%WIKIUSERNAME%</code></td>
-    <td> Your %WIKINAME% including the Main web name. Usefull for signatures. Is <b>Main.admin</b></td>
-  </tr>
-  <tr>
-    <td><code>%MAINWEB%</code></td>
-    <td> The Main web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]]. Is <b>Main</b></td>
-  </tr>
-  <tr>
-    <td><code>%TWIKIWEB%</code></td>
-    <td> The web containing all documentation and configuration of %WIKITOOLNAME% is <b>TWiki</b></td>
-  </tr>
-  <tr>
-    <td><code>%WEB%</code></td>
-    <td> The current web is <b>%WEB%</b></td>
-  </tr>
-  <tr>
-    <td><code>%BASEWEB%</code></td>
-    <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>
-  </tr>
-  <tr>
-    <td><code>%INCLUDINGWEB%</code></td>
-    <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
-  </tr>
-  <tr>
-    <td><code>%HOMETOPIC%</code></td>
-    <td> The home topic in each web. Is <b>[[Main/WebHome]]</b></td>
-  </tr>
-  <tr>
-    <td><code>%NOTIFYTOPIC%</code></td>
-    <td> The notify topic in each web. Is <b>[[Main/WebNotify]]</b></td>
-  </tr>
-  <tr>
-    <td><code>%WIKIUSERSTOPIC%</code></td>
-    <td> The index topic of all registered users. Is <b>TWikiUsers</b></td>
-  </tr>
-  <tr>
-    <td><code>%WEBPREFSTOPIC%</code></td>
-    <td> The web preferences topic. Is <b>WebPreferences</b></td>
-  </tr>
-  <tr>
-    <td><code>%STATISTICSTOPIC%</code></td>
-    <td> The web statistics topic. Is <b>WebStatistics</b></td>
-  </tr>
-  <tr>
-    <td><code>%TOPIC%</code></td>
-    <td> The current topic name, is <b>%TOPIC%</b></td>
-  </tr>
-  <tr>
-    <td><code>%BASETOPIC%</code></td>
-    <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>
-  </tr>
-  <tr>
-    <td><code>%INCLUDINGTOPIC%</code></td>
-    <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
-  </tr>
-  <tr>
-    <td><code>%SPACEDTOPIC%</code></td>
-    <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
-  </tr>
-  <tr>
-    <td><code>%TOPICLIST{"format"}%</code></td>
-    <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The <code>$name</code> variable gets expanded to the topic name; the <code>$web</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
-        </tr>
-        <tr>
-          <td><code>"format"</code></td>
-          <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
-          <td><code>"$name"</code></td>
-        </tr>
-        <tr>
-          <td><code>format="format"</code></td>
-          <td> (Alternative to above) </td>
-          <td><code>"$name"</code></td>
-        </tr>
-        <tr>
-          <td><code>separator=", "</code></td>
-          <td> line separator </td>
-          <td><code>"\n"</code> (new line) </td>
-        </tr>
-        <tr>
-          <td><code>web="Name"</code></td>
-          <td> Name of web </td>
-          <td> Current web </td>
-        </tr>
-      </table> Examples: <br /><code>%TOPICLIST{"   * $web.$name"}%</code> creates a bullet list of all topics. <br /><code>%TOPICLIST{separator=", "}%</code> creates a comma separated list of all topics. <br /><code>%TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%</code> creates an option list (for drop down menus). </td>
-  </tr>
-  <tr>
-    <td><code>%WEBLIST{"format"}%</code></td>
-    <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable gets expanded to the name of the web, <code>$qname</code> gets expanded to double quoted name, <code>$marker</code> to <code>marker</code> where web matches <code>selection</code>. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
-        </tr>
-        <tr>
-          <td><code>"format"</code></td>
-          <td> Format of one line, may include <code>$name</code> variable </td>
-          <td><code>"$name"</code></td>
-        </tr>
-        <tr>
-          <td><code>format="format"</code></td>
-          <td> (Alternative to above) </td>
-          <td><code>"$name"</code></td>
-        </tr>
-        <tr>
-          <td><code>separator=", "</code></td>
-          <td> line separator </td>
-          <td><code>"\n"</code> (new line) </td>
-        </tr>
-        <tr>
-          <td><code>webs="public"</code></td>
-          <td> comma sep list of Web, public expands to all non-hidden </td>
-          <td><code>"public"</code></td>
-        </tr>
-        <tr>
-          <td><code>marker="selected"</code></td>
-          <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
-          <td><code>"selected"</code></td>
-        </tr>
-        <tr>
-          <td><code>selection</code></td>
-          <td> Current value e.g. current for current Web, =section="%WEB%" </td>
-        </tr>
-      </table> Examples: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. <br /><code>%WEBLIST{"<select><option $marker="$marker" value="$qname">$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%</select></code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
-  </tr>
-  <tr>
-    <td><code>%GMTIME%</code></td>
-    <td> GM time, is <b>29 Jun 2010 - 15:28</b></td>
-  </tr>
-  <tr>
-    <td><code>%GMTIME{"format"}%</code></td>
-    <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Example </strong></th>
-        </tr>
-        <tr>
-          <td> $seconds </td>
-          <td> seconds </td>
-          <td> 59 </td>
-        </tr>
-        <tr>
-          <td> $minutes </td>
-          <td> minutes </td>
-          <td> 59 </td>
-        </tr>
-        <tr>
-          <td> $hours </td>
-          <td> hours </td>
-          <td> 23 </td>
-        </tr>
-        <tr>
-          <td> $day </td>
-          <td> day of month </td>
-          <td> 31 </td>
-        </tr>
-        <tr>
-          <td> $month </td>
-          <td> month in ISO format </td>
-          <td> Dec </td>
-        </tr>
-        <tr>
-          <td> $mo </td>
-          <td> 2 digit month </td>
-          <td> 12 </td>
-        </tr>
-        <tr>
-          <td> $year </td>
-          <td> 4 digit year </td>
-          <td> 1999 </td>
-        </tr>
-        <tr>
-          <td> $ye </td>
-          <td> 2 digit year </td>
-          <td> 99 </td>
-        </tr>
-      </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:28:11</b></td>
-  </tr>
-  <tr>
-    <td><code>%SERVERTIME%</code></td>
-    <td> Server time, is <b>29 Jun 2010 - 11:28</b></td>
-  </tr>
-  <tr>
-    <td><code>%SERVERTIME{"format"}%</code></td>
-    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:28</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{"page" ...}%</code></td>
-    <td> Server side include to [[Main/IncludeTopicsAndWebPages]]. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <td><code>"SomeTopic"</code></td>
-          <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
-        </tr>
-        <tr>
-          <td><code>"Web.Topic"</code></td>
-          <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
-        </tr>
-        <tr>
-          <td><code>"http://..."</code></td>
-          <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
-        </tr>
-      </table>
-    </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>%TOC%</code></td>
-    <td> Table of Contents of current topic. </td>
-  </tr>
-  <tr>
-    <td><code>%TOC{"SomeTopic" ...}%</code></td>
-    <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] (<code>"---++ text"</code>) and HTML (<code>"&lt;h2&gt;text&lt;h2&gt;"</code>) are taken into account. (But not <code>"&lt;H2&gt;text&lt;/H2&gt;"</code>, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth: <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
-        </tr>
-        <tr>
-          <td><code>"TopicName"</code></td>
-          <td> topic name </td>
-          <td> Current topic </td>
-        </tr>
-        <tr>
-          <td><code>web="Name"</code></td>
-          <td> Name of web </td>
-          <td> Current web </td>
-        </tr>
-        <tr>
-          <td><code>depth="2"</code></td>
-          <td> Limit depth of headings shown in TOC </td>
-          <td> 6 </td>
-        </tr>
-      </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
-  </tr>
-  <tr>
-    <td><code>%SEARCH{"text" ...}%</code></td>
-    <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] <table border="1" cellpadding="0" cellspacing="0">
-        <tr>
-          <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
-          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
-        </tr>
-        <tr>
-          <td><code>"text"</code></td>
-          <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
-          <td> required </td>
-        </tr>
-        <tr>
-          <td><code>search="text"</code></td>
-          <td> (Alternative to above) </td>
-          <td> N/A </td>
-        </tr>
-        <tr>
-          <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
-          <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
-          <td> Current web </td>
-        </tr>
-        <tr>
-          <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
-          <td> Search topic name (title) or in the text (body) of the topic </td>
-          <td> Topic text (body) </td>
-        </tr>
-        <tr>
-          <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
-          <td> Sort the results of search by the topic names, last modified time, or last editor </td>
-          <td> Sort by topic name </td>
-        </tr>
-        <tr>
-          <td><code>limit="all"</code><br /><code>limit="16"</code></td>
-          <td> Limit the number of results returned </td>
-          <td> All results </td>
-        </tr>
-        <tr>
-          <td><code>regex="on"</code></td>
-          <td>[[Main/RegularExpression]] search </td>
-          <td> Literal search </td>
-        </tr>
-        <tr>
-          <td><code>reverse="on"</code></td>
-          <td> Reverse the direction of the search </td>
-          <td> Ascending 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>bookview="on"</code></td>
-          <td>[[Main/BookView]] search, e.g. show complete topic text </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>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 a web other 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>
+%WIKITOOLNAME% expands the following variables enclosed in % percent signs:
 
-[1] **_Note_**: The search form uses identical names for input fields.
+<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #fafafa" width="90%"><font size="13px"><font face="sans-serif"><tr>
+        <th width="160"> Variable: </th>
+        <th> Expanded to: </th>
+      </tr>
+      <tr>
+        <td><code>%WIKIHOMEURL%</code></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 %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 %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
+      </tr>
+      <tr>
+        <td><code>%SCRIPTSUFFIX%</code></td>
+        <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code> is <b></b></td>
+      </tr>
+      <tr>
+        <td><code>%PUBURL%</code></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 %WIKITOOLNAME%, 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>%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>%URLPARAM{"name"}%</code></td>
+        <td> Returns the value of a URL parameter. Ex: <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. 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>%WIKINAME%</code></td>
+        <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
+      </tr>
+      <tr>
+        <td><code>%WIKIUSERNAME%</code></td>
+        <td> Your %WIKINAME% including the Main web name. Usefull for signatures. Is <b>Main.admin</b></td>
+      </tr>
+      <tr>
+        <td><code>%MAINWEB%</code></td>
+        <td> The Main web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]]. Is <b>Main</b></td>
+      </tr>
+      <tr>
+        <td><code>%TWIKIWEB%</code></td>
+        <td> The web containing all documentation and configuration of %WIKITOOLNAME% is <b>TWiki</b></td>
+      </tr>
+      <tr>
+        <td><code>%WEB%</code></td>
+        <td> The current web is <b>%WEB%</b></td>
+      </tr>
+      <tr>
+        <td><code>%BASEWEB%</code></td>
+        <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>
+      </tr>
+      <tr>
+        <td><code>%INCLUDINGWEB%</code></td>
+        <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
+      </tr>
+      <tr>
+        <td><code>%HOMETOPIC%</code></td>
+        <td> The home topic in each web. Is <b>[[Main/WebHome]]</b></td>
+      </tr>
+      <tr>
+        <td><code>%NOTIFYTOPIC%</code></td>
+        <td> The notify topic in each web. Is <b>[[Main/WebNotify]]</b></td>
+      </tr>
+      <tr>
+        <td><code>%WIKIUSERSTOPIC%</code></td>
+        <td> The index topic of all registered users. Is <b>TWikiUsers</b></td>
+      </tr>
+      <tr>
+        <td><code>%WEBPREFSTOPIC%</code></td>
+        <td> The web preferences topic. Is <b>WebPreferences</b></td>
+      </tr>
+      <tr>
+        <td><code>%STATISTICSTOPIC%</code></td>
+        <td> The web statistics topic. Is <b>WebStatistics</b></td>
+      </tr>
+      <tr>
+        <td><code>%TOPIC%</code></td>
+        <td> The current topic name, is <b>%TOPIC%</b></td>
+      </tr>
+      <tr>
+        <td><code>%BASETOPIC%</code></td>
+        <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>
+      </tr>
+      <tr>
+        <td><code>%INCLUDINGTOPIC%</code></td>
+        <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
+      </tr>
+      <tr>
+        <td><code>%SPACEDTOPIC%</code></td>
+        <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
+      </tr>
+      <tr>
+        <td><code>%TOPICLIST{"format"}%</code></td>
+        <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The <code>$name</code> variable gets expanded to the topic name; the <code>$web</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+            </tr>
+            <tr>
+              <td><code>"format"</code></td>
+              <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
+              <td><code>"$name"</code></td>
+            </tr>
+            <tr>
+              <td><code>format="format"</code></td>
+              <td> (Alternative to above) </td>
+              <td><code>"$name"</code></td>
+            </tr>
+            <tr>
+              <td><code>separator=", "</code></td>
+              <td> line separator </td>
+              <td><code>"\n"</code> (new line) </td>
+            </tr>
+            <tr>
+              <td><code>web="Name"</code></td>
+              <td> Name of web </td>
+              <td> Current web </td>
+            </tr>
+          </table> Examples: <br /><code>%TOPICLIST{"   * $web.$name"}%</code> creates a bullet list of all topics. <br /><code>%TOPICLIST{separator=", "}%</code> creates a comma separated list of all topics. <br /><code>%TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%</code> creates an option list (for drop down menus). </td>
+      </tr>
+      <tr>
+        <td><code>%WEBLIST{"format"}%</code></td>
+        <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable gets expanded to the name of the web, <code>$qname</code> gets expanded to double quoted name, <code>$marker</code> to <code>marker</code> where web matches <code>selection</code>. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+            </tr>
+            <tr>
+              <td><code>"format"</code></td>
+              <td> Format of one line, may include <code>$name</code> variable </td>
+              <td><code>"$name"</code></td>
+            </tr>
+            <tr>
+              <td><code>format="format"</code></td>
+              <td> (Alternative to above) </td>
+              <td><code>"$name"</code></td>
+            </tr>
+            <tr>
+              <td><code>separator=", "</code></td>
+              <td> line separator </td>
+              <td><code>"\n"</code> (new line) </td>
+            </tr>
+            <tr>
+              <td><code>webs="public"</code></td>
+              <td> comma sep list of Web, public expands to all non-hidden </td>
+              <td><code>"public"</code></td>
+            </tr>
+            <tr>
+              <td><code>marker="selected"</code></td>
+              <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
+              <td><code>"selected"</code></td>
+            </tr>
+            <tr>
+              <td><code>selection</code></td>
+              <td> Current value e.g. current for current Web, =section="%WEB%" </td>
+            </tr>
+          </table> Examples: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. <br /><code>%WEBLIST{"<select><option $marker="$marker" value="$qname">$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%</select></code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
+      </tr>
+      <tr>
+        <td><code>%GMTIME%</code></td>
+        <td> GM time, is <b>29 Jun 2010 - 15:28</b></td>
+      </tr>
+      <tr>
+        <td><code>%GMTIME{"format"}%</code></td>
+        <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Example </strong></th>
+            </tr>
+            <tr>
+              <td> $seconds </td>
+              <td> seconds </td>
+              <td> 59 </td>
+            </tr>
+            <tr>
+              <td> $minutes </td>
+              <td> minutes </td>
+              <td> 59 </td>
+            </tr>
+            <tr>
+              <td> $hours </td>
+              <td> hours </td>
+              <td> 23 </td>
+            </tr>
+            <tr>
+              <td> $day </td>
+              <td> day of month </td>
+              <td> 31 </td>
+            </tr>
+            <tr>
+              <td> $month </td>
+              <td> month in ISO format </td>
+              <td> Dec </td>
+            </tr>
+            <tr>
+              <td> $mo </td>
+              <td> 2 digit month </td>
+              <td> 12 </td>
+            </tr>
+            <tr>
+              <td> $year </td>
+              <td> 4 digit year </td>
+              <td> 1999 </td>
+            </tr>
+            <tr>
+              <td> $ye </td>
+              <td> 2 digit year </td>
+              <td> 99 </td>
+            </tr>
+          </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:28:27</b></td>
+      </tr>
+      <tr>
+        <td><code>%SERVERTIME%</code></td>
+        <td> Server time, is <b>29 Jun 2010 - 11:28</b></td>
+      </tr>
+      <tr>
+        <td><code>%SERVERTIME{"format"}%</code></td>
+        <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:28</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{"page" ...}%</code></td>
+        <td> Server side include to [[Main/IncludeTopicsAndWebPages]]. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <td><code>"SomeTopic"</code></td>
+              <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
+            </tr>
+            <tr>
+              <td><code>"Web.Topic"</code></td>
+              <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
+            </tr>
+            <tr>
+              <td><code>"http://..."</code></td>
+              <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
+            </tr>
+          </table>
+        </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>%TOC%</code></td>
+        <td> Table of Contents of current topic. </td>
+      </tr>
+      <tr>
+        <td><code>%TOC{"SomeTopic" ...}%</code></td>
+        <td> Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] (<code>"---++ text"</code>) and HTML (<code>"&lt;h2&gt;text&lt;h2&gt;"</code>) are taken into account. (But not <code>"&lt;H2&gt;text&lt;/H2&gt;"</code>, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth: <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+            </tr>
+            <tr>
+              <td><code>"TopicName"</code></td>
+              <td> topic name </td>
+              <td> Current topic </td>
+            </tr>
+            <tr>
+              <td><code>web="Name"</code></td>
+              <td> Name of web </td>
+              <td> Current web </td>
+            </tr>
+            <tr>
+              <td><code>depth="2"</code></td>
+              <td> Limit depth of headings shown in TOC </td>
+              <td> 6 </td>
+            </tr>
+          </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
+      </tr>
+      <tr>
+        <td><code>%SEARCH{"text" ...}%</code></td>
+        <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] <table border="1" cellpadding="0" cellspacing="0">
+            <tr>
+              <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+              <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+            </tr>
+            <tr>
+              <td><code>"text"</code></td>
+              <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
+              <td> required </td>
+            </tr>
+            <tr>
+              <td><code>search="text"</code></td>
+              <td> (Alternative to above) </td>
+              <td> N/A </td>
+            </tr>
+            <tr>
+              <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
+              <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
+              <td> Current web </td>
+            </tr>
+            <tr>
+              <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
+              <td> Search topic name (title) or in the text (body) of the topic </td>
+              <td> Topic text (body) </td>
+            </tr>
+            <tr>
+              <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
+              <td> Sort the results of search by the topic names, last modified time, or last editor </td>
+              <td> Sort by topic name </td>
+            </tr>
+            <tr>
+              <td><code>limit="all"</code><br /><code>limit="16"</code></td>
+              <td> Limit the number of results returned </td>
+              <td> All results </td>
+            </tr>
+            <tr>
+              <td><code>regex="on"</code></td>
+              <td>[[Main/RegularExpression]] search </td>
+              <td> Literal search </td>
+            </tr>
+            <tr>
+              <td><code>reverse="on"</code></td>
+              <td> Reverse the direction of the search </td>
+              <td> Ascending 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>bookview="on"</code></td>
+              <td>[[Main/BookView]] search, e.g. show complete topic text </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>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 a web other 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>
+      </tr></font></font></table>
 
-[2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
+> [1]
+>
+> **_Note_**
+>
+> : The search form uses identical names for input fields.
+>
+> [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
 
 ### <a name="Preferences Variables"></a> Preferences Variables
 
 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>%NOSEARCHALL%</code></td>
-    <td><strong><em>WL</em></strong></td>
-    <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>
-  </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>%RELEASEEDITLOCKCHECKBOX%</code></td>
-    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
-    <td> Default state of the "Release edit lock" ([[Main/UnlockTopic]]) check box in preview. Checkbox is initially checked if <code>Set RELEASEEDITLOCKCHECKBOX = checked="checked"</code>, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do <strong>not</strong> go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: <b><code>%RELEASEEDITLOCKCHECKBOX%</code></b></td>
-  </tr>
-  <tr>
-    <td><code>%DONTNOTIFYCHECKBOX%</code></td>
-    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
-    <td> Default state of the "Minor Changes, Don't Notify" ([[Main/DontNotify]]) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</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>
-  <tr>
-    <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
-    <td><strong><em>SL</em></strong></td>
-    <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
-  </tr>
-  <tr>
-    <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
-    <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
-    <td> http-equiv meta tags for edit script. </td>
-  </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>%DENYWEBRENAME%</code></td>
-    <td><strong><em>WL</em></strong></td>
-    <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
-  </tr>
-  <tr>
-    <td><code>%ALLOWWEBRENAME%</code></td>
-    <td><strong><em>WL</em></strong></td>
-    <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
-  </tr>
-  <tr>
-    <td><code>%DENYTOPICRENAME%</code></td>
-    <td><strong><em>(any topic)</em></strong></td>
-    <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
-  </tr>
-  <tr>
-    <td><code>%ALLOWTOPICRENAME%</code></td>
-    <td><strong><em>(any topic)</em></strong></td>
-    <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
-  </tr>
-  <tr>
-    <td>
-      <p>
-      </p>
-    </td>
-    <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>
+<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #fafafa" width="90%"><font size="13px"><font face="sans-serif"><tr>
+        <th width="160"> 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>%NOSEARCHALL%</code></td>
+        <td><strong><em>WL</em></strong></td>
+        <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>
+      </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>%RELEASEEDITLOCKCHECKBOX%</code></td>
+        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+        <td> Default state of the "Release edit lock" ([[Main/UnlockTopic]]) check box in preview. Checkbox is initially checked if <code>Set RELEASEEDITLOCKCHECKBOX = checked="checked"</code>, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do <strong>not</strong> go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: <b><code>%RELEASEEDITLOCKCHECKBOX%</code></b></td>
+      </tr>
+      <tr>
+        <td><code>%DONTNOTIFYCHECKBOX%</code></td>
+        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+        <td> Default state of the "Minor Changes, Don't Notify" ([[Main/DontNotify]]) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</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>
+      <tr>
+        <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
+        <td><strong><em>SL</em></strong></td>
+        <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
+      </tr>
+      <tr>
+        <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
+        <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
+        <td> http-equiv meta tags for edit script. </td>
+      </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>%DENYWEBRENAME%</code></td>
+        <td><strong><em>WL</em></strong></td>
+        <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
+      </tr>
+      <tr>
+        <td><code>%ALLOWWEBRENAME%</code></td>
+        <td><strong><em>WL</em></strong></td>
+        <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
+      </tr>
+      <tr>
+        <td><code>%DENYTOPICRENAME%</code></td>
+        <td><strong><em>(any topic)</em></strong></td>
+        <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
+      </tr>
+      <tr>
+        <td><code>%ALLOWTOPICRENAME%</code></td>
+        <td><strong><em>(any topic)</em></strong></td>
+        <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
+      </tr>
+      <tr>
+        <td>
+          <p>
+          </p>
+        </td>
+        <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></font></font></table>
 
-### <a name="Setting Variable Preferences"></a> Setting Variable Preferences
+### <a name="Setting Preferences"></a> Setting Preferences
 
 - The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line: <br />[6 spaces] \* [space] Set [space] VARIABLENAME [space] = [value] <br />**_Example:_**
   - <code>**Set VARIABLENAME = value**</code>
 
 ### <a name="Creating Custom Variables"></a> Creating Custom Variables
 
-- You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.<br />**_Example:_** To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, define the variable in the web's [[WebPreferences]] topic, like this (in this case, you also have to upload <code>**logo.gif**</code> to the same directory):
-  - <code>**Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif**</code>
+- You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
+
+> <span><font>**HOW-TO: Create a custom logo variable**</font></span>
+>
+> <br />
+>
+> To place a logo anywhere in a web by typing
+>
+> <code>**%MYLOGO%**</code>
+>
+> , simply define the variable on the web's
+>
+> [[WebPreferences]]
+>
+> page. In this case, you also have to upload
+>
+> <code>**logo.gif**</code>
+>
+> to the same directory.:
+>
+> - - <code>**Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif**</code>
 
 -- [[MikeMannix]] - 30 Aug 2001 <br />
index 1b5f2dc..40acf87 100644 (file)
@@ -1,16 +1,16 @@
-## <a name="TWiki Notification of Changes"></a> TWiki Notification of Changes
+## <a name="Monitoring Site Changes"></a> Monitoring Site Changes
 
 Each %WIKITOOLNAME% web does an automatic email notification of recent changes. Users can subscribe / unsubscribe themselves in [[WebNotify]] of each TWiki web. The Perl script <code>**mailnotify**</code> is called by a deamon in regular intervals. The script is sending an automated email to subscribed users in case some topics changed in a web within this interval.
 
-### <a name="Configuring outgoing mail"></a> Configuring outgoing mail
+### <a name="Configuring Outgoing Mail"></a> Configuring Outgoing Mail
 
 %WIKITOOLNAME% will use the <code>**Net::SMTP**</code> module in case it is installed on your system. You need to specify the <code>**SMTPMAILHOST**</code> variable in [[TWikiPreferences]].
 
 You can use an external mail program like <code>**sendmail**</code> in case the <code>**Net::SMTP**</code> module is not installed. In this case specify the <code>**$mailProgram**</code> in <code>**twiki/bin/TWiki.cfg**</code>.
 
-### <a name="Call &lt;code&gt;&lt;b&gt;mailnotify&lt;/b&gt;&lt;/code&gt; in regular i"></a> Call <code>**mailnotify**</code> in regular intervals
+### <a name="Call &lt;code&gt;&lt;b&gt;mailnotify&lt;/b&gt;&lt;/code&gt; at Regular I"></a> Call <code>**mailnotify**</code> at Regular Intervals
 
-For Unix platforms: Edit the cron table so that <code>**mailnotify**</code> is called in an interval of your choice. Please consult <code>**man crontab**</code> of how to modify the table that schedules program execution at certain intervals. Example:
+**For Unix platforms:** Edit the cron table so that <code>**mailnotify**</code> is called in an interval of your choice. Please consult <code>**man crontab**</code> of how to modify the table that schedules program execution at certain intervals. Example:
 
     % crontab -e
     15,45 * * * * (cd ~twiki/public_html/bin; ./mailnotify -q)