<div>
<ul>
<li><a href="#TWiki Variables"> TWiki Variables</a><ul>
- <li><a href="#About Variables"> About Variables</a></li>
<li><a href="#Predefined Variables"> Predefined Variables</a></li>
<li><a href="#Preferences Variables"> Preferences Variables</a></li>
- <li><a href="#Setting and Creating New Prefere"> Setting and Creating New 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>
</ul>
</div>
-## <a name="TWiki Variables"></a> TWiki Variables
+# <a name="TWiki Variables"></a> TWiki Variables
-### <a name="About Variables"></a> About Variables
+_Special text strings expand on the fly to display user data or system info_
-**_Include/write if not found elsewhere._**
+TWikiVariables are text strings - `%VARIABLE%` - that expand into content whenever a page is opened. When a topic is rendered for viewing, `VARIABLES` are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.
-### <a name="Predefined Variables"></a> Predefined Variables
+## <a name="Predefined Variables"></a> Predefined Variables
-%WIKITOOLNAME% expands the following variables enclosed in % percent signs:
+Most predefined variables return values that were either set in the <code>**lib/twiki.cfg**</code> file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.
-<table border="1">
+- %T% **Take the time to thoroughly read through ALL preference variables.** If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see <code>**%INCLUDINGTOPIC%**</code>, <code>**%INCLUDE%**</code>, and the mighty <code>**%SEARCH%**</code>.
+
+This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the following variables (enclosed in <code>**%**</code> percent signs):
+
+<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #f5f5f5" width="90%">
<tr>
- <th> Variable: </th>
+ <th width="160"> Variable: </th>
<th> Expanded to: </th>
</tr>
<tr>
</tr>
<tr>
<td><code>%SCRIPTSUFFIX%</code></td>
- <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
+ <td> The script suffix, ex: <code>.pl</code>, <code>.cgi</code> is <b></b></td>
</tr>
<tr>
<td><code>%PUBURL%</code></td>
</tr>
<tr>
<td><code>%URLPARAM{"name"}%</code></td>
- <td> Returns the value of a URL parameter. I.e. <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b></b></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>
+ <td> The name of your TWiki site - <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>
+ <td> Your current TWiki version - <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>
+ <td> Your login username - <b>admin</b></td>
</tr>
<tr>
<td><code>%WIKINAME%</code></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>
+ <td> Your %WIKINAME% including the Main web name - always use full signatures - <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>
+ <td> The 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>
+ <td> The web containing all documentation and site-wide preference settings for %WIKITOOLNAME% - <b>TWiki</b></td>
</tr>
<tr>
<td><code>%WEB%</code></td>
- <td> The current web, is <b>%WEB%</b></td>
+ <td> The current web is <b>%WEB%</b></td>
</tr>
<tr>
<td><code>%BASEWEB%</code></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>
+ <td> The web name of the topic that includes the current topic - same as <code>%WEB%</code> if 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>
+ <td> The home topic in each web - <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>
+ <td> The notify topic in each web - <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>
+ <td> The index topic of all registered users - <b>TWikiUsers</b></td>
+ </tr>
+ <tr>
+ <td><code>%WIKIPREFSTOPIC%</code></td>
+ <td> The site-wide preferences topic - <b>TWikiPreferences</b></td>
</tr>
<tr>
<td><code>%WEBPREFSTOPIC%</code></td>
- <td> The web preferences topic. Is <b>WebPreferences</b></td>
+ <td> The local web preferences topic in each web - <b>WebPreferences</b></td>
</tr>
<tr>
<td><code>%STATISTICSTOPIC%</code></td>
- <td> The web statistics topic. Is <b>WebStatistics</b></td>
+ <td> The web statistics topic <b>WebStatistics</b></td>
</tr>
<tr>
<td><code>%TOPIC%</code></td>
- <td> The current topic name, is <b>%TOPIC%</b></td>
+ <td> The current topic name - <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>
+ <td> The name of the topic where a single or nested INCLUDE started - same as <code>%TOPIC%</code> if there is no INCLUDE. </td>
</tr>
<tr>
<td><code>%INCLUDINGTOPIC%</code></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">
+ <td> Web index, ex: 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>
<td><code>"selected"</code></td>
</tr>
<tr>
- <td><code>selection</code></td>
- <td> Current value e.g. current for current Web, =section="%WEB%" </td>
+ <td><code>selection="%WEB%"</code></td>
+ <td> Current value to be selected in list </td>
+ <td><code>section="%WEB%"</code></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:27</b></td>
+ <td> GM time, is <b>29 Jun 2010 - 15:35</b></td>
</tr>
<tr>
<td><code>%GMTIME{"format"}%</code></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:27:35</b></td>
+ </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:35:09</b></td>
</tr>
<tr>
<td><code>%SERVERTIME%</code></td>
- <td> Server time, is <b>29 Jun 2010 - 11:27</b></td>
+ <td> Server time, is <b>29 Jun 2010 - 11:35</b></td>
</tr>
<tr>
<td><code>%SERVERTIME{"format"}%</code></td>
- <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:27</b></td>
+ <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:35</b></td>
</tr>
<tr>
<td><code>%HTTP_HOST%</code></td>
</tr>
<tr>
<td><code>"Web.Topic"</code></td>
- <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
+ <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.SiteMap"}%</code></td>
</tr>
<tr>
<td><code>"http://..."</code></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>"<h2>text<h2>"</code>) are taken into account. (But not <code>"<H2>text</H2>"</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">
+ <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>"<h2>text</h2>"</code>) are taken into account. (But not <code>"<H2>text</H2>"</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>
<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><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code><br /><code>order=<br /> "formfield(name)"</code></td>
+ <td> Sort the results of search by the topic names, last modified time, last editor, or named field of [[Main/TWikiForms]]</td>
<td> Sort by topic name </td>
</tr>
<tr>
<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>
+ <td><code><b>header="..."</b></code><br /><code><b>format="..."</b></code></td>
+ <td> Custom format results: see <strong>[[Main/FormattedSearch]]</strong> for usage, variables & examples </td>
+ <td> Results in table </td>
+ </tr>
+ </table> Regular example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code><br /> Formatted example: <code><b>%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%</b></code> <em>(displays results in a table with header - [[Main/FormattedSearch]])</em></td>
+ </tr>
+ <tr>
+ <td><code>%METASEARCH{...}%</code></td>
+ <td> Special search of meta data <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>type="topicmoved"</code></td>
+ <td> What sort of search is required? <br /><code>"topicmoved"</code> if search for a topic that may have been moved <br /><code>"parent"</code> if searching for topics that have a specific parent i.e. its children </td>
+ <td> required </td>
+ </tr>
+ <tr>
+ <td><code>web="%WEB%"</code></td>
+ <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. </td>
+ <td> required </td>
+ </tr>
+ <tr>
+ <td><code>topic="%TOPIC%"</code></td>
+ <td> The topic the search relates to </td>
+ <td> required </td>
+ </tr>
+ <tr>
+ <td><code>title="Title"</code></td>
+ <td> Text the is prepended to any search results </td>
+ <td> required </td>
+ </tr>
+ </table> Example: <code><b>%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%</b></code>, you may want to use this in [[Main/WebTopicViewTemplate]] and [[Main/WebTopicNonWikiTemplate]]<br /><code><b>%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%</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>
-[1] **_Note_**: The search form uses identical names for input fields.
+> [1]
+>
+> **_Note_**
+>
+> : The search form uses identical names for input fields.
+>
+> [2] **_Note_**: A web can be excluded from a <code>**web="all"**</code> search if you define a <code>**NOSEARCHALL=on**</code> variable in its [[WebPreferences]].
-[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
+## <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">
+<table align="center" border="1" cellpadding="2" cellspacing="0" style="background-color: #f5f5f5" width="90%">
<tr>
- <th> Variable: </th>
+ <th width="160"> Variable: </th>
<th> Level: </th>
<th> What: </th>
</tr>
</tr>
</table>
-### <a name="Setting and Creating New Prefere"></a> Setting and Creating New Preferences
+## <a name="Setting Preferences"></a> Setting Preferences
+
+- The syntax for Preferences variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br />[3 spaces] \* [space] Set [space] VARIABLENAME [space] = [value]<br />**_Examples:_**
+- <code>**Set VARIABLENAME = =value=**</code>
+ - <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.
-- 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>
-- 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, images.<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>
+> **Example: Create a custom logo variable**
+>
+> <br />
+>
+> - To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, simply define the variable on the web's [[WebPreferences]] page. You also have to upload `logo.gif` - this can be done by [[attaching a file|Main/FileAttachment]] to `LogoTopic` (any topic name you choose):
+> - <code>**Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif**</code>
--- [[MikeMannix]] - 26 Aug 2001 <br />
+-- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 07 Mar 2002
git://git.openafs.org / openafs-wiki.git / blobdiff