netfrag.org > TWiki > TWikiVariables (r1.1 vs. r1.46)
TWiki . { Home? | Welcome | Register | Changes | Index | Search | Go }

 <<O>>  Difference Topic TWikiVariables (r1.46 - 02 Dec 2001 - MikeMannix?)
Line: 1 19 to 1 19
Changed:
<
<
>
>
Line: 212 to 213
Added:
>
>
format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Line: 216 to 216
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
Line: 269 to 244
Changed:
<
<
>
>
Line: 380 to 355
Changed:
<
<

Customizing Variables

>
>

Creating Custom Variables

Line: 382 to 357
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?)
Line: 1 15 to 1 15
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.
Line: 208 to 208
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
Line: 216 to 214
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
Line: 238 to 262
Deleted:
<
<

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

Line: 357 to 380
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

Line: 361 to 382
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
Line: 367 to 383
Deleted:
<
<		 -- MikeMannix - 30 Aug 2001
Line: 368 to 385
Added:
>
>		 -- MikeMannix - 30 Nov 2001

 <<O>>  Difference Topic TWikiVariables (r1.44 - 25 Oct 2001 - PeterThoeny?)
Line: 1 208 to 1 208
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
Line: 235 to 238
Added:
>
>

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


 <<O>>  Difference Topic TWikiVariables (r1.43 - 15 Sep 2001 - MikeMannix?)
Line: 1 3 to 1 2
Deleted:
<
<

Line: 9 to 7
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
Line: 13 to 11
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.
Line: 17 to 15
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.
Line: 19 to 17
Changed:
<
<		 netfrag.org expands the following variables enclosed in % percent signs:
>
>		 netfrag.org expands the following variables (enclosed in % percent signs):
Line: 21 to 19
Changed:
<
<
>
>
Line: 90 to 89
Added:
>
>
%WIKIPREFSTOPIC% The web preferences topic. Is TWikiPreferences
Line: 241 to 242
Changed:
<
<
>
>
Line: 356 to 357
Changed:
<
<
>
>

 <<O>>  Difference Topic TWikiVariables (r1.42 - 14 Sep 2001 - PeterThoeny?)
Line: 1 359 to 1 359
Changed:
<
<
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
>
>
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
Line: 362 to 363
Added:
>
>		 -- PeterThoeny - 13 Sep 2001

 <<O>>  Difference Topic TWikiVariables (r1.41 - 13 Sep 2001 - JohnTalintyre?)
Line: 1 to 1
Added:
>
>
META TOPICPARENT WebHome
Line: 43 to 44
Changed:
<
<
The attachment URL of the current topic, is https://netfrag.org/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 https://netfrag.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Line: 117 to 118
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).
Line: 130 to 131
Changed:
<
<
selection Current value e.g. current for current Web, =section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
>
>
selection="%WEB%" Current value to be selected in list section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
Line: 150 to 151
Changed:
<
<		 Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Dec, 2024 - 04:37:31
>
>		 Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Dec, 2024 - 04:37:31
Line: 156 to 157
Changed:
<
<
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 05:37
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 05:37
Line: 199 to 200
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
Line: 209 to 210
Changed:
<
<
noheader="on" Suppress search header
Topics: Changed: By: 		Show search header
>
>
noheader="on" Suppress search header
Topics: Changed: By: 		Show search header
Line: 212 to 214
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: "}%
Line: 335 to 349
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:
Line: 343 to 357
Changed:
<
<		 Example: Create a custom logo variable
>
>		 Example: Create a custom logo variable
Line: 348 to 362
Changed:
<
<		 -- MikeMannix - 30 Aug 2001
>
>		 -- MikeMannix - 30 Aug 2001

 <<O>>  Difference Topic TWikiVariables (r1.40 - 12 Sep 2001 - MikeMannix?)
Line: 1 to 1
Added:
>
>


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

TWiki Variables

>
>

TWiki Variables

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

Overview

Line: 8 to 12
Changed:
<
<

Predefined Variables

>
>

Predefined Variables

Line: 217 to 221
Changed:
<
<

Preferences Variables

>
>

Preferences Variables

Line: 327 to 331
Changed:
<
<

Setting Preferences

>
>

Setting Preferences

Line: 332 to 336
Changed:
<
<

Creating Custom Variables

>
>

Creating Custom Variables


 <<O>>  Difference Topic TWikiVariables (r1.38 - 07 Sep 2001 - MikeMannix?)
Line: 1 337 to 1 337
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?)
Line: 1 6 to 1 6
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!
Line: 9 to 10
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.
Line: 12 to 14
Changed:
<
<
Variable: Expanded to:
>
>
Variable: Expanded to:
Line: 208 to 211
Added:
>
>
Line: 211 to 215
Added:
>
>
Line: 217 to 221
Changed:
<
<
Variable: Level: What:
>
>
Variable: Level: What:
Line: 321 to 326
Changed:
<
<

Setting Variable Preferences

>
>

Setting Preferences

Line: 328 to 334
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.:
Line: 329 to 340
Added:
>
>

 <<O>>  Difference Topic TWikiVariables (r1.36 - 31 Aug 2001 - MikeMannix?)
Line: 1 5 to 1 4
Deleted:
<
<

About Variables


 <<O>>  Difference Topic TWikiVariables (r1.35 - 30 Aug 2001 - MikeMannix?)
Line: 1 8 to 1 8
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.
Line: 27 to 27
Changed:
<
<
The script suffix, i.e. .pl, is
>
>
The script suffix, ex: .pl, .cgi is
Line: 42 to 42
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
Line: 48 to 48
Changed:
<
<
Wiki tool version, is 04 Sep 2004 $Rev: 1742 $
>
>
Wiki tool version is 04 Sep 2004 $Rev: 1742 $
Line: 51 to 51
Changed:
<
<
Your login username, is guest
>
>
Your login username is guest
Line: 63 to 63
Changed:
<
<
The web containing all documentation and configuration of netfrag.org. Is TWiki
>
>
The web containing all documentation and configuration of netfrag.org is TWiki
Line: 66 to 66
Changed:
<
<
The current web, is TWiki
>
>
The current web is TWiki
Line: 323 to 323
Changed:
<
<

Setting and Creating New Preferences

>
>

Setting Variable Preferences

Line: 328 to 327
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):
Line: 331 to 333
Changed:
<
<		 -- MikeMannix - 26 Aug 2001
>
>		 -- MikeMannix - 30 Aug 2001

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

 <<O>>  Difference Topic TWikiVariables (r1.33 - 29 Aug 2001 - MikeMannix?)
Line: 1 5 to 1 6
Added:
>
>

About Variables

Include/write if not found elsewhere.

Line: 320 to 324
Changed:
<
<		 Notes:
>
>

Setting and Creating New Preferences

Line: 322 to 326
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
Line: 327 to 330
Deleted:
<
<		 -- PeterThoeny - 23 Jul 2001

 <<O>>  Difference Topic TWikiVariables (r1.32 - 27 Aug 2001 - MikeMannix?)
Line: 1 328 to 1 328
Changed:
<
<		 -- MikeMannix? - 26 Aug 2001
>
>		 -- MikeMannix - 26 Aug 2001

 <<O>>  Difference Topic TWikiVariables (r1.31 - 26 Aug 2001 - MikeMannix?)
Line: 1 to 1
Added:
>
>		 TOC: No TOC in "TWiki.TWikiVariables"
Line: 171 to 173
Changed:
<
<
Table of Content of current topic.
>
>
Table of Contents of current topic.
Line: 174 to 176
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:
Line: 325 to 328
Added:
>
>		 -- MikeMannix? - 26 Aug 2001

 <<O>>  Difference Topic TWikiVariables (r1.30 - 15 Aug 2001 - PeterThoeny?)
Line: 1 174 to 1 174
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?)
Line: 1 109 to 1 109
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.
Line: 115 to 115
Changed:
<
<		 Example:
%WEBLIST{"   * [[$name.Home]]"}% 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.Home]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
Line: 289 to 296
Added:
>
>
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the netfrag.org 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?)
Line: 1 52 to 1 53
Added:
>
>
%MAINWEB% The Main web containing TWikiUsers, OfficeLocations? and TWikiGroups?. Is Main
%TWIKIWEB% The web containing all documentation and configuration of netfrag.org. Is TWiki
Line: 61 to 68
Added:
>
>
%HOMETOPIC% The home topic in each web. Is Home?
%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
Line: 281 to 302
Changed:
<
<		 -- PeterThoeny - 14 Jul 2001
>
>		 -- PeterThoeny - 23 Jul 2001

 <<O>>  Difference Topic TWikiVariables (r1.27 - 15 Jul 2001 - PeterThoeny?)
Line: 1 75 to 1 75
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
Line: 77 to 84
Added:
>
>
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
Line: 81 to 88
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)
Line: 119 to 131
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:
Line: 135 to 147
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
Line: 141 to 154
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
Line: 214 to 229
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: checked
%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: checked
Line: 259 to 281
Changed:
<
<		 -- PeterThoeny - 25 Jun 2001
>
>		 -- PeterThoeny - 14 Jul 2001

 <<O>>  Difference Topic TWikiVariables (r1.26 - 11 Jul 2001 - PeterThoeny?)
Line: 0 45 to 1 47
Added:
>
>
%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
Line: 47 to 51
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?)
Line: 114 to 114
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/"}%
Line: 137 to 141
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
Line: 251 to 255
Changed:
<
<		 -- PeterThoeny - 24 Mar 2001
>
>		 -- PeterThoeny - 25 Jun 2001

 <<O>>  Difference Topic TWikiVariables (r1.24 - 08 Jun 2001 - PeterThoeny?)
Line: 69 to 70
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.Home]]"}% creates a bullet list of all webs.

 <<O>>  Difference Topic TWikiVariables (r1.23 - 02 Jun 2001 - PeterThoeny?)
Line: 33 to 34
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?)
Line: 121 to 121
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]
Line: 123 to 123
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
Line: 142 to 143
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.

Line: 235 to 238
Changed:
<
<		 -- PeterThoeny - 15 Mar 2001
>
>		 -- PeterThoeny - 24 Mar 2001

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

TWiki Variables

Predefined Variables

Line: 134 to 138
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 #444444
>
>
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 #444444
Line: 139 to 144
Added:
>
>

Preferences Variables

Line: 229 to 235
Changed:
<
<		 -- PeterThoeny? - 01 Mar 2001
>
>		 -- PeterThoeny - 15 Mar 2001

 <<O>>  Difference Topic TWikiVariables (r1.20 - 02 Mar 2001 - PeterThoeny?)
Line: 105 to 106
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"}%
Line: 219 to 229
Changed:
<
<		 -- PeterThoeny? - 19 Jan 2001
>
>		 -- PeterThoeny? - 01 Mar 2001

 <<O>>  Difference Topic TWikiVariables (r1.19 - 20 Jan 2001 - PeterThoeny?)
Line: 44 to 45
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.
Line: 47 to 54
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.
Line: 55 to 67
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
31 Dec, 2024 - 04:37:32
Line: 61 to 83
Changed:
<
<
Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 05:37

 <<O>>  Difference Topic TWikiVariables (r1.18 - 20 Jan 2001 - PeterThoeny?)
Line: 97 to 97
Changed:
<
<
noheader="on" Suppress search header
Topics: Changed: By: 		Show search header
>
>
noheader="on" Suppress search header
Topics: Changed: By: 		Show search header
Line: 197 to 197
Changed:
<
<		 -- PeterThoeny? - 10 Nov 2000
>
>		 -- PeterThoeny? - 19 Jan 2001

 <<O>>  Difference Topic TWikiVariables (r1.17 - 16 Jan 2001 - PeterThoeny?)
Line: 77 to 78
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?)
Line: 90 to 91
Added:
>
>
noheader="on" Suppress search header
Topics: Changed: By: 		Show search header

 <<O>>  Difference Topic TWikiVariables (r1.15 - 15 Dec 2000 - PeterThoeny?)
Line: 14 to 15
Added:
>
>
%SCRIPTSUFFIX% The script suffix, i.e. .pl, is

 <<O>>  Difference Topic TWikiVariables (r1.14 - 14 Dec 2000 - PeterThoeny?)
Line: 37 to 37
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
Line: 96 to 96
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?)
Line: 1 to 1
Changed:
<
<		 TWiki expands the following variables enclosed in % percent signs:
>
>		 netfrag.org expands the following variables enclosed in % percent signs:
Line: 7 to 7
Changed:
<
<
The base script URL of TWiki, link of Home icon in upper left corner, is http://TWiki.org/
>
>
The base script URL of netfrag.org, is the link of the Home icon in the upper left corner, is http://TWiki.org/
Line: 10 to 10
Changed:
<
<
The script URL of TWiki, is https://netfrag.org/twiki/bin
>
>
The script URL of netfrag.org, is https://netfrag.org/twiki/bin
Line: 13 to 13
Changed:
<
<
The path of the script URL of TWiki, is /twiki/bin
>
>
The path of the script URL of netfrag.org, is /twiki/bin
Line: 19 to 19
Changed:
<
<
The path of the public URL of TWiki, is /twiki/pub
>
>
The path of the public URL of netfrag.org, is /twiki/pub
Line: 73 to 73
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"}%
Line: 78 to 78
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
Line: 89 to 89
Changed:
<
<		 Example: %SEARCH{"wiki" web="Main" scope="topic"}%
>
>		 Example: %SEARCH{"wiki" web="Main" scope="topic"}%
Line: 92 to 92
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 #444444
>
>
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 #444444
Line: 157 to 158
Added:
>
>
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the netfrag.org 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
Line: 167 to 187
Changed:
<
<		 -- PeterThoeny? - 01 Nov 2000
>
>		 -- PeterThoeny? - 10 Nov 2000

 <<O>>  Difference Topic TWikiVariables (r1.12 - 02 Nov 2000 - PeterThoeny?)
Line: 89 to 90
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 #444444
Line: 156 to 160
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?)
Line: 122 to 123
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 )
Line: 141 to 149
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?)
Line: 44 to 45
Added:
>
>
%SPACEDTOPIC% The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
Line: 145 to 148
Changed:
<
<		 -- PeterThoeny? - 17 Aug 2000
>
>		 -- PeterThoeny? - 18 Sep 2000

 <<O>>  Difference Topic TWikiVariables (r1.9 - 18 Aug 2000 - PeterThoeny?)
Line: 69 to 69
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"}%
Line: 75 to 75
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
Line: 77 to 80
Added:
>
>
reverse="on" Reverse the direction of the search Ascending search
Line: 79 to 83
Added:
>
>
bookview="on" BookView search, e.g. show complete topic text Show topic summary
Line: 84 to 89
Added:
>
>		 [1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
Line: 109 to 116
Added:
>
>
%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
Line: 120 to 131
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.
Line: 123 to 145
Changed:
<
<		 -- PeterThoeny? - 29 May 2000
>
>		 -- PeterThoeny? - 17 Aug 2000

 <<O>>  Difference Topic TWikiVariables (r1.8 - 28 Jul 2000 - PeterThoeny?)
Line: 37 to 37
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
Line: 45 to 44
Deleted:
<
<
%DATE% Todays date (local server time), is 31 Dec 2024
Line: 49 to 46
Changed:
<
<
Todays date (GM time), is 31 Dec 2024 - 04:37
>
>
GM time, is 31 Dec 2024 - 04:37
%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 31 Dec 2024 - 05:37
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
Line: 79 to 85
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?)
Line: 46 to 46
Changed:
<
<
Todays date, is 31 Dec 2024
>
>
Todays date (local server time), is 31 Dec 2024
%GMTIME% Todays date (GM time), is 31 Dec 2024 - 04:37
Line: 114 to 117
Changed:
<
<		 -- PeterThoeny? - 21 Apr 2000
>
>		 -- PeterThoeny? - 29 May 2000

 <<O>>  Difference Topic TWikiVariables (r1.6 - 22 Apr 2000 - PeterThoeny?)
Line: 7 to 7
Changed:
<
<
The base script URL of TWiki, link of Home icon in upper left corner is http://TWiki.org/
>
>
The base script URL of TWiki, link of Home icon in upper left corner, is http://TWiki.org/
Line: 47 to 48
Added:
>
>
%HTTP_HOST% HTTP_HOST environment variable, is netfrag.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 18.119.112.208
%REMOTE_PORT% REMOTE_PORT environment variable, is 30716
%REMOTE_USER% REMOTE_USER environment variable, is
Line: 100 to 113
Added:
>
>

-- PeterThoeny? - 21 Apr 2000


 <<O>>  Difference Topic TWikiVariables (r1.5 - 21 Mar 2000 - PeterThoeny?)
Line: 95 to 96
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?)
Line: 10 to 10
Changed:
<
<
The base script URL of TWiki, is https://netfrag.org/twiki/bin
>
>
The script URL of TWiki, is https://netfrag.org/twiki/bin
%SCRIPTURLPATH% The path of the script URL of TWiki, is /twiki/bin
Line: 13 to 16
Changed:
<
<
The base public URL of TWiki, is https://netfrag.org/twiki/pub
>
>
The public URL of TWiki, is https://netfrag.org/twiki/pub
%PUBURLPATH% The path of the public URL of TWiki, is /twiki/pub
Line: 16 to 23
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?)
Line: 18 to 17
Deleted:
<
<
%WIKIWEBMASTER% The email address of the Wiki webmaster, is webmaster@netfrag.org
Line: 55 to 53
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 webmaster@netfrag.org
%WIKIWEBLIST% SL List of netfrag.org 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 100
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20

 <<O>>  Difference Topic TWikiVariables (r1.2 - 30 Jan 2000 - PeterThoeny?)
Line: 42 to 42
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)
Line: 1 to 1
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://TWiki.org/
%SCRIPTURL% The base script URL of TWiki, is https://netfrag.org/twiki/bin
%PUBURL% The base public URL of TWiki, is https://netfrag.org/twiki/pub
%ATTACHURL% The attachment URL of the current topic, is https://netfrag.org/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 webmaster@netfrag.org
%WIKITOOLNAME% Name of wiki tool, is netfrag.org
%WIKIVERSION% Wiki tool version, is 04 Sep 2004 $Rev: 1742 $
%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 31 Dec 2024
%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.46 | > | r1.45 | > | r1.44 | More }    output as: { }
Revision r1.1 - 13 Jun 1999 - 07:45 - Main.thoeny
Revision r1.46 - 02 Dec 2001 - 11:58 - MikeMannix?