Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)

Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%

-- PeterThoeny - 13 Sep 2001

-- PeterThoeny - 19 Jan 2003

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.

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

• 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

%WEBLIST{"$name" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.

%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.

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

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

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

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

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

• 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

• To place a logo anywhere in a web by typing %MYLOGO%, 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 to LogoTopic (any topic name you choose):
  • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

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:
  • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif

-- MikeMannix - 07 Mar 2002

-- MikeMannix - 12 May 2002

-- MikeMannix - 23 Jan 2002

-- MikeMannix - 07 Mar 2002

Text strings expanded on the fly to display data or system info

Overview

Special text strings expand on the fly to display user data or system info

"parent" if searcing for topics that have a specific parent i.e. its

"parent" if searching for topics that have a specific parent i.e. its

-- MikeMannix - 05 Jan 2002

-- MikeMannix - 23 Jan 2002

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.

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.

Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.

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.

TWiki expands the following variables (enclosed in % percent signs):

• 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%.

This version of TWiki - 01 Feb 2003 - expands the following variables (enclosed in % percent signs):

[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on 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.

• The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
  [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
  Example:
  • Set VARIABLENAME = value

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

-- MikeMannix - 30 Nov 2001

-- MikeMannix - 05 Jan 2002

Customizing Variables

Creating Custom Variables

See: TWikiVariables Examples?

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

Example: Create a custom logo variable

• To place a logo anywhere in a web by typing %MYLOGO%, 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 to LogoTopic (any topic name you choose):
  • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

With a couple of notable exceptions, predefined variables return set values that are defined 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.

Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.

[3] Note: Regular search, no summary, BookView and FormattedSearch are exclusive.

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.

Customizing Variables

Example: Create a custom logo variable

• To place a logo anywhere in a web by typing %MYLOGO%, 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 to LogoTopic (any topic name you choose):
  • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

See: TWikiVariables Examples?

-- MikeMannix - 30 Aug 2001

-- MikeMannix - 30 Nov 2001

[3] Note: Regular search, no summary, BookView and FormattedSearch are exclusive.

Text strings expanded on the fly include predefined, preference-driven and custom-defined data

Text strings expanded on the fly to display data or system info

TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% 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!

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.

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.

With a couple of notable exceptions, predefined variables return set values that are defined 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.

TWiki expands the following variables enclosed in % percent signs:

TWiki expands the following variables (enclosed in % percent signs):

• • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

• • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 13 Sep 2001

%META:TOPICPARENT{name="WebHome"}%

%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).

%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).

Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
02 Feb, 2025 - 13:03:19

Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
02 Feb, 2025 - 13:03:19

• The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
  [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
  Example:

• The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
  [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
  Example:

Example: Create a custom logo variable

Example: Create a custom logo variable

-- MikeMannix - 30 Aug 2001

-- MikeMannix - 30 Aug 2001

TWiki Variables

TWiki Variables

Text strings expanded on the fly include predefined, preference-driven and custom-defined data

Overview

Predefined Variables

Predefined Variables

Preferences Variables

Preferences Variables

Setting Preferences

Setting Preferences

Creating Custom Variables

Creating Custom Variables

HOW-TO: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. In this case, you also have to upload logo.gif to the same directory.:

Example: Create a custom logo variable

• To place a logo anywhere in a web by typing %MYLOGO%, 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 to LogoTopic (any topic name you choose):

TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% 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: %VARIABLE% 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!

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.

Setting Variable Preferences

Setting Preferences

• 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.
  Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):

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

HOW-TO: Create a custom logo variable
To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. In this case, you also have to upload logo.gif to the same directory.:

About Variables

Include/write if not found elsewhere.

TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% 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.

Setting and Creating New Preferences

Setting Variable Preferences

• 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.
  Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):

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.
  Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):

-- MikeMannix - 26 Aug 2001

-- MikeMannix - 30 Aug 2001

About Variables

Include/write if not found elsewhere.

Notes:

Setting and Creating New Preferences

• Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
  • Set VARIABLENAME = value
• Additional preferences variables can be defined on all three level as needed. Example:
  • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

• The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
  [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
  Example:
  • Set VARIABLENAME = value
• 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.
  Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
  • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 23 Jul 2001

-- MikeMannix - 26 Aug 2001

-- MikeMannix - 26 Aug 2001

TOC: No TOC in "TWiki.TWikiVariables"

-- MikeMannix - 26 Aug 2001

Example:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.

-- PeterThoeny - 14 Jul 2001

-- PeterThoeny - 23 Jul 2001

%TOPICLIST{separator=", "}% creates a comma separated list of all topics.

-- PeterThoeny - 25 Jun 2001

-- PeterThoeny - 14 Jul 2001

-- PeterThoeny - 24 Mar 2001

-- PeterThoeny - 25 Jun 2001

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

-- PeterThoeny - 15 Mar 2001

-- PeterThoeny - 24 Mar 2001

TWiki Variables

Predefined Variables

Preferences Variables

-- PeterThoeny - 01 Mar 2001

-- PeterThoeny - 15 Mar 2001

-- PeterThoeny - 19 Jan 2001

-- PeterThoeny - 01 Mar 2001

-- PeterThoeny - 10 Nov 2000

-- PeterThoeny - 19 Jan 2001

[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

TWiki expands the following variables enclosed in % percent signs:

TWiki expands the following variables enclosed in % percent signs:

Example: %SEARCH{"wiki" web="Main" scope="topic"}%

Example: %SEARCH{"wiki" web="Main" scope="topic"}%

-- PeterThoeny - 01 Nov 2000

-- PeterThoeny - 10 Nov 2000

-- PeterThoeny - 18 Sep 2000

Notes:

• Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
  • Set VARIABLENAME = value
• Additional preferences variables can be defined on all three level as needed. Example:
  • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 01 Nov 2000

-- PeterThoeny - 17 Aug 2000

-- PeterThoeny - 18 Sep 2000

[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

-- PeterThoeny - 29 May 2000

-- PeterThoeny - 17 Aug 2000

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):

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):

-- PeterThoeny - 21 Apr 2000

-- PeterThoeny - 29 May 2000

-- PeterThoeny - 21 Apr 2000

TWiki expands the following variables enclosed in % percent signs: