TWiki Variables

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.

Note: To leave a variable unexpanded, preceed it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%.

Predefined Variables

Most predefined variables return values that were either set in the lib/twiki.cfg 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.

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 %INCLUDINGTOPIC%, %INCLUDE%, and the mighty %SEARCH%.

The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE.

%INCLUDINGTOPIC%

The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.

%SPACEDTOPIC%

The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables

%TOPICLIST{"format"}%

Topic index of a web. The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web.
Parameters are format, separator and web:

Web index, ex: list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Parameters are format, separator and web:

If present in included topic, start to include text from this location up to the end, or up to the location of the %STOPINCLUDE% variable. A normal view of the topic shows everyting exept the %STARTINCLUDE% variable itself.

%STOPINCLUDE%

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 %STOPINCLUDE% variable itself.

%TOC%

Table of Contents of current topic.

%TOC{"SomeTopic" ...}%

Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Supported parameters:

Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort

Sort by topic name

limit="all"limit="16"

Limit the number of results returned. This is done after sorting in case order is specified

What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children

required

web="%WEB%"

Wiki web to search: A web, a list of webs separated by whitespace, or all webs.

required

topic="%TOPIC%"

The topic the search relates to

required

title="Title"

Text that is prepended to any search results

required

Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%

%VAR{"NAME" web="Web"}%

Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFEFA6

[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.

Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not 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:

%DONTNOTIFYCHECKBOX%

SL , UL

Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:

%ATTACHLINKBOX%

SL , UL

Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:

%HTTP_EQUIV_ON_VIEW%

SL

http-equiv meta tags for view, rdiff, attach, search* scripts.

%HTTP_EQUIV_ON_EDIT%

SL , UL

http-equiv meta tags for edit script.

%HTTP_EQUIV_ON_PREVIEW%

SL , UL

http-equiv meta tags for preview script.

%DENYWEBCHANGE%

WL

List of users and groups who are not allowed to change topics in the DENX web. (More in TWikiAccessControl)

%ALLOWWEBCHANGE%

WL

List of users and groups who are allowed to change topics in the DENX web. (More in TWikiAccessControl)

%DENYTOPICCHANGE%

(any topic)

List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)

%ALLOWTOPICCHANGE%

(any topic)

List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)

%DENYWEBRENAME%

WL

List of users and groups who are not allowed to rename topics in the DENX web. (More in TWikiAccessControl)

%ALLOWWEBRENAME%

WL

List of users and groups who are allowed to rename topics in the DENX web. (More in TWikiAccessControl)

%DENYTOPICRENAME%

(any topic)

List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)

%ALLOWTOPICRENAME%

(any topic)

List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)

%FINALPREFERENCES%

SL , WL

List of preferences that are not allowed to be overridden by next level preferences

Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a Help icon.

Setting Preferences

The syntax for Preferences Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [multiple of 3 spaces] * [space] Set [space] VARIABLENAME [space] = [value]Examples:

Set VARIABLENAME = value

Set VARIABLENAME = value

Creating Custom Variables

You can add your own Preference Variables for us across an entire site or a single web, using the standard Preferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.

Example: Create a custom logo variable the TWiki web

To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences page, and upload a logo file, ex: mylogo.gif. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: LogoTopic: