<div>
<ul>
<li><a href="#TWiki Variables"> TWiki Variables</a><ul>
- <li><a href="#Overview"> Overview</a></li>
<li><a href="#Predefined Variables"> Predefined Variables</a></li>
<li><a href="#Preferences Variables"> Preferences Variables</a></li>
<li><a href="#Setting Preferences"> Setting Preferences</a></li>
# <a name="TWiki Variables"></a> TWiki Variables
-_Text strings expanded on the fly to display data or system info_
-
-## <a name="Overview"></a> Overview
+_Special text strings expand on the fly to display user data or system info_
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.
</tr>
<tr>
<td><code>%GMTIME%</code></td>
- <td> GM time, is <b>29 Jun 2010 - 15:32</b></td>
+ <td> GM time, is <b>29 Jun 2010 - 15:34</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:32:44</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:34:42</b></td>
</tr>
<tr>
<td><code>%SERVERTIME%</code></td>
- <td> Server time, is <b>29 Jun 2010 - 11:32</b></td>
+ <td> Server time, is <b>29 Jun 2010 - 11:34</b></td>
</tr>
<tr>
<td><code>%SERVERTIME{"format"}%</code></td>
- <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:32</b></td>
+ <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:34</b></td>
</tr>
<tr>
<td><code>%HTTP_HOST%</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> Show number </td>
</tr>
<tr>
- <td><code><b>format="..."</b></code></td>
- <td> Flexible custom result formatting: see <strong>[[Main/FormattedSearch]]</strong> for usage </td>
+ <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> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
+ </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>
</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 searcing for topics that have a specific parent i.e. its children </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>
</tr>
<tr>
<td><code>title="Title"</code></td>
- <td> Text the is pre-pended to any search results </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>
> - 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>
--- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 05 Jan 2002
+-- [[PeterThoeny]] - 13 Sep 2001 <br /> -- [[MikeMannix]] - 07 Mar 2002
git://git.openafs.org / openafs-wiki.git / blobdiff