Nice TWiki > TWiki > TWikiVariables (r1.1 vs. r1.62) TWiki webs:
Dev | Doc | Main | TWiki | Sandbox
TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }
 <<O>>  Difference Topic TWikiVariables (r1.62 - 27 Jan 2003 - PeterThoeny?)
Added:
>
>


 <<O>>  Difference Topic TWikiVariables (r1.61 - 19 Jan 2003 - PeterThoeny?)
Changed:
<
<

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)
HELP 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%" }%

Changed:
<
<

-- PeterThoeny - 13 Sep 2001

>
>

-- PeterThoeny - 19 Jan 2003


 <<O>>  Difference Topic TWikiVariables (r1.60 - 11 Dec 2002 - PeterThoeny?)
Changed:
<
<

Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
"SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
>
>

Server side include to IncludeTopicsAndWebPages:
Parameter: Description: Default:
"SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%  
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%  
pattern="..." A RegularExpression pattern to include a subset of a topic or page none
rev="1.2" Include a previous topic revision; N/A for URLs top revision
Changed:
<
<

header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
>
>

header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table

 <<O>>  Difference Topic TWikiVariables (r1.59 - 23 Nov 2002 - PeterThoeny?)
Changed:
<
<

"text" Search term. (Is a regular expression or literal, depending on the regex parameter) [TWikiAlphaRelease - for regular expressions ";" can be used to mean and e.g. "search;agrep" will find all topic containing search and agrep ] required
>
>

"text" Search term. Is a regular expression or literal, depending on the regex parameter. For regular expressions ";" is used to mean and e.g. "search;agrep" will find all topic containing search and agrep. required
Changed:
<
<

regex="on" RegularExpression search Literal search
>
>

regex="on" RegularExpression search; also enables ";" as and Literal search

 <<O>>  Difference Topic TWikiVariables (r1.58 - 06 Oct 2002 - PeterThoeny?)
Changed:
<
<

Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
>
>

Returns the value of a URL parameter. Note that there is a low risk that this variable could be misused for cross-scripting. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
Added:
>
>

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 Help icon.
Changed:
<
<

  • 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

 <<O>>  Difference Topic TWikiVariables (r1.57 - 25 Aug 2002 - PeterThoeny?)
Changed:
<
<

%WEBLIST{"" 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.


 <<O>>  Difference Topic TWikiVariables (r1.56 - 05 Jun 2002 - PeterThoeny?)
Changed:
<
<

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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
>
>

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. Parameters are topic name, web and depth:

 <<O>>  Difference Topic TWikiVariables (r1.55 - 24 May 2002 - PeterThoeny?)
Changed:
<
<

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

 <<O>>  Difference Topic TWikiVariables (r1.54 - 17 May 2002 - PeterThoeny?)
Changed:
<
<

The public URL of TWiki, is http://nice.sourceforge.net/twiki/pub
>
>

The public URL of TWiki, is http://nice.sourceforge.net/twiki/pub
Example: You can refer to a file attached to another topic as %PUBURL%/%WEB%/OtherTopic/image.gif
Added:
>
>

%URLENCODE{"string"}% Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name

 <<O>>  Difference Topic TWikiVariables (r1.53 - 15 May 2002 - PeterThoeny?)
Changed:
<
<

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiSiteMap"}%
>
>

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%

 <<O>>  Difference Topic TWikiVariables (r1.52 - 12 May 2002 - MikeMannix?)
Changed:
<
<

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
>
>

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiSiteMap"}%
Changed:
<
<

"text" Search term. (Is a regular expression or literal, depending on the regex parameter) required
>
>

"text" Search term. (Is a regular expression or literal, depending on the regex parameter) [TWikiAlphaRelease - for regular expressions ";" can be used to mean and e.g. "search;agrep" will find all topic containing search and agrep ] required
Changed:
<
<

title="Title" Text the is prepended to any search results required
>
>

title="Title" Text that is prepended to any search results required
Changed:
<
<

>
>

Changed:
<
<

  • 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:
Changed:
<
<

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

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

-- MikeMannix? - 07 Mar 2002

>
>

-- MikeMannix? - 12 May 2002


 <<O>>  Difference Topic TWikiVariables (r1.51 - 07 Apr 2002 - PeterThoeny?)
Changed:
<
<

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>

"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%

 <<O>>  Difference Topic TWikiVariables (r1.50 - 08 Mar 2002 - MikeMannix?)
Changed:
<
<

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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
>
>

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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
Changed:
<
<

-- MikeMannix? - 23 Jan 2002

>
>

-- MikeMannix? - 07 Mar 2002


 <<O>>  Difference Topic TWikiVariables (r1.49 - 16 Feb 2002 - PeterThoeny?)
Changed:
<
<

order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
>
>

order="topic"
order="modified"
order="editby"
order=
 "formfield(name)"
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms Sort by topic name

 <<O>>  Difference Topic TWikiVariables (r1.48 - 23 Jan 2002 - MikeMannix?)
Changed:
<
<

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

Changed:
<
<

format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
>
>

header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
Changed:
<
<

"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

Changed:
<
<

title="Title" Text the is pre-pended to any search results required
>
>

title="Title" Text the is prepended to any search results required
Changed:
<
<

-- MikeMannix? - 05 Jan 2002

>
>

-- MikeMannix? - 23 Jan 2002


 <<O>>  Difference Topic TWikiVariables (r1.47 - 06 Jan 2002 - MikeMannix?)
Changed:
<
<

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.

Changed:
<
<

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.

Changed:
<
<

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

>
>

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

Changed:
<
<

Name of wiki tool, is TWiki
>
>

The name of your TWiki site - TWiki
Changed:
<
<

Wiki tool version is 01 Feb 2003
>
>

Your current TWiki version - 01 Feb 2003
Changed:
<
<

Your login username is guest
>
>

Your login username - guest
Changed:
<
<

Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
>
>

Your %WIKINAME% including the Main web name - always use full signatures - Main.TWikiGuest
Changed:
<
<

The Main web containing TWikiUsers, OfficeLocations and TWikiGroups. Is Main
>
>

The web containing TWikiUsers, OfficeLocations and TWikiGroups is Main
Changed:
<
<

The web containing all documentation and configuration of TWiki is TWiki
>
>

The web containing all documentation and site-wide preference settings for TWiki - TWiki
Changed:
<
<

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

The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
Changed:
<
<

The home topic in each web. Is WebHome
>
>

The home topic in each web - WebHome
Changed:
<
<

The notify topic in each web. Is WebNotify
>
>

The notify topic in each web - WebNotify
Changed:
<
<

The index topic of all registered users. Is TWikiUsers
>
>

The index topic of all registered users - TWikiUsers
Changed:
<
<

The web preferences topic. Is TWikiPreferences
>
>

The site-wide preferences topic - TWikiPreferences
Changed:
<
<

The web preferences topic. Is WebPreferences
>
>

The local web preferences topic in each web - WebPreferences
Changed:
<
<

The web statistics topic. Is WebStatistics
>
>

The web statistics topic WebStatistics
Changed:
<
<

The current topic name, is TWikiVariables
>
>

The current topic name - TWikiVariables
Changed:
<
<

The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
>
>

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

Web index, e.g. 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.
>
>

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.
Changed:
<
<

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

Changed:
<
<

  • 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=
Changed:
<
<

-- MikeMannix - 30 Nov 2001

>
>

-- MikeMannix? - 05 Jan 2002


 <<O>>  Difference Topic TWikiVariables (r1.46 - 02 Dec 2001 - MikeMannix?)
Changed:
<
<

>
>

Added:
>
>

format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Deleted:
<
<

%SEARCH{... format="..."}% Control the formatting of an embedded search. By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the format="..." parameter to specify a custom format, typically, a bullet list or table row containing variables
Ex: %SEARCH{ "food" format="| $topic | $summary |" }%)
Two paramters can be used to specify a customized search result:
1. header="..." parameter
Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. Ex: header="| *Topic:* | *Summary:* |"
2. format="..." parameter
Use the format paramter to specify the format of one search hit.
Ex: format="| $topic | $summary |"
Variables that can be used in the format string:
Name: Expands To:
$web Name of the web
$topic Topic name
$locked LOCKED flag (if any)
$date Time stamp of last topic update
$rev Number of last topic revision, i.e. 1.4
$wikiusername Wiki user name of last topic update, i.e. Main.JohnSmith
$summary Topic summary
$formfield(name) The field value of a form field, i.e. $formfield(TopicClassification?) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$pattern(reg-exp) A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....
Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, ex: $pattern(.*?(from here.*?to here).*). You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag.
NOTE: Sorting is nicely covered by the TablePlugin.
For how-to tips and tricks, see: TWikiVariablesExamples?
Changed:
<
<

>
>

Changed:
<
<

Customizing Variables

>
>

Creating Custom Variables

Changed:
<
<

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

 <<O>>  Difference Topic TWikiVariables (r1.45 - 30 Nov 2001 - MikeMannix?)
Changed:
<
<

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.

Changed:
<
<

nosummary="on" Show topic title only. [3] Show topic summary
bookview="on" BookView search, e.g. show complete topic text. [3] Show topic summary.
format="..." Define a FormattedSearch, i.e.
"   * [[$topic]]: $summary". [3]
Show regular search result with topic summary
header="..." Specify header of FormattedSearch, i.e.
"   * *Topic: Summary:*".
Show regular header
>
>

nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text Show topic summary
Changed:
<
<

>
>

%SEARCH{... format="..."}% Control the formatting of an embedded search. By default, the search result display format is fixed: a table with rows of topic name and topic summary. Use the format="..." parameter to specify a custom format, typically, a bullet list or table row containing variables
Ex: %SEARCH{ "food" format="| $topic | $summary |" }%)
Two paramters can be used to specify a customized search result:
1. header="..." parameter
Use the header paramter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional. Ex: header="| *Topic:* | *Summary:* |"
2. format="..." parameter
Use the format paramter to specify the format of one search hit.
Ex: format="| $topic | $summary |"
Variables that can be used in the format string:
Name: Expands To:
$web Name of the web
$topic Topic name
$locked LOCKED flag (if any)
$date Time stamp of last topic update
$rev Number of last topic revision, i.e. 1.4
$wikiusername Wiki user name of last topic update, i.e. Main.JohnSmith
$summary Topic summary
$formfield(name) The field value of a form field, i.e. $formfield(TopicClassification?) would get expanded to PublicFAQ. This applies only to topics that have a TWikiForm
$pattern(reg-exp) A regular expression pattern to extract some text from a topic, i.e. $pattern(.*?\*.*?Email\:\s*([^\n\r]+).*) extracts the email address from a bullet of format * Email: ....
Note: For $pattern(reg-exp), specify a RegularExpression that scans from start to end and contains the text you want to keep in parenthesis, ex: $pattern(.*?(from here.*?to here).*). You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag.
NOTE: Sorting is nicely covered by the TablePlugin.
For how-to tips and tricks, see: TWikiVariablesExamples?
Deleted:
<
<

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

Changed:
<
<

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

Changed:
<
<

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?

Deleted:
<
<

-- MikeMannix - 30 Aug 2001

Added:
>
>

-- MikeMannix - 30 Nov 2001


 <<O>>  Difference Topic TWikiVariables (r1.44 - 25 Oct 2001 - PeterThoeny?)
Changed:
<
<

nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text Show topic summary
>
>

nosummary="on" Show topic title only. [3] Show topic summary
bookview="on" BookView search, e.g. show complete topic text. [3] Show topic summary.
format="..." Define a FormattedSearch, i.e.
"   * [[$topic]]: $summary". [3]
Show regular search result with topic summary
header="..." Specify header of FormattedSearch, i.e.
"   * *Topic: Summary:*".
Show regular header
Added:
>
>

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


 <<O>>  Difference Topic TWikiVariables (r1.43 - 15 Sep 2001 - MikeMannix?)
Deleted:
<
<

Changed:
<
<

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

Changed:
<
<

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.

Changed:
<
<

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.

Changed:
<
<

TWiki expands the following variables enclosed in % percent signs:

>
>

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

Changed:
<
<

>
>

Added:
>
>

%WIKIPREFSTOPIC% The web preferences topic. Is TWikiPreferences
Changed:
<
<

>
>

Changed:
<
<

>
>


 <<O>>  Difference Topic TWikiVariables (r1.42 - 14 Sep 2001 - PeterThoeny?)
Changed:
<
<

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

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

-- PeterThoeny - 13 Sep 2001


 <<O>>  Difference Topic TWikiVariables (r1.41 - 13 Sep 2001 - JohnTalintyre?)
Changed:
<
<
>
>

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

Changed:
<
<

The attachment URL of the current topic, is http://nice.sourceforge.net/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
>
>

The attachment URL of the current topic, is http://nice.sourceforge.net/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Changed:
<
<


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

Changed:
<
<

selection Current value e.g. current for current Web, =section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
>
>

selection="%WEB%" Current value to be selected in list section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
Changed:
<
<

Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
20 Oct, 2017 - 01:42:40

>
>

Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
20 Oct, 2017 - 01:42:40

Changed:
<
<

Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 01:42
>
>

Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 01:42
Changed:
<
<

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2] Current web
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
>
>

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2] Current web
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
Changed:
<
<

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
>
>

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
Added:
>
>

%METASEARCH{...}% Special search of meta data
Parameter: Description: Default:
type="topicmoved" What sort of search is required?
"topicmoved" if search for a topic that may have been moved
"parent" if searcing 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 the is pre-pended 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: "}%
Changed:
<
<

  • 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:
Changed:
<
<

Example: Create a custom logo variable

>
>

Example: Create a custom logo variable

Changed:
<
<

-- MikeMannix - 30 Aug 2001

>
>

-- MikeMannix - 30 Aug 2001


 <<O>>  Difference Topic TWikiVariables (r1.40 - 12 Sep 2001 - MikeMannix?)
Changed:
<
<
>
>


 <<O>>  Difference Topic TWikiVariables (r1.39 - 07 Sep 2001 - MikeMannix?)
Changed:
<
<

TWiki Variables

>
>

TWiki Variables

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

Overview

Changed:
<
<

Predefined Variables

>
>

Predefined Variables

Changed:
<
<

Preferences Variables

>
>

Preferences Variables

Changed:
<
<

Setting Preferences

>
>

Setting Preferences

Changed:
<
<

Creating Custom Variables

>
>

Creating Custom Variables


 <<O>>  Difference Topic TWikiVariables (r1.38 - 07 Sep 2001 - MikeMannix?)
Changed:
<
<

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

 <<O>>  Difference Topic TWikiVariables (r1.37 - 01 Sep 2001 - MikeMannix?)
Changed:
<
<

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!

Added:
>
>

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.

Changed:
<
<

Variable: Expanded to:
>
>

Variable: Expanded to:
Deleted:
<
<

Added:
>
>

Added:
>
>

Changed:
<
<

Variable: Level: What:
>
>

Variable: Level: What:
Changed:
<
<

Setting Variable Preferences

>
>

Setting Preferences

Changed:
<
<

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


 <<O>>  Difference Topic TWikiVariables (r1.36 - 31 Aug 2001 - MikeMannix?)
Deleted:
<
<

About Variables


 <<O>>  Difference Topic TWikiVariables (r1.35 - 30 Aug 2001 - MikeMannix?)
Changed:
<
<

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.

Changed:
<
<

The script suffix, i.e. .pl, is
>
>

The script suffix, ex: .pl, .cgi is
Changed:
<
<

Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
>
>

Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
Changed:
<
<

Wiki tool version, is 01 Feb 2003
>
>

Wiki tool version is 01 Feb 2003
Changed:
<
<

Your login username, is guest
>
>

Your login username is guest
Changed:
<
<

The web containing all documentation and configuration of TWiki. Is TWiki
>
>

The web containing all documentation and configuration of TWiki is TWiki
Changed:
<
<

The current web, is TWiki
>
>

The current web is TWiki
Changed:
<
<

Setting and Creating New Preferences

>
>

Setting Variable Preferences

Changed:
<
<

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

-- MikeMannix - 26 Aug 2001

>
>

-- MikeMannix - 30 Aug 2001


 <<O>>  Difference Topic TWikiVariables (r1.34 - 30 Aug 2001 - MikeMannix?)

 <<O>>  Difference Topic TWikiVariables (r1.33 - 29 Aug 2001 - MikeMannix?)
Added:
>
>

About Variables

Include/write if not found elsewhere.

Changed:
<
<

Notes:

>
>

Setting and Creating New Preferences

Changed:
<
<

  • 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
Deleted:
<
<

-- PeterThoeny - 23 Jul 2001


 <<O>>  Difference Topic TWikiVariables (r1.32 - 27 Aug 2001 - MikeMannix?)
Changed:
<
<

-- MikeMannix? - 26 Aug 2001

>
>

-- MikeMannix - 26 Aug 2001


 <<O>>  Difference Topic TWikiVariables (r1.31 - 26 Aug 2001 - MikeMannix?)
Changed:
<
<
>
>

TOC: No TOC in "TWiki.TWikiVariables"

Changed:
<
<

Table of Content of current topic.
>
>

Table of Contents of current topic.
Changed:
<
<

Table of Content. 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. (But not "<H2>text<H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
>
>

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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
Added:
>
>

-- MikeMannix? - 26 Aug 2001


 <<O>>  Difference Topic TWikiVariables (r1.30 - 15 Aug 2001 - PeterThoeny?)
Changed:
<
<

Table of Content. 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. Parameters are topic name, web and depth:
>
>

Table of Content. 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. (But not "<H2>text<H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:

 <<O>>  Difference Topic TWikiVariables (r1.29 - 07 Aug 2001 - JohnTalintyre?)
Changed:
<
<

Web index, e.g. 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.
>
>

Web index, e.g. 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.
Changed:
<
<

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

>
>

webs="public" comma sep list of Web, public expands to all non-hidden "public"
marker="selected" Text for $marker where item matches selection, otherwise equals "" "selected"
selection Current value e.g. current for current Web, =section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
Added:
>
>

%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the TWiki 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)

 <<O>>  Difference Topic TWikiVariables (r1.28 - 23 Jul 2001 - PeterThoeny?)
Added:
>
>

%MAINWEB% The Main web containing TWikiUsers, OfficeLocations and TWikiGroups. Is Main
%TWIKIWEB% The web containing all documentation and configuration of TWiki. Is TWiki
Added:
>
>

%HOMETOPIC% The home topic in each web. Is WebHome
%NOTIFYTOPIC% The notify topic in each web. Is WebNotify
%WIKIUSERSTOPIC% The index topic of all registered users. Is TWikiUsers
%WEBPREFSTOPIC% The web preferences topic. Is WebPreferences
%STATISTICSTOPIC% The web statistics topic. Is WebStatistics
Changed:
<
<

-- PeterThoeny - 14 Jul 2001

>
>

-- PeterThoeny - 23 Jul 2001


 <<O>>  Difference Topic TWikiVariables (r1.27 - 15 Jul 2001 - PeterThoeny?)
Changed:
<
<

Topic index of a web. Parameter is composed of the format, followed by an optional web="Name". The "format" defines the format of one topic item; use it to create any formatting you need. The $name variable is expanded to the topic name; the $web variable is expanded to the name of the web.
>
>

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:
Parameter: Description: Default:
"format" Format of one line, may include $name and $web variables "$name"
format="format" (Alternative to above) "$name"
separator=", " line separator "\n" (new line)
web="Name" Name of web Current web
Added:
>
>


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

Changed:
<
<

Web index, e.g. 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 is expanded to the name of the web.
>
>

Web index, e.g. 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. Parameters are format, separator and web:
Parameter: Description: Default:
"format" Format of one line, may include $name variable "$name"
format="format" (Alternative to above) "$name"
separator=", " line separator "\n" (new line)
Changed:
<
<

Server side include to IncludeTopicsAndWebPages. The parameter is composed of the page name, followed by an optional pattern="(reg-exp)" pair. The page name is:
>
>

Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
Changed:
<
<

Table of Content. 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. Parameter is composed of the topic name, followed by optional name="value" pairs:
Pair: Description: Default:
>
>

Table of Content. 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. Parameters are topic name, web and depth:
Parameter: Description: Default:
"TopicName" topic name Current topic
Changed:
<
<

%SEARCH{"str" ...}% Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional name="value" pairs: [1]
Pair: Description: Default:
search="food" Search term, (either regex or literal, depending on the regex parameter) (used if initial search term is missing)
>
>

%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
Parameter: Description: Default:
"text" Search term. (Is a regular expression or literal, depending on the regex parameter) required
search="text" (Alternative to above) N/A
Added:
>
>

%RELEASEEDITLOCKCHECKBOX% SL , UL 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:
Changed:
<
<

-- PeterThoeny - 25 Jun 2001

>
>

-- PeterThoeny - 14 Jul 2001


 <<O>>  Difference Topic TWikiVariables (r1.26 - 11 Jul 2001 - PeterThoeny?)
Added:
>
>
Added:
>
>

%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
Changed:
<
<

Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
>
>

Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest

 <<O>>  Difference Topic TWikiVariables (r1.25 - 26 Jun 2001 - PeterThoeny?)
Changed:
<
<

%INCLUDE{"SomeTopic"}% Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>

%INCLUDE{"page" ...}% Server side include to IncludeTopicsAndWebPages. The parameter is composed of the page name, followed by an optional pattern="(reg-exp)" pair. The page name is:
"SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
Changed:
<
<

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [2] Current web
>
>

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs. [2] Current web
Changed:
<
<

-- PeterThoeny - 24 Mar 2001

>
>

-- PeterThoeny - 25 Jun 2001


 <<O>>  Difference Topic TWikiVariables (r1.24 - 08 Jun 2001 - PeterThoeny?)
Added:
>
>

%TOPICLIST{"format"}% Topic index of a web. Parameter is composed of the format, followed by an optional web="Name". The "format" defines the format of one topic item; use it to create any formatting you need. The $name variable is expanded to the topic name; the $web variable is expanded to the name of the web. Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}% Web index, e.g. 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 is expanded to the name of the web. Example:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.

 <<O>>  Difference Topic TWikiVariables (r1.23 - 02 Jun 2001 - PeterThoeny?)
Added:
>
>

%URLPARAM{"name"}% Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is

 <<O>>  Difference Topic TWikiVariables (r1.22 - 25 Mar 2001 - PeterThoeny?)
Changed:
<
<

Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
>
>

Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional name="value" pairs: [1]
Changed:
<
<

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1] Current web
>
>

search="food" Search term, (either regex or literal, depending on the regex parameter) (used if initial search term is missing)
web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [2] Current web
Changed:
<
<

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

Changed:
<
<

-- PeterThoeny - 15 Mar 2001

>
>

-- PeterThoeny - 24 Mar 2001


 <<O>>  Difference Topic TWikiVariables (r1.21 - 16 Mar 2001 - PeterThoeny?)
Added:
>
>

TWiki Variables

Predefined Variables

Changed:
<
<

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

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 #FFFFC0
Added:
>
>

Preferences Variables

Changed:
<
<

-- PeterThoeny? - 01 Mar 2001

>
>

-- PeterThoeny - 15 Mar 2001


 <<O>>  Difference Topic TWikiVariables (r1.20 - 02 Mar 2001 - PeterThoeny?)
Added:
>
>

%TOC% Table of Content of current topic.
%TOC{"SomeTopic" ...}% Table of Content. 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. Parameter is composed of the topic name, followed by optional name="value" pairs:
Pair: Description: Default:
web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
Changed:
<
<

-- PeterThoeny? - 19 Jan 2001

>
>

-- PeterThoeny? - 01 Mar 2001


 <<O>>  Difference Topic TWikiVariables (r1.19 - 20 Jan 2001 - PeterThoeny?)
Added:
>
>

%BASEWEB% The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include.
%INCLUDINGWEB% The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
Added:
>
>

%BASETOPIC% The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
%INCLUDINGTOPIC% The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
Changed:
<
<

Formatted GM time based on keywords (first three characters needed.)
Example: %GMTIME{"day month, year - hour:min:sec"}% is day month, year - hour:min:sec
>
>

Formatted GM time based on time variables.
Variable: Unit: Example
$seconds seconds 59
$minutes minutes 59
$hours hours 23
$day day of month 31
$month month in ISO format Dec
$mo 2 digit month 12
$year 4 digit year 1999
$ye 2 digit year 99
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
20 Oct, 2017 - 01:42:40
Changed:
<
<

Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
>
>

Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 01:42

 <<O>>  Difference Topic TWikiVariables (r1.18 - 20 Jan 2001 - PeterThoeny?)
Changed:
<
<

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
>
>

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
Changed:
<
<

-- PeterThoeny? - 10 Nov 2000

>
>

-- PeterThoeny? - 19 Jan 2001


 <<O>>  Difference Topic TWikiVariables (r1.17 - 16 Jan 2001 - PeterThoeny?)
Added:
>
>

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

 <<O>>  Difference Topic TWikiVariables (r1.16 - 18 Dec 2000 - PeterThoeny?)
Added:
>
>

noheader="on" Suppress search header
Topics: Changed: By:
Show search header

 <<O>>  Difference Topic TWikiVariables (r1.15 - 15 Dec 2000 - PeterThoeny?)
Added:
>
>

%SCRIPTSUFFIX% The script suffix, i.e. .pl, is

 <<O>>  Difference Topic TWikiVariables (r1.14 - 14 Dec 2000 - PeterThoeny?)
Changed:
<
<

Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
>
>

Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
Changed:
<
<

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


 <<O>>  Difference Topic TWikiVariables (r1.13 - 11 Nov 2000 - PeterThoeny?)
Changed:
<
<

TWiki expands the following variables enclosed in % percent signs:

>
>

TWiki expands the following variables enclosed in % percent signs:

Changed:
<
<

The base script URL of TWiki, link of Home icon in upper left corner, is http://your.domain.com/twiki
>
>

The base script URL of TWiki, is the link of the Home icon in the upper left corner, is http://your.domain.com/twiki
Changed:
<
<

The script URL of TWiki, is http://nice.sourceforge.net/cgi-bin/twiki
>
>

The script URL of TWiki, is http://nice.sourceforge.net/cgi-bin/twiki
Changed:
<
<

The path of the script URL of TWiki, is /cgi-bin/twiki
>
>

The path of the script URL of TWiki, is /cgi-bin/twiki
Changed:
<
<

The path of the public URL of TWiki, is /twiki/pub
>
>

The path of the public URL of TWiki, is /twiki/pub
Changed:
<
<

Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>

Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
Changed:
<
<

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1] Current web
>
>

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1] Current web
Changed:
<
<

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

>
>

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

Changed:
<
<

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

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

%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the TWiki 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)
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
Changed:
<
<

-- PeterThoeny? - 01 Nov 2000

>
>

-- PeterThoeny? - 10 Nov 2000


 <<O>>  Difference Topic TWikiVariables (r1.12 - 02 Nov 2000 - PeterThoeny?)
Added:
>
>

%VAR{"NAME" web="Web"}% Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFFFC0
Changed:
<
<

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


 <<O>>  Difference Topic TWikiVariables (r1.11 - 20 Sep 2000 - PeterThoeny?)
Added:
>
>

%NEWTOPICBGCOLOR% SL , UL Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views )
Changed:
<
<

http-equiv meta tags for edit script.
>
>

http-equiv meta tags for edit script.

 <<O>>  Difference Topic TWikiVariables (r1.10 - 19 Sep 2000 - PeterThoeny?)
Added:
>
>

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

-- PeterThoeny? - 17 Aug 2000

>
>

-- PeterThoeny? - 18 Sep 2000


 <<O>>  Difference Topic TWikiVariables (r1.9 - 18 Aug 2000 - PeterThoeny?)
Changed:
<
<

%INCLUDE{"file.ext"}% Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"../Know/TopicName.txt"}%
>
>

%INCLUDE{"SomeTopic"}% Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
Changed:
<
<

web="Name" Specify Wiki web to search Current web
scope="topic" Search topic name (title) Topic text (body)
>
>

web="Name"
web="Main Know"
web="all"
Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1] Current web
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
Added:
>
>

reverse="on" Reverse the direction of the search Ascending search
Added:
>
>

bookview="on" BookView search, e.g. show complete topic text Show topic summary
Added:
>
>

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

Added:
>
>

%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
Added:
>
>

%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.
Changed:
<
<

-- PeterThoeny? - 29 May 2000

>
>

-- PeterThoeny? - 17 Aug 2000


 <<O>>  Difference Topic TWikiVariables (r1.8 - 28 Jul 2000 - PeterThoeny?)
Changed:
<
<

Your Wiki username, if defined in TWikiUsers?. Same as %USERNAME% if not defined. Is Main.TWikiGuest
>
>

Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
Deleted:
<
<

%DATE% Todays date (local server time), is 20 Oct 2017
Changed:
<
<

Todays date (GM time), is Fri Oct 20 01:42:41 2017
>
>

GM time, is Fri Oct 20 01:42:41 2017
%GMTIME{"format"}% Formatted GM time based on keywords (first three characters needed.)
Example: %GMTIME{"day month, year - hour:min:sec"}% is day month, year - hour:min:sec
%SERVERTIME% Server time, is Fri Oct 20 01:42:41 2017
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
Changed:
<
<

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


 <<O>>  Difference Topic TWikiVariables (r1.7 - 29 May 2000 - PeterThoeny?)
Changed:
<
<

Todays date, is 20 Oct 2017
>
>

Todays date (local server time), is 20 Oct 2017
%GMTIME% Todays date (GM time), is Fri Oct 20 01:42:41 2017
Changed:
<
<

-- PeterThoeny? - 21 Apr 2000

>
>

-- PeterThoeny? - 29 May 2000


 <<O>>  Difference Topic TWikiVariables (r1.6 - 22 Apr 2000 - PeterThoeny?)
Changed:
<
<

The base script URL of TWiki, link of Home icon in upper left corner is http://your.domain.com/twiki
>
>

The base script URL of TWiki, link of Home icon in upper left corner, is http://your.domain.com/twiki
Added:
>
>

%HTTP_HOST% HTTP_HOST environment variable, is nice.sourceforge.net
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 127.0.0.1
%REMOTE_PORT% REMOTE_PORT environment variable, is 39350
%REMOTE_USER% REMOTE_USER environment variable, is
Added:
>
>

-- PeterThoeny? - 21 Apr 2000


 <<O>>  Difference Topic TWikiVariables (r1.5 - 21 Mar 2000 - PeterThoeny?)
Added:
>
>

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

 <<O>>  Difference Topic TWikiVariables (r1.4 - 01 Mar 2000 - PeterThoeny?)
Changed:
<
<

The base script URL of TWiki, is http://nice.sourceforge.net/cgi-bin/twiki
>
>

The script URL of TWiki, is http://nice.sourceforge.net/cgi-bin/twiki
%SCRIPTURLPATH% The path of the script URL of TWiki, is /cgi-bin/twiki
Changed:
<
<

The base public URL of TWiki, is http://nice.sourceforge.net/twiki/pub
>
>

The public URL of TWiki, is http://nice.sourceforge.net/twiki/pub
%PUBURLPATH% The path of the public URL of TWiki, is /twiki/pub
Added:
>
>

%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables

 <<O>>  Difference Topic TWikiVariables (r1.3 - 28 Feb 2000 - PeterThoeny?)
Deleted:
<
<

%WIKIWEBMASTER% The email address of the Wiki webmaster, is greifa@users.sf.net
Added:
>
>

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

Variable: Level: What:
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is greifa@users.sf.net
%WIKIWEBLIST% SL List of TWiki webs (in upper right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBBGCOLOR% WL Background color of web
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17

 <<O>>  Difference Topic TWikiVariables (r1.2 - 30 Jan 2000 - PeterThoeny?)
Changed:
<
<

%INCLUDE:"file.ext"% Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE:"../Know/TopicName.txt"%
>
>

%INCLUDE{"file.ext"}% Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"../Know/TopicName.txt"}%
%SEARCH{"str" ...}% Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
Pair: Description: Default:
web="Name" Specify Wiki web to search Current web
scope="topic" Search topic name (title) Topic text (body)
regex="on" RegularExpression search Literal search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
nosearch="on" Suppress search string Show search string
nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%

 <<O>>  Difference Topic TWikiVariables (r1.1 - 13 Jun 1999 - Main.thoeny)
Added:
>
>

TWiki expands the following variables enclosed in % percent signs:

Variable: Expanded to:
%WIKIHOMEURL% The base script URL of TWiki, link of Home icon in upper left corner is http://your.domain.com/twiki
%SCRIPTURL% The base script URL of TWiki, is http://nice.sourceforge.net/cgi-bin/twiki
%PUBURL% The base public URL of TWiki, is http://nice.sourceforge.net/twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://nice.sourceforge.net/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%WIKIWEBMASTER% The email address of the Wiki webmaster, is greifa@users.sf.net
%WIKITOOLNAME% Name of wiki tool, is TWiki
%WIKIVERSION% Wiki tool version, is 01 Feb 2003
%USERNAME% Your login username, is guest
%WIKIUSERNAME% Your Wiki username, if defined in TWikiUsers?. Same as %USERNAME% if not defined. Is Main.TWikiGuest
%WEB% The current web, is TWiki
%TOPIC% The current topic name, is TWikiVariables
%DATE% Todays date, is 20 Oct 2017
%INCLUDE:"file.ext"% Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE:"../Know/TopicName.txt"%

Topic TWikiVariables . { View | Diffs | r1.62 | > | r1.61 | > | r1.60 | More }
Revision r1.1 - 13 Jun 1999 - 07:45 GMT - Main.thoeny
Revision r1.62 - 27 Jan 2003 - 08:22 GMT - PeterThoeny?
Copyright © 1999-2003 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback.