<<O>>  Difference Topic TWikiVariables (r1.79 - 02 Mar 2006 - DmitryNPopov?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 95 to 95

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

 
Line: 207 to 207

Creating Custom Variables

Changed:
<
<
  • 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.
>
>
  • You can add your own Preference Variables for us across an entire site or a single web, using the standard #SettingPrefsPreferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.

Example: Create a custom logo variable the TWiki web
Changed:
<
<
  • 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:
>
>
  • 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 FileAttachmentattaching? the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, ex: LogoTopic:

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
 <<O>>  Difference Topic TWikiVariables (r1.78 - 14 Aug 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 6 to 6

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.

Predefined Variables

Line: 18 to 20

This version of TWiki - 04 Sep 2004 $Rev: 1742 $ - expands the following variables (enclosed in % percent signs):

Changed:
<
<

ATTACHURL -- attachment URL of the current topic

ATTACHURLPATH -- path of the attachment URL of the current topic

BASETOPIC -- base topic where an INCLUDE started

  • The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE
  • Syntax: %BASETOPIC%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC

BASEWEB -- base web where an INCLUDE started

  • 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.
  • Syntax: %BASEWEB%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 13:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string

  • Syntax: %ENCODE{"string"}%
  • Supported parameters:
    Parameter: Description: Default:
    "string" String to encode required (can be empty)
    type="entity" 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"}% expands to spaced%20name
  • Related: URLPARAM

GMTIME -- GM time

GMTIME{"format"} -- formatted GM time

  • Syntax: %GMTIME{"format"}%
  • Supported variables:
    Variable: Unit: Example
    $seconds seconds 59
    $minutes minutes 59
    $hours hours 23
    $day day of month 31
    $wday day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) Thu
    $month month in ISO format Dec
    $mo 2 digit month 12
    $year 4 digit year 1999
    $ye 2 digit year 99
    $tz either "GMT" (if set to gmtime), or "Local" (if set to servertime) GMT
    $iso ISO format timestamp 2014-07-31T13:31Z
    $rcs RCS format timestamp 2014/07/31 13:31:36
    $http E-mail & http format timestamp Thu, 31 Jul 2014 13:31:36 GMT
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 31 Jul, 2014 - 13:31:36
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

HTTP_HOST -- environment variable

ICON{"type"} -- small icon of common attachment types

  • Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
  • Syntax: %ICON{"type"}%
  • Samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
  • Example: %ICON{"pdf"}% expands to
  • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics

INCLUDE{"page"} -- include other topics or web pages

  • Syntax: %INCLUDE{"page" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%  
    "Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
    "http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%  
    pattern="..." A RegularExpression pattern to include a subset of a topic or page none
    rev="1.2" Include a previous topic revision; N/A for URLs top revision
    warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, IncludeTopicsAndWebPages

INCLUDINGTOPIC -- name of topic that includes current topic

  • The name of the topic that includes the current topic - same as %TOPIC% in case there is no include
  • Syntax: %INCLUDINGTOPIC%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

INCLUDINGWEB -- web that includes current topic

  • The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
  • Syntax: %INCLUDINGWEB%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

MAINWEB -- name of Main web

METASEARCH -- special search of meta data

  • Syntax: %METASEARCH{...}%
  • Supported parameters:
    Parameter: Description: Default:
    type="topicmoved" 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: "}%
  • Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
    %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
  • Related: SEARCH

NOTIFYTOPIC -- name of the notify topic

PUBURL -- the base URL of attachments

  • Syntax: %PUBURL%
  • Expands to: http://www.auai.org/twiki/pub
  • Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
  • Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

PUBURLPATH -- the base URL path of attachments

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

SCRIPTURL -- script URL of UAIWiki

  • Syntax: %SCRIPTURL%
  • Expands to: http://www.auai.org/cgi-bin/twiki
  • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://www.auai.org/cgi-bin/twiki/viewauth/TWiki/TWikiVariables
  • Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of UAIWiki

SCRIPTSUFFIX -- script suffix

  • Some UAIWiki installations require a file extension for CGI scripts like .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTURL

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters: [1]
    Parameter: Description: Default:
    "text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more 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 comma, or all webs. [2] Current web
    topic="WebPreferences"
    topic="*Bug"
    Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
    excludetopic="Web*"
    excludetopic="WebHome, WebChanges"
    Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
    type="keyword"
    type="literal"
    type="regex"
    Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
    scope="topic"
    scope="text"
    scope="all"
    Search topic name (title); the text (body) of topic; or all (both) "text"
    order="topic"
    order="created"
    order="modified"
    order="editby"
    order=
     "formfield(name)"
    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
    reverse="on" Reverse the direction of the search Ascending search
    casesensitive="on" Case sensitive search Ignore case
    nosummary="on" Show topic title only Show topic summary
    bookview="on" BookView search, e.g. show complete topic text Show topic summary
    nosearch="on" Suppress search string Show search string
    noheader="on" Suppress search header
    Topics: Changed: By:
    Show search header
    nototal="on" Do not show number of topics found Show number
    header="..."
    format="..."
    Custom format results: see FormattedSearch for usage, variables & examples Results in table
    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"
  • Example: %SEARCH{"wiki" web="Main" scope="topic"}%
  • Example with format: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
  • HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
  • Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch

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

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 06:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SPACEDTOPIC -- topic name, spaced and encoded

  • The current topic name with added spaces, for regular expression search of Ref-By
  • Syntax: %SPACEDTOPIC%
  • Expands to: TWiki%20*Variables
  • Related: TOPIC

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.
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, STOPINCLUDE

STATISTICSTOPIC -- name of statistics topic

STOPINCLUDE -- end position of topic text if included

  • 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.
  • Syntax: %STOPINCLUDE%
  • Related: INCLUDE, STARTINCLUDE

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
  • Supported parameters:
    Parameter: Description: Default:
    "TopicName" topic name Current topic
    web="Name" Name of web Current web
    depth="2" Limit depth of headings shown in TOC 6
    title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
  • Related: TOC

TOPIC -- name of current topic

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.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    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
  • Example: %TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics
  • Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
  • Example: %TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
  • Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

  • The web containing all documentation and site-wide preference settings for UAIWiki
  • Syntax: %TWIKIWEB%
  • Expands to: TWiki
  • Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
  • Syntax: %URLPARAM{"name"}%
  • Supported parameters:
    Parameter: Description: Default:
    "name" The name of a URL parameter required
    default="..." Default value in case parameter is empty or missing empty string
    newline="<br />" Convert newlines in textarea to other delimiters no conversion
    encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
    multiple="on"
    multiple="[[$item]]"
    If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" first element
    separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)
  • Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Test this:
  • Related: SEARCH, FormattedSearch

USERNAME -- your login username

VAR{"NAME" web="Web"} -- get a preference value from another web

  • Syntax: %VAR{"NAME" web="Web"}%
  • Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #999966
  • Related: WEBPREFSTOPIC

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.
  • Syntax: %WEBLIST{"format" ...}%
  • Supported parameters:
    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)
    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="%WEB%" Current value to be selected in list section="%WEB%"
  • Example: %WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
  • Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

  • The base URL of UAIWiki, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: http://uai.cs.ubc.ca/twiki
  • Related: WIKITOOLNAME

WIKINAME -- your Wiki username

WIKIPREFSTOPIC -- name of site-wide preferences topic

WIKITOOLNAME -- name of your TWiki site

WIKIUSERNAME -- your Wiki username with web prefix

  • Your %WIKINAME% with Main web prefix, useful to point to your UAIWiki home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Main.TWikiGuest, renders as TWikiGuest
  • Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: TWikiUsers, with Main prefix renders as TWikiUsers
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

  • Syntax: %WIKIVERSION%
  • Expands to: 04 Sep 2004 $Rev: 1742 $
  • Related: WIKITOOLNAME
>
>

ATTACHURL -- full URL for attachments in the current topic

ATTACHURLPATH -- path of the attachment URL of the current topic

BASETOPIC -- base topic where an INCLUDE started

  • The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE
  • Syntax: %BASETOPIC%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC

BASEWEB -- base web where an INCLUDE started

  • 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.
  • Syntax: %BASEWEB%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 13:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string

  • Syntax: %ENCODE{"string"}%
  • Supported parameters:
    Parameter: Description: Default:
    "string" String to encode required (can be empty)
    type="entity" 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"}% expands to spaced%20name
  • Related: URLPARAM

FORMFIELD{"format"} -- renders a field in the form attached to some topic

  • Syntax: %FORMFIELD{"fieldname"}%
  • Supported parameters:
    Parameter: Description: Default:
    "fieldname" The name of a TWiki form field required
    topic="..." Topic where form data is located. May be of the form Web.TopicName Current topic
    format="..." Format string. $value expands to the field value "$value"
    default="..." Text shown when no value is defined for the field ""
    alttext="..." Text shown when field is not found in the form ""
  • Example: %FORMFIELD{"ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field found"}%
  • Related: SEARCH

GMTIME -- GM time

GMTIME{"format"} -- formatted GM time

  • Syntax: %GMTIME{"format"}%
  • Supported variables:
    Variable: Unit: Example
    $seconds seconds 59
    $minutes minutes 59
    $hours hours 23
    $day day of month 31
    $wday day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) Thu
    $month month in ISO format Dec
    $mo 2 digit month 12
    $year 4 digit year 1999
    $ye 2 digit year 99
    $tz either "GMT" (if set to gmtime), or "Local" (if set to servertime) GMT
    $iso ISO format timestamp 2014-07-31T13:31Z
    $rcs RCS format timestamp 2014/07/31 13:31:37
    $http E-mail & http format timestamp Thu, 31 Jul 2014 13:31:37 GMT
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 31 Jul, 2014 - 13:31:37
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

HTTP_HOST -- environment variable

ICON{"type"} -- small icon of common attachment types

  • Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
  • Syntax: %ICON{"type"}%
  • Samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
  • Example: %ICON{"pdf"}% expands to
  • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics

INCLUDE{"page"} -- include other topics or web pages

  • Syntax: %INCLUDE{"page" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%  
    "Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
    "http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
    Note if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.
     
    pattern="..." A RegularExpression pattern to include a subset of a topic or page none
    rev="1.2" Include a previous topic revision; N/A for URLs top revision
    warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, IncludeTopicsAndWebPages, STARTINCLUDE, STOPINCLUDE,

INCLUDINGTOPIC -- name of topic that includes current topic

  • The name of the topic that includes the current topic - same as %TOPIC% in case there is no include
  • Syntax: %INCLUDINGTOPIC%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

INCLUDINGWEB -- web that includes current topic

  • The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
  • Syntax: %INCLUDINGWEB%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

MAINWEB -- name of Main web

METASEARCH -- special search of meta data

  • Syntax: %METASEARCH{...}%
  • Supported parameters:
    Parameter: Description: Default:
    type="topicmoved" 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. current web
    topic="%TOPIC%" The topic the search relates to current topic
    title="Title" Text that is prefixed to any search results empty
    default="none" Default text shown if no search hit empty
  • Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
  • Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
    %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
  • Related: SEARCH

NOTIFYTOPIC -- name of the notify topic

PLUGINVERSION -- the version of the TWiki Plugin API

PLUGINVERSION{"name"} -- the version of an installed Plugin

  • Syntax: %PLUGINVERSION{"name"}%
  • Example: %PLUGINVERSION{"DefaultPlugin"}% expands to 1.021
  • Related: PLUGINVERSION, WIKIVERSION

PUBURL -- the base URL of attachments

  • Syntax: %PUBURL%
  • Expands to: http://www.auai.org/twiki/pub
  • Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
  • Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

PUBURLPATH -- the base URL path of attachments

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

REVINFO -- revision information of current topic

REVINFO{"format"} -- formatted revision information of topic

  • Syntax: %REVINFO{"format"}%
  • Supported parameters:
    Parameter: Description: Default:
    "format" Format of revision information, see supported variables below "r1.$rev - $date - $wikiusername"
    web="..." Name of web Current web
    topic="..." Topic name Current topic
    rev="1.5" Specific revison number Latest revision
  • Supported variables in format:
    Variable: Unit: Example
    $web Name of web Current web
    $topic Topic name Current topic
    $rev Revison number. Prefix r1. to get the usual r1.5 format 5
    $date Revision date 11 Jul 2004
    $username Login username of revision jsmith
    $wikiname WikiName of revision JohnSmith
    $wikiusername WikiName with Main web prefix Main.JohnSmith
  • Example: %REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
  • Related: REVINFO

SCRIPTURL -- script URL of UAIWiki

  • Syntax: %SCRIPTURL%
  • Expands to: http://www.auai.org/cgi-bin/twiki
  • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://www.auai.org/cgi-bin/twiki/viewauth/TWiki/TWikiVariablesNtoZ
  • Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of UAIWiki

SCRIPTSUFFIX -- script suffix

  • Some UAIWiki installations require a file extension for CGI scripts like .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTURL

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters: [1]
    Parameter: Description: Default:
    "text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more 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 comma, or all webs. [2] Current web
    topic="WebPreferences"
    topic="*Bug"
    Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
    excludetopic="Web*"
    excludetopic="WebHome, WebChanges"
    Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
    type="keyword"
    type="literal"
    type="regex"
    Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
    scope="topic"
    scope="text"
    scope="all"
    Search topic name (title); the text (body) of topic; or all (both) "text"
    order="topic"
    order="created"
    order="modified"
    order="editby"
    order=
     "formfield(name)"
    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 All results
    reverse="on" Reverse the direction of the search Ascending search
    casesensitive="on" Case sensitive search Ignore case
    nosummary="on" Show topic title only Show topic summary
    bookview="on" BookView search, e.g. show complete topic text Show topic summary
    nosearch="on" Suppress search string Show search string
    noheader="on" Suppress search header
    Topics: Changed: By:
    Show search header
    nototal="on" Do not show number of topics found Show number
    header="..."
    format="..."
    Custom format results: see FormattedSearch for usage, variables & examples Results in table
    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"
  • Example: %SEARCH{"wiki" web="Main" scope="topic"}%
  • Example with format: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
  • HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
  • Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch

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

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 06:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SPACEDTOPIC -- topic name, spaced and encoded

  • The current topic name with added spaces, for regular expression search of Ref-By
  • Syntax: %SPACEDTOPIC%
  • Expands to: TWiki%20*Variables%20*Nto%20*Z
  • Related: TOPIC

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.
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, STOPINCLUDE

STATISTICSTOPIC -- name of statistics topic

STOPINCLUDE -- end position of topic text if included

  • 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.
  • Syntax: %STOPINCLUDE%
  • Related: INCLUDE, STARTINCLUDE

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
  • Supported parameters:
    Parameter: Description: Default:
    "TopicName" topic name Current topic
    web="Name" Name of web Current web
    depth="2" Limit depth of headings shown in TOC 6
    title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
  • Example: see TWiki:Sandbox.TestTopicInclude
  • Related: TOC

TOPIC -- name of current topic

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.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    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
  • Example: %TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics
  • Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
  • Example: %TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
  • Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

  • The web containing all documentation and site-wide preference settings for UAIWiki
  • Syntax: %TWIKIWEB%
  • Expands to: TWiki
  • Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
  • Syntax: %URLPARAM{"name"}%
  • Supported parameters:
    Parameter: Description: Default:
    "name" The name of a URL parameter required
    default="..." Default value in case parameter is empty or missing empty string
    newline="<br />" Convert newlines in textarea to other delimiters no conversion
    encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
    multiple="on"
    multiple="[[$item]]"
    If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" first element
    separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)
  • Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariablesNtoZ?skin=print URL. Test this:
  • Related: SEARCH, FormattedSearch

USERNAME -- your login username

VAR{"NAME" web="Web"} -- get a preference value from another web

  • Syntax: %VAR{"NAME" web="Web"}%
  • Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #999966
  • Related: WEBPREFSTOPIC

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.
  • Syntax: %WEBLIST{"format" ...}%
  • Supported parameters:
    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)
    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="%WEB%" Current value to be selected in list section="%WEB%"
  • Example: %WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
  • Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

  • The base URL of UAIWiki, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: http://uai.cs.ubc.ca/twiki
  • Related: WIKITOOLNAME

WIKINAME -- your Wiki username

WIKIPREFSTOPIC -- name of site-wide preferences topic

WIKITOOLNAME -- name of your TWiki site

WIKIUSERNAME -- your Wiki username with web prefix

  • Your %WIKINAME% with Main web prefix, useful to point to your UAIWiki home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Main.TWikiGuest, renders as TWikiGuest
  • Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: TWikiUsers, with Main prefix renders as TWikiUsers
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

Note: Above text is included from TWikiVariablesAtoM and TWikiVariablesNtoZ


Preferences Variables

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

Changed:
<
<
Variable: Level: What:
>
>
Variable: Level: What: Expands to:

%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
Added:
>
>
RealMembersGroup,Main.TWikiAdminGroup  

%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
Added:
>
>
TWikiAdminGroup  

%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the UAIWiki web. (More in TWikiAccessControl)
Added:
>
>
RealMembersGroup, TWikiAdminGroup  

%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the UAIWiki web. (More in TWikiAccessControl)
Added:
>
>
TWikiAdminGroup  

%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 UAIWiki web. (More in TWikiAccessControl)
Added:
>
>
SpamGroup  

%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the UAIWiki web. (More in TWikiAccessControl)
Added:
>
>
SpamGroup,Main.RealMembersGroup  

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

%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
Added:
>
>
17  

%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
Added:
>
>
70  

%EDITBOXSTYLE% SL , UL Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
Added:
>
>
width: 99%  

%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
Added:
>
>
ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME  

%HTTP_EQUIV_ON_EDIT% SL , UL http-equiv meta tags for edit script.
Added:
>
>
 

%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.
Added:
>
>
 

%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
Added:
>
>
 

%NEWTOPICBGCOLOR% SL , UL Background color of non existing topic. ( UL needs authentication for topic views )
Added:
>
>
#FFFFCE  

%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views )
Added:
>
>
#0000FF  

%NOSEARCHALL% WL 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:
Added:
>
>
 

%WEBBGCOLOR% WL Background color of web
Added:
>
>
#FFD8AA  

%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
Added:
>
>
Copyright © 1999-2014 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding UAIWiki? Send feedback  

%WEBTOPICLIST% WL Common links of web (second line of topics)
Added:
>
>
Welcome | Register | Changes | Topics | Index | Search | Go  

%WIKIWEBLIST% SL List of UAIWiki webs (in upper right corner of topics)
Added:
>
>
WebHomeUAI? Wiki | WebHomeHelp?  

%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is uaiwebmaster@gmail.com
Added:
>
>
uaiwebmaster@gmail.com  

Line: 600 to 215

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed:
<
<
-- TWiki:Main.PeterThoeny - 09 May 2004
>
>
-- TWiki:Main.PeterThoeny - 14 Aug 2004

-- TWiki:Main.MikeMannix - 12 May 2002
Added:
>
>

Crawford split up this topic into included TWikiVariablesAtoM and TWikiVariablesNtoZ.

-- PeterThoeny - 26 Jul 2004


 <<O>>  Difference Topic TWikiVariables (r1.77 - 09 May 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 18 to 18

This version of TWiki - 04 Sep 2004 $Rev: 1742 $ - expands the following variables (enclosed in % percent signs):

Changed:
<
<
Variable: Expanded to:
%WIKIHOMEURL% The base script URL of UAIWiki, is the link of the Home icon in the upper left corner, is http://uai.cs.ubc.ca/twiki
%SCRIPTURL% The script URL of UAIWiki, is http://www.auai.org/cgi-bin/twiki
%SCRIPTURLPATH% The path of the script URL of UAIWiki, is /cgi-bin/twiki
%SCRIPTSUFFIX% The script suffix, ex: .pl, .cgi is
%PUBURL% The public URL of TWiki, is http://www.auai.org/twiki/pub
Example: You can refer to a file attached to another topic as %PUBURL%/%WEB%/OtherTopic/image.gif
%PUBURLPATH% The path of the public URL of UAIWiki, is /twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://www.auai.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}% Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:
Parameter: Description: Default:
"name" The name of a URL parameter required
default="..." Default value in case parameter is empty or missing empty string
newline="<br />" Convert newlines in textarea to other delimiters no conversion
encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
multiple="on"
multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" first element
separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%ENCODE{"string"}% Encodes a string. Supported parameters:
>
>

ATTACHURL -- attachment URL of the current topic

ATTACHURLPATH -- path of the attachment URL of the current topic

BASETOPIC -- base topic where an INCLUDE started

  • The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE
  • Syntax: %BASETOPIC%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC

BASEWEB -- base web where an INCLUDE started

  • 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.
  • Syntax: %BASEWEB%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 13:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string

  • Syntax: %ENCODE{"string"}%
  • Supported parameters:

Parameter: Description: Default:
"string" String to encode required (can be empty)
type="entity" 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)
Changed:
<
<
Example: %ENCODE{"spaced name"}% returns spaced%20name
%WIKITOOLNAME% The name of your TWiki site - UAIWiki
%WIKIVERSION% Your current TWiki version - 04 Sep 2004 $Rev: 1742 $
%USERNAME% Your login username - guest
%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME% Your %WIKINAME% including the Main web name - always use full signatures - Main.TWikiGuest
%MAINWEB% The web containing TWikiUsers, OfficeLocations and TWikiGroups is Main
%TWIKIWEB% The web containing all documentation and site-wide preference settings for UAIWiki - TWiki
%WEB% 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.
%INCLUDINGWEB% The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
%HOMETOPIC% The home topic in each web - WebHome
%NOTIFYTOPIC% The notify topic in each web - WebNotify
%WIKIUSERSTOPIC% The index topic of all registered users - TWikiUsers
%WIKIPREFSTOPIC% The site-wide preferences topic - TWikiPreferences
%WEBPREFSTOPIC% The local web preferences topic in each web - WebPreferences
%STATISTICSTOPIC% The web statistics topic WebStatistics
%TOPIC% The current topic name - TWikiVariables
%BASETOPIC% 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:
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
Examples:
%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).
%WEBLIST{"format"}% 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:
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)
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="%WEB%" Current value to be selected in list section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME% GM time, is 31 Jul 2014 - 13:31
%GMTIME{"format"}% Formatted GM time based on time variables.
>
>
  • Example: %ENCODE{"spaced name"}% expands to spaced%20name
  • Related: URLPARAM

GMTIME -- GM time

GMTIME{"format"} -- formatted GM time

  • Syntax: %GMTIME{"format"}%
  • Supported variables:

Variable: Unit: Example
$seconds seconds 59
$minutes minutes 59
Line: 177 to 91

$iso ISO format timestamp 2014-07-31T13:31Z
$rcs RCS format timestamp 2014/07/31 13:31:39
$http E-mail & http format timestamp Thu, 31 Jul 2014 13:31:39 GMT
Changed:
<
<
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Jul, 2014 - 13:31:39
%SERVERTIME% Server time, is 31 Jul 2014 - 06:31
%SERVERTIME{"format"}% Formatted server time. Same format qualifiers as %GMTIME%
Example: %SERVERTIME{"$hou:$min"}% is 06:31
%DISPLAYTIME% Display time, is 31 Jul 2014 - 13:31
%DISPLAYTIME{"format"}% Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
Example: %DISPLAYTIME{"$hou:$min"}% is 13:31
%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 54.242.18.190
%REMOTE_PORT% REMOTE_PORT environment variable, is
%REMOTE_USER% REMOTE_USER environment variable, is
%INCLUDE{"page" ...}% Server side include to IncludeTopicsAndWebPages:
>
>
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 31 Jul, 2014 - 13:31:39
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

HTTP_HOST -- environment variable

ICON{"type"} -- small icon of common attachment types

  • Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
  • Syntax: %ICON{"type"}%
  • Samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
  • Example: %ICON{"pdf"}% expands to
  • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics

INCLUDE{"page"} -- include other topics or web pages

  • Syntax: %INCLUDE{"page" ...}%
  • Supported parameters:

Parameter: Description: Default:
"SomeTopic" The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%  
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
Line: 212 to 126

pattern="..." A RegularExpression pattern to include a subset of a topic or page none
rev="1.2" Include a previous topic revision; N/A for URLs top revision
warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting
Changed:
<
<
%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.
%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:
>
>

INCLUDINGTOPIC -- name of topic that includes current topic

  • The name of the topic that includes the current topic - same as %TOPIC% in case there is no include
  • Syntax: %INCLUDINGTOPIC%
  • Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

INCLUDINGWEB -- web that includes current topic

  • The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.
  • Syntax: %INCLUDINGWEB%
  • Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

MAINWEB -- name of Main web

METASEARCH -- special search of meta data

  • Syntax: %METASEARCH{...}%
  • Supported parameters:

Parameter: Description: Default:
Changed:
<
<
"TopicName" topic name Current topic
web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
title="Some text" Title to appear at top of TOC none
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
>
>
type="topicmoved" 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: "}%
  • Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
    %METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
  • Related: SEARCH

NOTIFYTOPIC -- name of the notify topic

PUBURL -- the base URL of attachments

  • Syntax: %PUBURL%
  • Expands to: http://www.auai.org/twiki/pub
  • Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
  • Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

PUBURLPATH -- the base URL path of attachments

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

SCRIPTURL -- script URL of UAIWiki

  • Syntax: %SCRIPTURL%
  • Expands to: http://www.auai.org/cgi-bin/twiki
  • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://www.auai.org/cgi-bin/twiki/viewauth/TWiki/TWikiVariables
  • Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of UAIWiki

SCRIPTSUFFIX -- script suffix

  • Some UAIWiki installations require a file extension for CGI scripts like .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTURL

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters: [1]

Parameter: Description: Default:
"text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more 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 comma, or all webs. [2] Current web
topic="WebPreferences"
topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
excludetopic="Web*"
excludetopic="WebHome, WebChanges"
Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
Changed:
<
<
type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting
>
>
type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting (literal)

scope="topic"
scope="text"
scope="all"
Search topic name (title); the text (body) of topic; or all (both) "text"
order="topic"
order="created"
order="modified"
order="editby"
order=
 "formfield(name)"
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)
HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
%METASEARCH{...}% Special search of meta data
>
>
  • Example: %SEARCH{"wiki" web="Main" scope="topic"}%
  • Example with format: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
  • HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
  • Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch

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

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 06:31
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SPACEDTOPIC -- topic name, spaced and encoded

  • The current topic name with added spaces, for regular expression search of Ref-By
  • Syntax: %SPACEDTOPIC%
  • Expands to: TWiki%20*Variables
  • Related: TOPIC

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.
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, STOPINCLUDE

STATISTICSTOPIC -- name of statistics topic

STOPINCLUDE -- end position of topic text if included

  • 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.
  • Syntax: %STOPINCLUDE%
  • Related: INCLUDE, STARTINCLUDE

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

Parameter: Description: Default:
Changed:
<
<
type="topicmoved" 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 #999966
>
>
"TopicName" topic name Current topic
web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
title="Some text" Title to appear at top of TOC none
  • Example: %TOC{depth="2"}%
  • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
  • Related: TOC

TOPIC -- name of current topic

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.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    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
  • Example: %TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics
  • Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
  • Example: %TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
  • Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

  • The web containing all documentation and site-wide preference settings for UAIWiki
  • Syntax: %TWIKIWEB%
  • Expands to: TWiki
  • Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
  • Syntax: %URLPARAM{"name"}%
  • Supported parameters:
    Parameter: Description: Default:
    "name" The name of a URL parameter required
    default="..." Default value in case parameter is empty or missing empty string
    newline="<br />" Convert newlines in textarea to other delimiters no conversion
    encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
    multiple="on"
    multiple="[[$item]]"
    If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" first element
    separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)
  • Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Test this:
  • Related: SEARCH, FormattedSearch

Changed: <
<
[1] Note: The search form uses identical names for input fields. >
>

USERNAME -- your login username

VAR{"NAME" web="Web"} -- get a preference value from another web

  • Syntax: %VAR{"NAME" web="Web"}%
  • Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #999966
  • Related: WEBPREFSTOPIC

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.
  • Syntax: %WEBLIST{"format" ...}%
  • Supported parameters:
    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)
    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="%WEB%" Current value to be selected in list section="%WEB%"
  • Example: %WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
  • Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

  • The base URL of UAIWiki, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: http://uai.cs.ubc.ca/twiki
  • Related: WIKITOOLNAME

WIKINAME -- your Wiki username

WIKIPREFSTOPIC -- name of site-wide preferences topic

WIKITOOLNAME -- name of your TWiki site

WIKIUSERNAME -- your Wiki username with web prefix

  • Your %WIKINAME% with Main web prefix, useful to point to your UAIWiki home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Main.TWikiGuest, renders as TWikiGuest
  • Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: TWikiUsers, with Main prefix renders as TWikiUsers
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

  • Syntax: %WIKIVERSION%
  • Expands to: 04 Sep 2004 $Rev: 1742 $
  • Related: WIKITOOLNAME

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

Preferences Variables

Line: 292 to 448
Variable: Level: What:
Changed: <
<
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is uaiwebmaster@gmail.com
%WIKIWEBLIST% SL List of UAIWiki webs (in upper right corner of topics)
%WEBTOPICLIST%
>
>
%ALLOWTOPICCHANGE% (any topic) 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 UAIWiki 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 UAIWiki 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)
%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 )
%EDITBOXWIDTH%
>
>
List of users and groups who are not allowed to change topics in the UAIWiki web. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the UAIWiki web. (More in TWikiAccessControl)
%DONTNOTIFYCHECKBOX%

SL , UL
Changed: <
<
Horizontal size of edit box, is 70
>
>
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:

%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
Changed: <
< >
>
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70

%EDITBOXSTYLE% SL , UL Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
Changed: <
<
%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:
%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 UAIWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the UAIWiki web. (More in TWikiAccessControl)
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%DENYWEBRENAME%
>
>
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%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 )
%NOSEARCHALL%

WL
Changed: <
<
List of users and groups who are not allowed to rename topics in the UAIWiki 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 UAIWiki 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
>
>
Copyright notice (bottom right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WIKIWEBLIST% SL List of UAIWiki webs (in upper right corner of topics)
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is uaiwebmaster@gmail.com

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

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed: <
< -- TWiki:Main.PeterThoeny - 16 Mar 2004
>
> -- TWiki:Main.PeterThoeny - 09 May 2004

-- TWiki:Main.MikeMannix - 12 May 2002
 <<O>>  Difference Topic TWikiVariables (r1.76 - 01 Apr 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 8 to 8

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.

 <<O>>  Difference Topic TWikiVariables (r1.75 - 17 Mar 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 52 to 52

Parameter: Description: Default:
"name" The name of a URL parameter required
default="..." Default value in case parameter is empty or missing empty string
Changed:
<
<
newline="<br />" Convert newlines to other delimiters no conversion
>
>
newline="<br />" Convert newlines in textarea to other delimiters no conversion

encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
Added:
>
>
multiple="on"
multiple="[[$item]]"
If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" first element
separator=", " Separator between multiple selections. Only relevant if multiple is specified "\n" (new line)

Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
Line: 160 to 162

%GMTIME{"format"}% Formatted GM time based on time variables.
Variable: Unit: Example
Changed:
<
<
$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
>
>
$seconds seconds 59
$minutes minutes 59
$hours hours 23
$day day of month 31
$wday day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) Thu
$month month in ISO format Dec
$mo 2 digit month 12
$year 4 digit year 1999
$ye 2 digit year 99
$tz either "GMT" (if set to gmtime), or "Local" (if set to servertime) GMT
$iso ISO format timestamp 2014-07-31T13:31Z
$rcs RCS format timestamp 2014/07/31 13:31:41
$http E-mail & http format timestamp Thu, 31 Jul 2014 13:31:41 GMT

Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Jul, 2014 - 13:31:41
%SERVERTIME% Server time, is 31 Jul 2014 - 06:31
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 06:31
>
>
Formatted server time. Same format qualifiers as %GMTIME%
Example: %SERVERTIME{"$hou:$min"}% is 06:31
%DISPLAYTIME% Display time, is 31 Jul 2014 - 13:31
%DISPLAYTIME{"format"}% Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
Example: %DISPLAYTIME{"$hou:$min"}% is 13:31

%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
Line: 227 to 240

excludetopic="Web*"
excludetopic="WebHome, WebChanges"
Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting
scope="topic"
scope="text"
scope="all"
Search topic name (title); the text (body) of topic; or all (both) "text"
Changed:
<
<
order="topic"
order="modified"
order="editby"
order=
 "formfield(name)"
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
>
>
order="topic"
order="created"
order="modified"
order="editby"
order=
 "formfield(name)"
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

reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
Line: 237 to 250

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
Added:
>
>
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"
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
Line: 401 to 415

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed:
<
<
-- TWiki:Main.PeterThoeny - 14 Jan 2004
>
>
-- TWiki:Main.PeterThoeny - 16 Mar 2004

-- TWiki:Main.MikeMannix - 12 May 2002
 <<O>>  Difference Topic TWikiVariables (r1.74 - 19 Jan 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 47 to 47

%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
Changed:
<
<
%PARAM{"name"}%
>
>
%URLPARAM{"name"}%

Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:
Parameter: Description: Default:
"name" The name of a URL parameter required
Line: 55 to 55

newline="<br />" Convert newlines to other delimiters no conversion
encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
Changed:
<
<
Example: %PARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is %PARAM{"skin"}%
>
>
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is

%ENCODE{"string"}%
 <<O>>  Difference Topic TWikiVariables (r1.73 - 18 Jan 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 16 to 16

This version of TWiki - 04 Sep 2004 $Rev: 1742 $ - expands the following variables (enclosed in % percent signs):

Changed:
<
<
>
>

Variable: Expanded to:
Line: 196 to 196

"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%  
pattern="..." A RegularExpression pattern to include a subset of a topic or page none
rev="1.2" Include a previous topic revision; N/A for URLs top revision
Changed:
<
<
warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting
>
>
warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting

%STARTINCLUDE%
Line: 220 to 220

%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:
Changed:
<
<
"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
>
>
"text" Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more 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 comma, or all webs. [2] Current web
topic="WebPreferences"
topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
excludetopic="Web*"
excludetopic="WebHome, WebChanges"
Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
Changed:
<
<
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
>
>
type="keyword"
type="literal"
type="regex"
Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting
scope="topic"
scope="text"
scope="all"
Search topic name (title); the text (body) of topic; or all (both) "text"

order="topic"
order="modified"
order="editby"
order=
 "formfield(name)"
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
Deleted:
<
<
regex="on" RegularExpression search; also enables ";" as and Literal search

reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
Line: 239 to 239

header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
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:
<
<
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)
HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
Line: 273 to 273

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

Changed:
<
<
>
>

Variable: Level: What:
Line: 377 to 377

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

%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
Deleted:
<
<

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

Setting Preferences

 <<O>>  Difference Topic TWikiVariables (r1.72 - 16 Jan 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 47 to 47

%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
Changed:
<
<
%URLPARAM{"name"}% 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, default and newline:
>
>
%PARAM{"name"}% Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting. Supported parameters:

Parameter: Description: Default:
"name" The name of a URL parameter required
default="..." Default value in case parameter is empty or missing empty string
newline="<br />" Convert newlines to other delimiters no conversion
Changed:
<
<
Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
>
>
encode="entity" Encode special characters into HTML entities, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
Example: %PARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is %PARAM{"skin"}%

Changed:
<
<
%URLENCODE{"string"}% Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name
>
>
%ENCODE{"string"}% Encodes a string. Supported parameters:
Parameter: Description: Default:
"string" String to encode required (can be empty)
type="entity" 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 - UAIWiki
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:

Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
Changed:
<
<
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
>
>
title="Some text" Title to appear at top of TOC none
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%

%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
Line: 396 to 404

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed:
<
<
-- PeterThoeny - 19 Jan 2003
-- MikeMannix? - 12 May 2002
>
>
-- TWiki:Main.PeterThoeny - 14 Jan 2004
-- TWiki:Main.MikeMannix - 12 May 2002
 <<O>>  Difference Topic TWikiVariables (r1.71 - 10 Jan 2004 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 45 to 45

The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%ICON{"type"}%
Changed:
<
<
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
>
>
Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns

%URLPARAM{"name"}% 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, default and newline:
 <<O>>  Difference Topic TWikiVariables (r1.70 - 01 Nov 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 214 to 214

Parameter: Description: Default:
"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
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 comma, or all webs. [2] Current web
topic="WebPreferences"
topic="*Bug"
Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
excludetopic="Web*"
excludetopic="WebHome, WebChanges"
Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None

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 Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
 <<O>>  Difference Topic TWikiVariables (r1.69 - 29 Sep 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 48 to 48

Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Changed:
<
<
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 risk that this variable could be misused for cross-scripting. Parameters are name, default and newline:

Parameter: Description: Default:
"name" The name of a URL parameter required
default="..." Default value in case parameter is empty or missing empty string
Line: 227 to 227

noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
Added:
>
>
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"

Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
 <<O>>  Difference Topic TWikiVariables (r1.68 - 29 Aug 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 49 to 49

%URLPARAM{"name"}% 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:
Changed:
<
<
Parameter: Description:
"name" The name of a URL parameter
newline="<br />" Convert newlines to other delimiters
>
>
Parameter: Description: Default:
"name" The name of a URL parameter required
default="..." Default value in case parameter is empty or missing empty string
newline="<br />" Convert newlines to other delimiters no conversion

Example: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
 <<O>>  Difference Topic TWikiVariables (r1.67 - 23 Aug 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 188 to 188

"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%  
pattern="..." A RegularExpression pattern to include a subset of a topic or page none
rev="1.2" Include a previous topic revision; N/A for URLs top revision
Added:
>
>
warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) %INCLUDE- WARNING% preferences setting

%STARTINCLUDE%
 <<O>>  Difference Topic TWikiVariables (r1.66 - 23 Aug 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 48 to 48

Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns
%URLPARAM{"name"}%
Changed:
<
<
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:
Parameter: Description:
"name" The name of a URL parameter
newline="<br />" Convert newlines to other delimiters
Example: %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
 <<O>>  Difference Topic TWikiVariables (r1.65 - 30 Jun 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 44 to 44

%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
Added:
>
>
%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp, doc, gif, hlp, html, pdf, ppt, txt, wav, xml, zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns

%URLPARAM{"name"}% 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
 <<O>>  Difference Topic TWikiVariables (r1.64 - 22 Mar 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 377 to 377

  • 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:
    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
 <<O>>  Difference Topic TWikiVariables (r1.63 - 09 Feb 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 295 to 295

SL , UL Vertical size of edit box, is 17
Added:
>
>
%EDITBOXSTYLE% SL , UL Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%

%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:
 <<O>>  Difference Topic TWikiVariables (r1.62 - 27 Jan 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 246 to 246

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

Preferences Variables

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.61 - 19 Jan 2003 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 218 to 218

nototal="on" Do not show number of topics found Show number
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Changed:
<
<
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
>
>
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
HELP If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%

Line: 376 to 377

    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif
Changed:
<
<
-- PeterThoeny - 13 Sep 2001
>
>
-- PeterThoeny - 19 Jan 2003

-- MikeMannix? - 12 May 2002
 <<O>>  Difference Topic TWikiVariables (r1.60 - 11 Dec 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 173 to 173

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

%STARTINCLUDE%
Line: 213 to 216

nosearch="on" Suppress search string Show search string
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
Changed:
<
<
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
>
>
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table

Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"%(displays results in a table with header - details)
 <<O>>  Difference Topic TWikiVariables (r1.59 - 23 Nov 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 199 to 199

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

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 Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
Changed:
<
<
regex="on" RegularExpression search Literal search
>
>
regex="on" RegularExpression search; also enables ";" as and Literal search

reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
 <<O>>  Difference Topic TWikiVariables (r1.58 - 06 Oct 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 45 to 45

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 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:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value

Creating Custom Variables

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

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 135 to 135

selection="%WEB%" Current value to be selected in list section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
Changed:
<
<
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
>
>
%WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.

%GMTIME%
 <<O>>  Difference Topic TWikiVariables (r1.56 - 05 Jun 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 189 to 189

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

Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
 <<O>>  Difference Topic TWikiVariables (r1.55 - 24 May 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 354 to 354

Setting Preferences

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

  • Set VARIABLENAME = =value=
    • Set VARIABLENAME = =value=
 <<O>>  Difference Topic TWikiVariables (r1.54 - 17 May 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 33 to 33

The script suffix, ex: .pl, .cgi is
%PUBURL%
Changed:
<
<
The public URL of TWiki, is http://www.auai.org/twiki/pub
>
>
The public URL of TWiki, is http://www.auai.org/twiki/pub
Example: You can refer to a file attached to another topic as %PUBURL%/%WEB%/OtherTopic/image.gif

%PUBURLPATH% The path of the public URL of UAIWiki, is /twiki/pub
Line: 47 to 47

%URLPARAM{"name"}% Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
Added:
>
>
%URLENCODE{"string"}% Encodes a string for use as a URL parameter. Ex: %URLENCODE{"spaced name"}% returns spaced%20name

%WIKITOOLNAME% The name of your TWiki site - UAIWiki
 <<O>>  Difference Topic TWikiVariables (r1.53 - 15 May 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 172 to 172

%INCLUDE{"page" ...}% 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"}%
Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiSiteMap"}%
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%

"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
 <<O>>  Difference Topic TWikiVariables (r1.52 - 12 May 2002 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 172 to 172

%INCLUDE{"page" ...}% 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"}%
Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiSiteMap"}%

"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
Line: 196 to 196

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

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

-- PeterThoeny - 13 Sep 2001

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

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 172 to 172

%INCLUDE{"page" ...}% 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"}%
Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%

"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
 <<O>>  Difference Topic TWikiVariables (r1.50 - 08 Mar 2002 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 186 to 186

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

Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
Line: 366 to 366

-- PeterThoeny - 13 Sep 2001

Changed:
<
<
-- MikeMannix? - 23 Jan 2002
>
>
-- MikeMannix? - 07 Mar 2002
 <<O>>  Difference Topic TWikiVariables (r1.49 - 16 Feb 2002 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 200 to 200

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)
Changed:
<
<
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
>
>
order="topic"
order="modified"
order="editby"
order=
 "formfield(name)"
Sort the results of search by the topic names, last modified time, last editor, or named field of TWikiForms Sort by topic name

limit="all"
limit="16"
Limit the number of results returned All results
regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search
 <<O>>  Difference Topic TWikiVariables (r1.48 - 23 Jan 2002 - MikeMannix?)

META TOPICPARENT WebHome

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.

Line: 212 to 210

nosearch="on" Suppress search string Show search string
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
Changed:
<
<
format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
>
>
header="..."
format="..."
Custom format results: see FormattedSearch for usage, variables & examples Results in table
Regular example: %SEARCH{"wiki" web="Main" scope="topic"}%
Formatted example: %SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)

%METASEARCH{...}%
Line: 221 to 221

Parameter: Description: Default:
| 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: "}%
Line: 366 to 366

-- PeterThoeny - 13 Sep 2001

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

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 8 to 8

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:
<
<
UAIWiki expands the following variables (enclosed in % percent signs):
>
>
  • TIP Take the time to thoroughly read through ALL preference variables. If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see %INCLUDINGTOPIC%, %INCLUDE%, and the mighty %SEARCH%.

This version of TWiki - 04 Sep 2004 $Rev: 1742 $ - expands the following variables (enclosed in % percent signs):


Line: 48 to 50

Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME%
Changed:
<
<
Name of wiki tool, is UAIWiki
>
>
The name of your TWiki site - UAIWiki

%WIKIVERSION%
Changed:
<
<
Wiki tool version is 04 Sep 2004 $Rev: 1742 $
>
>
Your current TWiki version - 04 Sep 2004 $Rev: 1742 $

%USERNAME%
Changed:
<
<
Your login username is guest
>
>
Your login username - guest

%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME%
Changed:
<
<
Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
>
>
Your %WIKINAME% including the Main web name - always use full signatures - Main.TWikiGuest

%MAINWEB%
Changed:
<
<
The Main web containing TWikiUsers, OfficeLocations and TWikiGroups. Is Main
>
>
The web containing TWikiUsers, OfficeLocations and TWikiGroups is Main

%TWIKIWEB%
Changed:
<
<
The web containing all documentation and configuration of UAIWiki is TWiki
>
>
The web containing all documentation and site-wide preference settings for UAIWiki - TWiki

%WEB% The current web is TWiki
Line: 75 to 77

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%
Changed:
<
<
The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
>
>
The web name of the topic that includes the current topic - same as %WEB% if there is no INCLUDE.

%HOMETOPIC%
Changed:
<
<
The home topic in each web. Is WebHome
>
>
The home topic in each web - WebHome

%NOTIFYTOPIC%
Changed:
<
<
The notify topic in each web. Is WebNotify
>
>
The notify topic in each web - WebNotify

%WIKIUSERSTOPIC%
Changed:
<
<
The index topic of all registered users. Is TWikiUsers
>
>
The index topic of all registered users - TWikiUsers

%WIKIPREFSTOPIC%
Changed:
<
<
The web preferences topic. Is TWikiPreferences
>
>
The site-wide preferences topic - TWikiPreferences

%WEBPREFSTOPIC%
Changed:
<
<
The web preferences topic. Is WebPreferences
>
>
The local web preferences topic in each web - WebPreferences

%STATISTICSTOPIC%
Changed:
<
<
The web statistics topic. Is WebStatistics
>
>
The web statistics topic WebStatistics

%TOPIC%
Changed:
<
<
The current topic name, is TWikiVariables
>
>
The current topic name - TWikiVariables

%BASETOPIC%
Changed:
<
<
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
>
>
The name of the topic where a single or nested INCLUDE started - same as %TOPIC% if there is no INCLUDE.

%INCLUDINGTOPIC% The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
Line: 121 to 123


%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
Changed:
<
<
Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
>
>
Web index, ex: list of all webs. Hidden webs are excluded, e.g. webs with a NOSEARCHALL=on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.

Parameters are format, separator and web:
Parameter: Description: Default:
"format" Format of one line, may include $name variable "$name"
Line: 234 to 236

[1] Note: The search form uses identical names for input fields.
Changed:
<
<
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
>
>
[2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

Preferences Variables

Line: 349 to 351

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

Creating Custom Variables

Line: 363 to 366

-- PeterThoeny - 13 Sep 2001

Changed:
<
<
-- MikeMannix? - 30 Nov 2001
>
>
-- MikeMannix? - 05 Jan 2002
 <<O>>  Difference Topic TWikiVariables (r1.46 - 02 Dec 2001 - MikeMannix?)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 16 to 16

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

Changed:
<
<
>
>

Variable: Expanded to:
Line: 210 to 210

nosearch="on" Suppress search string Show search string
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
Added:
>
>
format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table

Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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?

%METASEARCH{...}% Special search of meta data
Parameter: Description: Default:
Line: 266 to 241

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

Changed:
<
<
>
>

Variable: Level: What:
Line: 377 to 352

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

Customizing Variables

>
>

Creating Custom Variables


Changed:
<
<
See: TWikiVariables Examples?
>
>
  • You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

Example: Create a custom logo variable
  • To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 13 Sep 2001
-- MikeMannix? - 30 Nov 2001

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

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 12 to 12

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.

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

Line: 205 to 205

regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
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

nosearch="on" Suppress search string Show search string
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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?

%METASEARCH{...}% Special search of meta data
Parameter: Description: Default:
Line: 235 to 260

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

Deleted:
<
<

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


Preferences Variables

Line: 354 to 377

  • 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):
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif
>
>
See: TWikiVariables Examples?

Deleted:
<
<
-- MikeMannix? - 30 Aug 2001

-- PeterThoeny - 13 Sep 2001
Added:
>
>
-- MikeMannix? - 30 Nov 2001
 <<O>>  Difference Topic TWikiVariables (r1.44 - 25 Oct 2001 - PeterThoeny)

META TOPICPARENT WebHome
TOC: No TOC in "TWiki.TWikiVariables"
Line: 205 to 205

regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
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

nosearch="on" Suppress search string Show search string
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
nototal="on" Do not show number of topics found Show number
Line: 233 to 235

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

Added:
>
>

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


Preferences Variables

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

META TOPICPARENT WebHome
Deleted:
<
<
Note: Included topic UtilTempDocNote? does not exist yet

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.

Changed:
<
<
UAIWiki expands the following variables enclosed in % percent signs:
>
>
UAIWiki expands the following variables (enclosed in % percent signs):

Changed:
<
<
>
>

Variable: Expanded to:
Line: 88 to 86

%WIKIUSERSTOPIC% The index topic of all registered users. Is TWikiUsers
Added:
>
>
%WIKIPREFSTOPIC% The web preferences topic. Is TWikiPreferences

%WEBPREFSTOPIC% The web preferences topic. Is WebPreferences
Line: 238 to 239

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

Changed:
<
<
>
>

Variable: Level: What:
Line: 353 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
  • 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.42 - 14 Sep 2001 - PeterThoeny)

META TOPICPARENT WebHome
Note: Included topic UtilTempDocNote? does not exist yet
Line: 356 to 356

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):
Changed:
<
<
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
>
>
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

-- MikeMannix? - 30 Aug 2001

Added:
>
>
-- PeterThoeny - 13 Sep 2001
 <<O>>  Difference Topic TWikiVariables (r1.41 - 13 Sep 2001 - JohnTalintyre?)
Added:
>
>
META TOPICPARENT WebHome

Note: Included topic UtilTempDocNote? does not exist yet

TOC: No TOC in "TWiki.TWikiVariables"

Line: 40 to 41

The path of the public URL of UAIWiki, is /twiki/pub
%ATTACHURL%
Changed:
<
<
The attachment URL of the current topic, is http://www.auai.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 http://www.auai.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif

%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
Line: 114 to 115

separator=", " line separator "\n" (new line)
web="Name" Name of web Current web
Examples:
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).

%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 gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection.
Line: 127 to 128

separator=", " line separator "\n" (new line)
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"
Changed:
<
<
selection Current value e.g. current for current Web, =section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
>
>
selection="%WEB%" Current value to be selected in list section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.


%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
Line: 147 to 148

$mo 2 digit month 12
$year 4 digit year 1999
$ye 2 digit year 99
Changed:
<
<
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Jul, 2014 - 13:31:50
>
>
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Jul, 2014 - 13:31:50

%SERVERTIME% Server time, is 31 Jul 2014 - 06:31
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 06:31
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 06:31

%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
Line: 196 to 197

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

regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text Show topic summary
nosearch="on" Suppress search string Show search string
Changed:
<
<
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
>
>
noheader="on" Suppress search header
Topics: Changed: By:
Show search header

nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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: "}%

%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 #999966
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):
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- MikeMannix? - 30 Aug 2001
>
>
-- MikeMannix? - 30 Aug 2001
 <<O>>  Difference Topic TWikiVariables (r1.40 - 12 Sep 2001 - MikeMannix?)
Added:
>
>
Note: Included topic UtilTempDocNote? does not exist yet

TWiki Variables

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

TOC: No TOC in "TWiki.TWikiVariables"
Changed:
<
<

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

Preferences Variables

>
>

Preferences Variables


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

Line: 324 to 328

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.
 <<O>>  Difference Topic TWikiVariables (r1.38 - 07 Sep 2001 - MikeMannix?)

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

    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
 <<O>>  Difference Topic TWikiVariables (r1.37 - 01 Sep 2001 - MikeMannix?)

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.

UAIWiki expands the following variables enclosed in % percent signs:
Changed:
<
<
Variable: Expanded to:
>
>
Variable: Expanded to:

%WIKIHOMEURL% The base script URL of UAIWiki, is the link of the Home icon in the upper left corner, is http://uai.cs.ubc.ca/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 #999966
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.

Added:
>
>

Preferences Variables

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

Changed:
<
<
Variable: Level: What:
>
>
Variable: Level: What:

%WIKIWEBMASTER% SL
Line: 318 to 323

SL , WL 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.:

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

-- MikeMannix? - 30 Aug 2001

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

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

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

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 UAIWiki, is /cgi-bin/twiki
%SCRIPTSUFFIX%
Changed:
<
<
The script suffix, i.e. .pl, is
>
>
The script suffix, ex: .pl, .cgi is

%PUBURL% The public URL of TWiki, is http://www.auai.org/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 UAIWiki
%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 TWikiGuest
Line: 60 to 60

The Main web containing TWikiUsers, OfficeLocations and TWikiGroups. Is Main
%TWIKIWEB%
Changed:
<
<
The web containing all documentation and configuration of UAIWiki. Is TWiki
>
>
The web containing all documentation and configuration of UAIWiki 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):

    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- MikeMannix? - 26 Aug 2001
>
>
-- MikeMannix? - 30 Aug 2001
 <<O>>  Difference Topic TWikiVariables (r1.34 - 30 Aug 2001 - MikeMannix?)

TWiki Variables

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

TWiki Variables

Added:
>
>

About Variables

Include/write if not found elsewhere.


Predefined Variables

UAIWiki expands the following variables enclosed in % percent signs:

Line: 317 to 321

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):
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

Deleted:
<
<
-- PeterThoeny - 23 Jul 2001

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

TWiki Variables

Line: 325 to 325

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

-- PeterThoeny - 23 Jul 2001

Changed:
<
<
-- MikeMannix? - 26 Aug 2001
>
>
-- MikeMannix? - 26 Aug 2001
 <<O>>  Difference Topic TWikiVariables (r1.31 - 26 Aug 2001 - MikeMannix?)
Added:
>
>
TOC: No TOC in "TWiki.TWikiVariables"

TWiki Variables

Predefined Variables

Line: 168 to 170

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:

Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
Line: 323 to 325

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

-- PeterThoeny - 23 Jul 2001

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

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:

Parameter: Description: Default:
"TopicName" topic name Current topic
web="Name" Name of web Current web
 <<O>>  Difference Topic TWikiVariables (r1.29 - 07 Aug 2001 - JohnTalintyre?)

TWiki Variables

Predefined Variables

Line: 106 to 106


%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
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.

Parameters are format, separator and web:
Parameter: Description: Default:
"format" Format of one line, may include $name variable "$name"
format="format" (Alternative to above) "$name"
separator=", " line separator "\n" (new line)
Changed:
<
<
Example:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
>
>
webs="public" comma sep list of Web, public expands to all non-hidden "public"
marker="selected" Text for $marker where item matches selection, otherwise equals "" "selected"
selection Current value e.g. current for current Web, =section="%WEB%"
Examples:
%WEBLIST{"   * [[$name.WebHome]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.

%GMTIME% GM time, is 31 Jul 2014 - 13:31
Line: 287 to 293

(any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
Added:
>
>
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the UAIWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the UAIWiki web. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)

%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
 <<O>>  Difference Topic TWikiVariables (r1.28 - 23 Jul 2001 - PeterThoeny)

TWiki Variables

Predefined Variables

Line: 50 to 50

%WIKIUSERNAME% Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
Added:
>
>
%MAINWEB% The Main web containing TWikiUsers, OfficeLocations and TWikiGroups. Is Main
%TWIKIWEB% The web containing all documentation and configuration of UAIWiki. Is TWiki

%WEB% The current web, is TWiki
Line: 59 to 65

%INCLUDINGWEB% The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
Added:
>
>
%HOMETOPIC% The home topic in each web. Is WebHome
%NOTIFYTOPIC% The notify topic in each web. Is WebNotify
%WIKIUSERSTOPIC% The index topic of all registered users. Is TWikiUsers
%WEBPREFSTOPIC% The web preferences topic. Is WebPreferences
%STATISTICSTOPIC% The web statistics topic. Is WebStatistics

%TOPIC% The current topic name, is TWikiVariables
Line: 278 to 299

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 14 Jul 2001
>
>
-- PeterThoeny - 23 Jul 2001
 <<O>>  Difference Topic TWikiVariables (r1.27 - 15 Jul 2001 - PeterThoeny)

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

Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
Added:
>
>

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


%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}%
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)

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

REMOTE_USER environment variable, is
%INCLUDE{"page" ...}%
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:

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

web="Name" Name of web Current web
depth="2" Limit depth of headings shown in TOC 6
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
Changed:
<
<
%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

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 17
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:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 25 Jun 2001
>
>
-- PeterThoeny - 14 Jul 2001
 <<O>>  Difference Topic TWikiVariables (r1.26 - 11 Jul 2001 - PeterThoeny)

TWiki Variables

Predefined Variables

Line: 43 to 44

%USERNAME% Your login username, is guest
Added:
>
>
%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest

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

%WEB% The current web, is TWiki
 <<O>>  Difference Topic TWikiVariables (r1.25 - 26 Jun 2001 - PeterThoeny)

%REMOTE_USER% REMOTE_USER environment variable, is
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/"}%

%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]
Pair: Description: Default:
search="food" Search term, (either regex or literal, depending on the regex parameter) (used if initial search term is missing)
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

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: 248 to 252

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 24 Mar 2001
>
>
-- PeterThoeny - 25 Jun 2001
 <<O>>  Difference Topic TWikiVariables (r1.24 - 08 Jun 2001 - PeterThoeny)

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

%GMTIME% GM time, is 31 Jul 2014 - 13:31
 <<O>>  Difference Topic TWikiVariables (r1.23 - 02 Jun 2001 - PeterThoeny)

%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
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

%WIKITOOLNAME% Name of wiki tool, is UAIWiki
 <<O>>  Difference Topic TWikiVariables (r1.22 - 25 Mar 2001 - PeterThoeny)

Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
%SEARCH{"str" ...}%
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]

Pair: Description: Default:
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

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: 139 to 140

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.


Preferences Variables

Line: 232 to 235

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 15 Mar 2001
>
>
-- PeterThoeny - 24 Mar 2001
 <<O>>  Difference Topic TWikiVariables (r1.21 - 16 Mar 2001 - PeterThoeny)
Added:
>
>

TWiki Variables

Predefined Variables


UAIWiki expands the following variables enclosed in % percent signs:

Line: 131 to 135

Example: %SEARCH{"wiki" web="Main" scope="topic"}%
%VAR{"NAME" web="Web"}%
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 #999966
>
>
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 #999966

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

Added:
>
>

Preferences Variables


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

Line: 226 to 232

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 01 Mar 2001
>
>
-- PeterThoeny - 15 Mar 2001
 <<O>>  Difference Topic TWikiVariables (r1.20 - 02 Mar 2001 - PeterThoeny)

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

%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:
Line: 216 to 226

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 19 Jan 2001
>
>
-- PeterThoeny - 01 Mar 2001
 <<O>>  Difference Topic TWikiVariables (r1.19 - 20 Jan 2001 - PeterThoeny)

%WEB% The current web, is TWiki
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.

%TOPIC% The current topic name, is TWikiVariables
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.

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

GM time, is 31 Jul 2014 - 13:31
%GMTIME{"format"}%
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 Jul, 2014 - 13:31:55

%SERVERTIME% Server time, is 31 Jul 2014 - 06:31
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 06:31

%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
 <<O>>  Difference Topic TWikiVariables (r1.18 - 20 Jan 2001 - PeterThoeny)

nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text Show topic summary
nosearch="on" Suppress search string Show search string
Changed:
<
<
noheader="on" Suppress search header
Topics: Changed: By:
Show search header
>
>
noheader="on" Suppress search header
Topics: Changed: By:
Show search header

nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
Line: 194 to 194

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 10 Nov 2000
>
>
-- PeterThoeny - 19 Jan 2001
 <<O>>  Difference Topic TWikiVariables (r1.17 - 16 Jan 2001 - PeterThoeny)

%INCLUDE{"SomeTopic"}% 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:
Pair: Description: Default:
 <<O>>  Difference Topic TWikiVariables (r1.16 - 18 Dec 2000 - PeterThoeny)

nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text Show topic summary
nosearch="on" Suppress search string Show search string
Added:
>
>
noheader="on" Suppress search header
Topics: Changed: By:
Show search header

nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
 <<O>>  Difference Topic TWikiVariables (r1.15 - 15 Dec 2000 - PeterThoeny)

%SCRIPTURLPATH% The path of the script URL of UAIWiki, is /cgi-bin/twiki
Added:
>
>
%SCRIPTSUFFIX% The script suffix, i.e. .pl, is

%PUBURL% The public URL of TWiki, is http://www.auai.org/twiki/pub
 <<O>>  Difference Topic TWikiVariables (r1.14 - 14 Dec 2000 - PeterThoeny)

Your login username, is guest
%WIKIUSERNAME%
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

%WEB% The current web, is TWiki
Line: 93 to 93

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.

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.13 - 11 Nov 2000 - PeterThoeny)
Changed:
<
<
TWiki expands the following variables enclosed in % percent signs:
>
>
UAIWiki expands the following variables enclosed in % percent signs:

Variable: Expanded to:
%WIKIHOMEURL%
Changed:
<
<
The base script URL of TWiki, link of Home icon in upper left corner, is http://uai.cs.ubc.ca/twiki
>
>
The base script URL of UAIWiki, is the link of the Home icon in the upper left corner, is http://uai.cs.ubc.ca/twiki

%SCRIPTURL%
Changed:
<
<
The script URL of TWiki, is http://www.auai.org/cgi-bin/twiki
>
>
The script URL of UAIWiki, is http://www.auai.org/cgi-bin/twiki

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

%PUBURL% The public URL of TWiki, is http://www.auai.org/twiki/pub
%PUBURLPATH%
Changed:
<
<
The path of the public URL of TWiki, is /twiki/pub
>
>
The path of the public URL of UAIWiki, is /twiki/pub

%ATTACHURL% The attachment URL of the current topic, is http://www.auai.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Line: 70 to 70

REMOTE_USER environment variable, is
%INCLUDE{"SomeTopic"}%
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"}%

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

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: 86 to 86

bookview="on" BookView search, e.g. show complete topic text Show topic summary
nosearch="on" Suppress search string Show search string
nototal="on" Do not show number of topics found Show number
Changed:
<
<
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
>
>
Example: %SEARCH{"wiki" web="Main" scope="topic"}%

%VAR{"NAME" web="Web"}%
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 #999966
>
>
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 #999966

Line: 155 to 155

%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.
Added:
>
>
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the UAIWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the UAIWiki 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

Notes:

Line: 164 to 184

  • Additional preferences variables can be defined on all three level as needed. Example:
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<
-- PeterThoeny - 01 Nov 2000
>
>
-- PeterThoeny - 10 Nov 2000
 <<O>>  Difference Topic TWikiVariables (r1.12 - 02 Nov 2000 - PeterThoeny)

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

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

Line: 153 to 157

http-equiv meta tags for preview script.
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)

WL Exclude web from a web="all" search (set variable to on for hidden webs)
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 )

%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
Line: 138 to 146

%HTTP_EQUIV_ON_EDIT% SL , UL
Changed:
<
<
http-equiv meta tags for edit script.
>
>
http-equiv meta tags for edit script.

%HTTP_EQUIV_ON_PREVIEW% SL , UL
 <<O>>  Difference Topic TWikiVariables (r1.10 - 19 Sep 2000 - PeterThoeny)

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

%GMTIME% GM time, is 31 Jul 2014 - 13:31
Line: 142 to 145

http-equiv meta tags for preview script.
Changed:
<
<
-- PeterThoeny - 17 Aug 2000
>
>
-- PeterThoeny - 18 Sep 2000
 <<O>>  Difference Topic TWikiVariables (r1.9 - 18 Aug 2000 - PeterThoeny)

%REMOTE_USER% REMOTE_USER environment variable, is
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"}%

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

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

casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
Added:
>
>
bookview="on" BookView search, e.g. show complete topic text 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"}%
Added: >
> [1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.
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):

Line: 107 to 113
WL Background color of web
Added: >
>
%NOSEARCHALL% WL 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:
Added: >
>
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%HTTP_EQUIV_ON_EDIT% SL , UL http-equiv meta tags for edit script.
%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.

Changed: <
< -- PeterThoeny - 29 May 2000
>
> -- PeterThoeny - 17 Aug 2000
 <<O>>  Difference Topic TWikiVariables (r1.8 - 28 Jul 2000 - PeterThoeny)

Your login username, is guest
%WIKIUSERNAME%
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

%WEB% The current web, is TWiki
Line: 42 to 42

%TOPIC% The current topic name, is TWikiVariables
Deleted:
<
<
%DATE% Todays date (local server time), is 31 Jul 2014

%GMTIME%
Changed:
<
<
Todays date (GM time), is 31 Jul 2014 - 13:31
>
>
GM time, is 31 Jul 2014 - 13:31
%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 Jul 2014 - 06:31
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min

%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
Line: 76 to 82

Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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):

Variable: Level: What:
 <<O>>  Difference Topic TWikiVariables (r1.7 - 29 May 2000 - PeterThoeny)

The current topic name, is TWikiVariables
%DATE%
Changed:
<
<
Todays date, is 31 Jul 2014
>
>
Todays date (local server time), is 31 Jul 2014
%GMTIME% Todays date (GM time), is 31 Jul 2014 - 13:31

%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
Line: 111 to 114

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:
Changed:
<
<
-- PeterThoeny - 21 Apr 2000
>
>
-- PeterThoeny - 29 May 2000
 <<O>>  Difference Topic TWikiVariables (r1.6 - 22 Apr 2000 - PeterThoeny)

Variable: Expanded to:
%WIKIHOMEURL%
Changed:
<
<
The base script URL of TWiki, link of Home icon in upper left corner is http://uai.cs.ubc.ca/twiki
>
>
The base script URL of TWiki, link of Home icon in upper left corner, is http://uai.cs.ubc.ca/twiki

%SCRIPTURL% The script URL of TWiki, is http://www.auai.org/cgi-bin/twiki
Line: 45 to 45

%DATE% Todays date, is 31 Jul 2014
Added:
>
>
%HTTP_HOST% HTTP_HOST environment variable, is www.auai.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 54.242.18.190
%REMOTE_PORT% REMOTE_PORT environment variable, is
%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:
Added:
>
>

-- PeterThoeny - 21 Apr 2000

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

%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
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)

The base script URL of TWiki, link of Home icon in upper left corner is http://uai.cs.ubc.ca/twiki
%SCRIPTURL%
Changed:
<
<
The base script URL of TWiki, is http://www.auai.org/cgi-bin/twiki
>
>
The script URL of TWiki, is http://www.auai.org/cgi-bin/twiki
%SCRIPTURLPATH% The path of the script URL of TWiki, is /cgi-bin/twiki

%PUBURL%
Changed:
<
<
The base public URL of TWiki, is http://www.auai.org/twiki/pub
>
>
The public URL of TWiki, is http://www.auai.org/twiki/pub
%PUBURLPATH% The path of the public URL of TWiki, is /twiki/pub

%ATTACHURL% The attachment URL of the current topic, is http://www.auai.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Added:
>
>
%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables

%WIKITOOLNAME% Name of wiki tool, is UAIWiki
 <<O>>  Difference Topic TWikiVariables (r1.3 - 28 Feb 2000 - PeterThoeny)

%ATTACHURL% The attachment URL of the current topic, is http://www.auai.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
Deleted:
<
<
%WIKIWEBMASTER% The email address of the Wiki webmaster, is uaiwebmaster@gmail.com

%WIKITOOLNAME% Name of wiki tool, is UAIWiki
Line: 54 to 51

nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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 uaiwebmaster@gmail.com
%WIKIWEBLIST% SL List of UAIWiki webs (in upper right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBBGCOLOR% WL Background color of web
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
 <<O>>  Difference Topic TWikiVariables (r1.2 - 30 Jan 2000 - PeterThoeny)

%DATE% Todays date, is 31 Jul 2014
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://uai.cs.ubc.ca/twiki
%SCRIPTURL% The base script URL of TWiki, is http://www.auai.org/cgi-bin/twiki
%PUBURL% The base public URL of TWiki, is http://www.auai.org/twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://www.auai.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 uaiwebmaster@gmail.com
%WIKITOOLNAME% Name of wiki tool, is UAIWiki
%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 Jul 2014
%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"%
Revision r1.1 - 13 Jun 1999 - 07:45 - Main.thoeny
Revision r1.81 - 23 Mar 2006 - 01:48 - MarkCrowley