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

Changed:

<<

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.

>>

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is rendered for viewing. VARIABLES are replaced by data, either user-entered or automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you can configure. You can also define custom variables, with new names and values.

Changed:

<<

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

>>

Notes:

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

Variables are expanded relative to the topic they are used in, not the topic they are defined in.

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

Sort by topic name

limit="all"limit="16"

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

SPACEDTOPIC -- topic name, spaced and encoded

STARTINCLUDE -- start position of topic text if included

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.

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

Syntax: %TOC{"SomeTopic" ...}%

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

WEB -- name of current web

WEBLIST{"format"} -- index of all webs

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.

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

Sort by topic name

limit="all"limit="16"

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

SPACEDTOPIC -- topic name, spaced and encoded

STARTINCLUDE -- start position of topic text if included

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.

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

Syntax: %TOC{"SomeTopic" ...}%

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

WEB -- name of current web

WEBLIST{"format"} -- index of all webs

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.

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

Added:

>>

%ALLOWWEBRENAME%

WL

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

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:

Added:

>>

%DENYTOPICCHANGE%

(any topic)

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

Added:

>>

%DENYTOPICCHANGE%

%DENYTOPICRENAME%

(any topic)

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

Added:

>>

%DENYTOPICRENAME%

%DENYWEBCHANGE%

WL

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

Added:

>>

%DENYWEBRENAME%

WL

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

Added:

>>

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

Exclude web from a web="all" search (set variable to on for hidden webs)

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:

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

%INCLUDINGTOPIC%

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

%SPACEDTOPIC%

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

%TOPICLIST{"format"}%

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

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

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

%STOPINCLUDE%

If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.

%TOC%

Table of Contents of current topic.

%TOC{"SomeTopic" ...}%

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

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

Sort by topic name

limit="all"limit="16"

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

All results

Line: 255 to 244

expandvariables="on"

Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin%CALC{}% instead of the formula

Raw text

multiple="on"

Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search

Only one hit per topic

separator=", "

Line separator between hits

Newline "$n"

Changed:

<<

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

SPACEDTOPIC -- topic name, spaced and encoded

STARTINCLUDE -- start position of topic text if included

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.

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

Syntax: %TOC{"SomeTopic" ...}%

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

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

required

web="%WEB%"

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

required

topic="%TOPIC%"

The topic the search relates to

required

title="Title"

Text that is prepended to any search results

required

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

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

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

WEB -- name of current web

WEBLIST{"format"} -- index of all webs

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.

List of users and groups who are allowed to change 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)

%ALLOWWEBCHANGE%

WL

Changed:

<<

Common links of web (second line of topics)

%WEBCOPYRIGHT%

SL , WL

Copyright notice (bottom right corner of topics)

%WEBBGCOLOR%

>>

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

%ALLOWWEBRENAME%

WL

Changed:

<<

Background color of web

%NOSEARCHALL%

>>

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

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

%DENYTOPICCHANGE%

(any topic)

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

%DENYTOPICRENAME%

(any topic)

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

%DENYWEBCHANGE%

WL

Changed:

<<

Exclude web from a web="all" search (set variable to on for hidden webs)

Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is:

%DONTNOTIFYCHECKBOX%

SL , UL

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

%ATTACHLINKBOX%

SL , UL

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

%HTTP_EQUIV_ON_VIEW%

SL

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

>>

%FINALPREFERENCES%

SL , WL

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

%HTTP_EQUIV_ON_EDIT%

SL , UL

http-equiv meta tags for edit script.

Changed:

<<

>>

%HTTP_EQUIV_ON_PREVIEW%

SL , UL

http-equiv meta tags for preview script.

Changed:

<<

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

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

%ALLOWWEBRENAME%

>>

Exclude web from a web="all" search (set variable to on for hidden webs)

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

%WEBBGCOLOR%

WL

Changed:

<<

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)

%FINALPREFERENCES%

>>

Background color of web

%WEBCOPYRIGHT%

SL , WL

Changed:

<<

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

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.

Added:

>>

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

Predefined Variables

Most predefined variables return values that were either set in the lib/twiki.cfg file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.

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

Sort by topic name

limit="all"limit="16"

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

Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search

Only one hit per topic

separator=", "

Line separator between hits

Newline "$n"

Changed:

<<

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

>>

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

Encode special characters into HTML entities, like a double quote into &#034;

URL encoding

type="url"

Encode special characters for URL parameter use, like a double quote into %22

(this is the default)

Example: %ENCODE{"spaced name"}% returns spaced%20name

%WIKITOOLNAME%

The name of your TWiki site - TWiki

Line: 202 to 209

Table of Contents of current topic.

%TOC{"SomeTopic" ...}%

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

>>

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

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

>>

Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Parameters are name and newline:

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

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 the TWiki web

>>

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:

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:

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

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

search="text"

(Alternative to above)

N/A

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"order= "formfield(name)"

Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms

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

%URLPARAM{"name"}%

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

%URLENCODE{"string"}%

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

Line: 351 to 351

SL , WL

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

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

Setting Preferences

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:

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:

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

search="text"

(Alternative to above)

N/A

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)

Line: 225 to 225

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

Changed:

<<

title="Title"

Text the is prepended to any search results

required

>>

title="Title"

Text that is prepended to any search results

required

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

Line: 348 to 348

SL , WL

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

Changed:

<<

>>

Setting Preferences

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:

Set VARIABLENAME = =value=

Set VARIABLENAME = =value=

Creating Custom Variables

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:

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:

TWiki Variables

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

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.

| type="topicmoved" | What sort of search is required? "topicmoved" if search for a topic that may have been moved

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

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

Changed:

<<

title="Title"

Text the is pre-pended to any search results

required

>>

title="Title"

Text the is prepended to any search results

required

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

Overview

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.

Predefined Variables

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

>>

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

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.

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:

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?

Customizing Variables

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

Predefined Variables

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.

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:

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?

Preferences Variables

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

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

Preferences Variables

TWiki Variables

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

Overview

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.

Predefined Variables

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.

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.

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

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

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.

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

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

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

Line: 332 to 346

Setting Preferences

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:

Set VARIABLENAME = value

Creating Custom Variables

Line: 340 to 354

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.

Changed:

<<

Example: Create a custom logo variable

>>

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

TWiki Variables

TWiki Variables

>>

TWiki Variables

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

Overview

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!

Changed:

<<

Predefined Variables

>>

Predefined Variables

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: 214 to 218

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

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

Changed:

<<

Setting Preferences

>>

Setting Preferences

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

Changed:

<<

Creating Custom Variables

>>

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.

TWiki Variables

Line: 334 to 334

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.

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

TWiki Variables

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!

Predefined Variables

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.

TWiki expands the following variables enclosed in % percent signs:

Changed:

<<

Variable:

Expanded to:

>>

Variable:

Expanded to:

%WIKIHOMEURL%

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

Line: 203 to 206

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

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

Deleted:

<<

Added:

>>

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

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

Changed:

<<

Setting Variable Preferences

>>

Setting Preferences

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

Creating Custom Variables

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

TWiki Variables

Deleted:

<<

About Variables

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.

Predefined Variables

TWiki Variables

About Variables

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.

Predefined Variables

Line: 24 to 24

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

%SCRIPTSUFFIX%

Changed:

<<

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

>>

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

%PUBURL%

The public URL of TWiki, is http://fpmac116.usc.es/twiki/pub

Line: 39 to 39

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

%URLPARAM{"name"}%

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

%WIKITOOLNAME%

Name of wiki tool, is TWiki

%WIKIVERSION%

Changed:

<<

Wiki tool version, is 04 Sep 2004 $Rev: 1742 $

>>

Wiki tool version is 04 Sep 2004 $Rev: 1742 $

%USERNAME%

Changed:

<<

Your login username, is guest

>>

Your login username is guest

%WIKINAME%

Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is guest

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

>>

The web containing all documentation and configuration of TWiki is TWiki

%WEB%

Changed:

<<

The current web, is TWiki

>>

The current web is TWiki

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

Line: 320 to 320

SL , WL

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

Changed:

<<

Setting and Creating New Preferences

>>

Setting Variable Preferences

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

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

TWiki Variables

About Variables

Predefined Variables

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

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

TWiki Variables

Predefined Variables

If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the %STOPINCLUDE% variable itself.

%TOC%

Changed:

<<

Table of Content of current topic.

>>

Table of Contents of current topic.

%TOC{"SomeTopic" ...}%

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:

TWiki Variables

Predefined Variables

Line: 171 to 171

Table of Content of current topic.

%TOC{"SomeTopic" ...}%

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:

TWiki Variables

Predefined Variables

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.

TWiki Variables

Predefined Variables

Line: 72 to 72

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

%TOPICLIST{"format"}%

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:

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:

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:

"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: 132 to 144

Table of Content of current topic.

%TOC{"SomeTopic" ...}%

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:

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:

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

required

search="text"

(Alternative to above)

N/A

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

Line: 212 to 226

SL , UL

Vertical size of edit box, is 15

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:

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

Line: 256 to 278

Additional preferences variables can be defined on all three level as needed. Example:

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/"}%

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

Line: 134 to 138

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]

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

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.

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.

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:

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

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.

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

Exclude web from a web="all" search (set variable to on for hidden webs)

%EDITBOXWIDTH%

SL , UL

Horizontal size of edit box, is 70

Line: 118 to 128

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

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:

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

%SCRIPTURL%

The script URL of TWiki, is http://fpmac116.usc.es/twiki/bin

Line: 45 to 45

%DATE%

Todays date, is 15 Sep 2019

Added:

>>

%HTTP_HOST%

HTTP_HOST environment variable, is fpmac116.usc.es

%REMOTE_ADDR%

REMOTE_ADDR environment variable, is 3.226.243.10

%REMOTE_PORT%

REMOTE_PORT environment variable, is 49914

%REMOTE_USER%

REMOTE_USER environment variable, is

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

Line: 98 to 110

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:

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: