Difference: TWikiVariables (1 vs. 84)

Revision 8406 Mar 2007 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

TWiki Variables

Line: 115 to 115
  Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH%, are powerful and general tools.
Changed:
<
<
>
>
 
  • ALERT! Plugins may extend the set of predefined variables (see individual Plugins topics for details)
  • 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%.

Revision 8306 Mar 2007 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Deleted:
<
<
 
Changed:
<
<

TWiki Variables

>
>

TWiki Variables

  Special text strings expand on the fly to display user data or system info
Line: 10 to 9
 
  1. Preferences variables: Can be defined and changed by the user
  2. Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a %CALC{}% variable)
Added:
>
>
 

Using Variables

To use a variable type its name. For example,

Line: 35 to 36
 

Setting Preferences Variables

You can set variables in all the following places:
Changed:
<
<
  1. local site level in TWiki.TWikiPreferences
>
>
  1. local site level in TWiki.TWikiPreferences
 
  1. plugin topics (see TWikiPlugins)
  2. local site level in Main.TWikiPreferences
Changed:
<
<
  1. user level in individual user topics in Main web
>
>
  1. user level in individual user topics in Main web
 
  1. web level in WebPreferences of each web
  2. topic level in topics in webs
  3. session variables (if sessions are enabled)

Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.

Added:
>
>		If you are setting a variable and using it in the same topic, note that TWiki reads all the variable settings from the saved version of the topic before it displays anything. This means you can use a variable anywhere in the topic, even if you set it somewhere inconspicuous near the end. But beware: it also means that if you change the setting of a variable you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.
 The syntax for setting 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] = [space] value
Examples:

Revision 8219 Mar 2006 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 36 to 36
 

Setting Preferences Variables

You can set variables in all the following places:
  1. local site level in TWiki.TWikiPreferences
Added:
>
>
  1. plugin topics (see TWikiPlugins)
 
  1. local site level in Main.TWikiPreferences
  2. user level in individual user topics in Main web
  3. web level in WebPreferences of each web
  4. topic level in topics in webs
Deleted:
<
<
  1. plugin topics (see TWikiPlugins)
 
  1. session variables (if sessions are enabled)

Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.

The syntax for setting 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] = [space] value

Changed:
<
<
>
>
 Examples:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.
Changed:
<
<
>
>
 Example: 
   * Set VARIABLENAME = value starts here
Line: 62 to 62
  Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
Changed:
<
<
>
>
 Example: Create a custom logo variable
  • To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences topic, 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, e.g. LogoTopic. Sample variable setting in WebPreferences:
    • Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

Revision 8119 Mar 2006 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 35 to 35
 

Setting Preferences Variables

You can set variables in all the following places:
Changed:
<
<
  1. local site level in TWikiPreferences
>
>
  1. local site level in TWiki.TWikiPreferences
  2. local site level in Main.TWikiPreferences
 
  1. user level in individual user topics in Main web
  2. web level in WebPreferences of each web
  3. topic level in topics in webs

Revision 8019 Mar 2006 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<
>
>
 

TWiki Variables

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

Line: 22 to 22
 
  • Variables are expanded relative to the topic they are used in, not the topic they are defined in
  • Type %ALLVARIABLES% to get a full listing of all variables defined for a particular topic
Added:
>
>

Variable Names

Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g. %MYVAR%, %MyVar%, %My2ndVar%, and %My_Var% are all valid variable names. Variables are case sensitive. %MyVAR% and %MYVAR% are not the same variable.

By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.

 
Line: 113 to 117
  This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - predefines the following variables:
Changed:
<
<

Warning: Can't find topic TWiki.TWikiVariablesAtoM

Warning: Can't find topic TWiki.TWikiVariablesNtoZ

>
>

ACTIVATEDPLUGINS -- list of currently activated plugins

ALLVARIABLES -- list of currently defined TWikiVariables

  • Syntax: %ALLVARIABLES%
  • Expands to: a table showing all defined TWikiVariables in the current context

AQUA -- start aqua colored text

  • AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %AQUA% aqua text %ENDCOLOR%
  • Expands to: aqua text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

ATTACHURL -- full URL for attachments in the current topic

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

AUTHREALM -- authentication realm

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

BB -- bullet with line break

BB2 -- level 2 bullet with line break

BB3 -- level 3 bullet with line break

BB4 -- level 4 bullet with line break

BLACK -- start black colored text

  • BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %BLACK% black text %ENDCOLOR%
  • Expands to: black text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

BLUE -- start blue colored text

  • BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %BLUE% blue text %ENDCOLOR%
  • Expands to: blue text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

BR -- line break

BROWN -- start brown colored text

  • BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %BROWN% brown text %ENDCOLOR%
  • Expands to: brown text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

BULLET -- bullet character

CALC{"formula"} -- add spreadsheet calculations to tables and outside tables

  • The %CALC{"formula"}% variable is handled by the SpreadSheetPlugin. There are around 80 formulae, such as $ABS(), $EXACT(), $EXISTS(), $GET()/$SET(), $IF(), $LOG(), $LOWER(), $PERCENTILE(), $TIME(), $VALUE().
  • Syntax: %CALC{"formula"}%
  • Examples:
    • %CALC{"$SUM($ABOVE())"}% returns the sum of all cells above the current cell
    • %CALC{"$EXISTS(Web.SomeTopic)"}% returns 1 if the topic exists
    • %CALC{"$UPPER(Collaboration)"}% returns COLLABORATION
  • Related: IF, SpreadSheetPlugin

CARET -- caret symbol

COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.

  • A %COMMENT% without parameters shows a simple text box.
  • The following standard attributes are recognized
    Name Description Default
    type This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see Customisation, below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. below
    default Default text to put into the textarea of the prompt.  
    target Name of the topic to add the comment to the current topic
    location Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!  
    mode For compatibility with older versions only, synonymous with type  
    nonotify Set to "on" to disable change notification for target topics off
    noform Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example. off
    nopost Set to "on" to disable insertion of the posted text into the topic. off
    remove Set to "on" to remove the comment prompt after the first time it is clicked. off
    button Button label text Add comment

DATE -- signature format date

DISPLAYTIME -- display date and time

  • Syntax: %DISPLAYTIME%
  • Expands to: 31 Oct 2025 - 14:13
  • Date part of the format is displayed as defined by the {DefaultDateFormat} in configure. The time is shown as hh:mm (24 hour clock)
  • Related: DISPLAYTIME{"format"}, GMTIME, SERVERTIME

DISPLAYTIME{"format"} -- formatted display time

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

EDITACTION -- Selects an edit template

  • EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit. If EDITACTION is defined as text, then hide the form. If EDITACTION is defined as form hide the normal text area and only edit the form.
  • Syntax: Set EDITACTION = text|form
  • Expands to: %EDITACTION%
  • Related: TWikiScripts#edit
  • ALERT! When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add ;action=text or ;action=form to the URL for the edit script. If you have defined EDITACTION in a topic setting or preference setting you can still edit the topic content or the form by removing the ;action=form or ;action=text from the edit URL in the browser and reload.

EDITTABLE{ attributes } -- edit TWiki tables using edit fields and other input fields

  • The %EDITTABLE{}% variable is handled by the EditTablePlugin
  • Syntax: %EDITTABLE{ attributes }%

  • Supported attributes:                        
    Attribute Comment Default
    header Specify the header format of a new table like " Food Drink ". Useful to start a table with only a button (no header)
    format The format of one column when editing the table. A cell can be a text input field, or any of these edit field types:

    � Text input field (1 line):
      =     		text, <size>, <initial value> =

    � Textarea input field:
      =     		textarea, <rows>x<columns>, <initial value> =

    � Drop down box:
      =     		select, <size>, <option 1>, <option 2>, etc* =
      * only one item can be selected

    � Radio buttons:
      =     		radio, <size*>, <option 1>, <option 2>, etc =
      * size indicates the number of buttons per line in edit mode

    � Checkboxes:
      =     		checkbox, <size*>, <option 1>, <option 2>, etc =
      * size indicates the number of checkboxes per line in edit mode

    � Fixed label:
      =     		label, 0, <label text> =

    � Row number:
      =     		row, <offset> =

    � Date:
      =     		date, <size>, <initial value>, <DHTML date format> = (see Date Field Type) "text, 16"
    for all cells
    changerows Rows can be added and removed if "on"
    Rows can be added but not removed if "add"
    Rows cannot be added or removed if "off"     		CHANGEROWS
    plugin setting
    quietsave Quiet Save button is shown if "on", hidden if "off" QUIETSAVE
    plugin setting
    include Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. (none)
    helptopic Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown. (no help text)
    headerislabel Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0" "on"
    editbutton Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%TWIKIWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell) EDITBUTTON
    plugin setting
    javascriptinterface Use javascript to directly move and delete row without page refresh. Enable with "on", disable with "off". JAVASCRIPTINTERFACE
    plugin setting

  • Example:
    %EDITTABLE{ format="| text, 20 | select, 1, one, two, three |" changerows="on" }%
    | *Name* | *Type* |
    | Foo | two |
  • Related: See EditTablePlugin for more details

ENCODE{"string"} -- encodes a string to HTML entities

  • Encode "special" characters to HTML numeric entities. Encoded characters are:
    • all non-printable ASCII characters below space, except newline ("\n") and linefeed ("\r")
    • HTML special characters "<", ">", "&", single quote (') and double quote (")
    • TWiki special characters "%", "[", "]", "@", "_", "*", "=" and "|"
  • 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;. Does not encode \n or \r. type="url"
    type="html" As type="entity" except it also encodes \n and \r type="url"
    type="quotes" Escape double quotes with backslashes (\"), does not change other characters type="url"
    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
  • ALERT! Note: Values of HTML input fields must be entity encoded.
    Example: <input type="text" name="address" value="%ENCODE{ "any text" type="entity" }%" />
  • ALERT! Note: Double quotes in strings must be escaped when passed into other TWiki variables.
    Example: %SEARCH{ "%ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%

ENDCOLOR -- end colored text

ENDSECTION{"name"} -- marks the end of a named section within a topic

  • Syntax: %ENDSECTION{"name"}%
  • Syntax: %ENDSECTION{type="include"}%
  • Supported parameter:
    Parameter: Description:
    "name" Name of the section.
    type="..." Type of the section being terminated; supported types "section", "include", "templateonly".
  • If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If the STARTSECTION specifies a type, then the corresponding ENDSECTION must also specify the same type. If the section is unnamed, ENDSECTION will match with the nearest unnamed %STARTSECTION% of the same type above it.
  • Related: STARTSECTION

ENV{"varname"} -- inspect the value of an environment variable

  • Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is the environment that the TWiki scripts run in on the web server.
  • Note: For security reasons, only those variables whose names match the regular expression in {AccessibleENV} in the Security Settings/Miscellaneous section of configure can be displayed. Any other variable will just be shown as an empty string, irrespective of its real value.
  • Example: %ENV{MOD_PERL}% displays as: not set
  • If a variable is undefined (as against being set to the empty string) it will be returned as not set.
  • Related: HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list

FORMFIELD{"fieldname"} -- 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, and $title expands to the fieldname (also expands $name, $attributes, $type, $size and $definingTopic) "$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
    $dow day of the week (Sun = 0) 2
    $week number of week in year (ISO 8601) 34
    $month short name of month 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 2025-10-31T17:13:28Z
    $rcs RCS format timestamp 2025/10/31 17:13:28
    $http E-mail & http format timestamp Fri, 31 Oct 2025 17:13:28 GMT
    $epoch Number of seconds since 00:00 on 1st January, 1970 1761930808
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 31 Oct, 2025 - 17:13:28
  • ALERT! Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
  • Related: DISPLAYTIME, GMTIME, REVINFO, SERVERTIME

GRAY -- start gray colored text

  • GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %GRAY% gray text %ENDCOLOR%
  • Expands to: gray text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

GREEN -- start green colored text

  • GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %GREEN% green text %ENDCOLOR%
  • Expands to: green text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

GROUPS -- a formatted list of groups

H -- help icon

HOMETOPIC -- home topic in each web

HTTP -- get HTTP headers

HTTP_HOST -- environment variable

HTTPS -- get HTTPS headers

  • The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
  • Syntax: %HTTPS%
  • Syntax: %HTTPS{"Header-name"}%
  • Related: HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

I -- idea icon

ICON{"name"} -- small documentation graphic or icon of common attachment types

  • Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
  • Syntax: %ICON{"name"}%
  • Examples:
    • %ICON{"flag-gray"}% returns flag-gray
    • %ICON{"pdf"}% returns pdf
    • %ICON{"smile.pdf"}% returns pdf
    • %ICON{"/dont/you/dare/smile.pdf"}% returns pdf
    • %ICON{"http://twiki.org/doc/xhtml.xsl"}% returns xsl
  • Graphic samples: arrowbright arrowbright, bubble bubble, choice-yes choice-yes, hand hand
  • File type samples: bmp bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip
  • Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics

ICONURL{"name"} -- URL of small documentation graphic or icon

  • Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related %ICON{"name"}% generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
  • Syntax: %ICONURL{"name"}%
  • Examples:
    • %ICONURL{"arrowbright"}% returns http://twiki.ufba.br/twiki/pub/TWiki/TWikiDocGraphics/arrowbright.gif
    • %ICONURL{"novel.pdf"}% returns http://twiki.ufba.br/twiki/pub/TWiki/TWikiDocGraphics/pdf.gif
    • %ICONURL{"/queen/boheme.mp3"}% returns http://twiki.ufba.br/twiki/pub/TWiki/TWikiDocGraphics/mp3.gif
  • Related: ICONURLPATH, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics

ICONURLPATH{"name"} -- URL path of small documentation graphic or icon

  • Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
  • Syntax: %ICONURLPATH{"name"}%
  • Examples:
    • %ICONURLPATH{"locktopic"}% returns /twiki/pub/TWiki/TWikiDocGraphics/locktopic.gif
    • %ICONURLPATH{"eggysmell.xml"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xml.gif
    • %ICONURLPATH{"/doc/xhtml.xsl"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xsl.gif
  • Related: ICONURL, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics

IF{"condition" ...} -- simple conditionals

  • Evaluate a condition and show one text or another based on the result. See details in IfStatements
  • Syntax: %IF{"CONDITION" then="THEN" else="ELSE"}% shows "THEN" if "CONDITION" evaluates to TRUE, otherwise "ELSE" will be shown
  • Example: %IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else="FUNFACTOR is not defined"}% renders as FUNFACTOR is not defined
  • Related: $IF() of SpreadSheetPlugin

INCLUDE{"page"} -- include other topic or web page

  • 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:80/index.html"}%. Supported content types are text/html and text/plain.
    IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.     		 
    pattern="..." Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
    rev="2" Include a previous topic revision; N/A for URLs top revision
    raw="on" When a page is included, normally TWiki will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on.
    raw="on" is short for disableremoveheaders="on", disableremovescript="on", disableremovebody="on", disablecompresstags="on" and disablerewriteurls="on".     		disabled
    literal="on" While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on". disabled
    disableremoveheaders="on" Bypass stripping headers from included HTML (everything until first </head> tag) disabled
    disableremovescript="on" Bypass stripping all <script> tags from included HTML disabled
    disableremovebody="on" Bypass stripping the </body> tag and everything around over and below it disabled
    disablecompresstags="on" Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed disabled
    disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
    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) %INCLUDEWARNING% preferences setting
    section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section  
    PARONE="val 1"
    PARTWO="val 2"         		Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic.  
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)
  • Examples: See IncludeTopicsAndWebPages
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION

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

LANGUAGE -- current user's language

  • Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
  • The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
    • If the LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
    • Avoid defining LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
  • Related: LANGUAGES

LANGUAGES -- list available TWiki languages

  • List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's user interface is available.
  • Syntax: %LANGUAGES{...}%
  • Supported parameters:
    Parameter: Description: Default:
    format format for each item. See below for variables available in the format string. "   * $langname"
    separator separator between items. "\n" (newline)
    marker="selected" Text for $marker if the item matches selection "selected"
    selection="%LANGUAGE%" Current language to be selected in list (none)
  • format variables:
    Variable Meaning
    $langname language's name, as informed by the translators
    $langtag language's tag. Ex: en, pt-br, etc.
  • Example: <select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select> creates an option list of the available languages with the current language selected

LIME -- start lime colored text

  • LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %LIME% lime text %ENDCOLOR%
  • Expands to: lime text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

LOCALSITEPREFS -- web.topicname of site preferences topic

  • The full name of the local site preferences topic. These local site preferences overload the system level preferences defined in TWiki.TWikiPreferences.
  • Syntax: %LOCALSITEPREFS%
  • Expands to: Main.TWikiPreferences, renders as TWikiPreferences

LOGIN -- present a full login link

LOGOUT -- present a full logout link

M -- moved to... icon

MAINWEB -- synonym for USERSWEB

  • Deprecated. Please use %USERSWEB% instead.

MAKETEXT -- creates text using TWiki's I18N infrastructure

  • Syntax: %MAKETEXT{"string" args="..."}%
  • Supported parameters:
    Parameter Description Default
    "text" or string="text" The text to be displayed. none
    args="param1, param2" a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it. none
  • Examples:
    • %MAKETEXT{string="Notes:"}%
      expands to
      Notes:
    • %MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}%
      expands to
      If you have any questions, please contact twiki@ufba.br.
    • %MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"}%
      expands to
      Did you want to reset Main.TWikiGuest's password?
  • Notes:
    • TWiki will translate the string to the current user's language only if it has such string in its translation table for that language.
    • Amperstands (&) followed by one letter (one of a...z, A...Z) (say, X) in the translatable string will be translated to <span class='twikiAccessKey'>X</span>. This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&&): they will be transformed in just one.
    • translatable string starting with underscores (_) are reserved. You cannot use translatable phrases starting with an underscore.
    • Make sure that the translatable string is constant. Specially, do not include %VARIABLES% inside the translatable strings (since they will get expanded before the %MAKETEXT{...}% itself is handled).

MAROON -- start maroon colored text

  • MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %MAROON% maroon text %ENDCOLOR%
  • Expands to: maroon text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

META -- displays meta-data

  • Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The formfield item is the most likely to be useful to casual users.
  • Syntax: %META{ "item" ...}%
  • Parameters:
    Item Options Description
    "formfield" name="...": name of the field. The field value can be shortened as described in FormattedSearch for $formfield
    newline="...": by default, each newline character will be rewritten to <br /> to allow metadata that contains newlines to be used in tables, etc. $n indicates a newline character.
    bar="...": by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator.     		Show a single form field
    "form" none Generates the table showing the form fields. See Form Templates
    "attachments" all="on" to show hidden attachments.
    title="..." to show a title - only if attachments are displayed.
    template="..." to use a custom template for the rendering of attachments; default attachtables is used.     		Generates the list of attachments
    "moved" none Details of any topic moves
    "parent" dontrecurse="on": By default recurses up tree, this has some cost.
    nowebhome="on": Suppress WebHome.
    prefix="...": Prefix that goes before parents, but only if there are parents, default "".
    format="...": Format string used to display each parent topic where $web expands to the web name, and $topic expands to the topic name; default: "[[$web.$topic][$topic]]"
    suffix="...": Suffix, only appears if there are parents; default "".
    separator="...": Separator between parents; default " > ".     		Generates the parent link
  • Related: METASEARCH

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
    "field" if searching for topics that have a particular form field value (use the name and value parameters to specify which field to search)     		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, for topicmoved and parent searches All topics in a web
    name form field to search, for field type searches. May be a regular expression (see SEARCH).  
    value form field value, for field type searches. May be a regular expression (see SEARCH).  
    title="Title" Text that is prefixed to any search results empty
    format="..." Custom format results. Supports same format strings as SEARCH. See FormattedSearch for usage, variables & examples Results in table
    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: "}%
  • Example: %METASEARCH{type="field" name="Country" value="China"}%
  • Related: SEARCH, META
  • ALERT! Note: METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and QuerySearch.

N -- "new" icon

NAVY -- start navy blue colored text

  • NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %NAVY% navy text %ENDCOLOR%
  • Expands to: navy text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

NOP -- template text not to be expanded in instantiated topics

  • Syntax: %NOP%
    • In normal topic text, expands to <nop>, which prevents expansion of adjacent variables and wikiwords
    • When the topic containing this is used as a template for another topic, it is removed.
  • Syntax: %NOP{...}% deprecated
    • In normal topic text, expands to whatever is in the curly braces (if anything).
    • ALERT! Note: This is deprecated. Do not use it. Use %STARTSECTION{type="templateonly"}% .. %ENDSECTION{type="templateonly"}% instead (see TWikiTemplates for more details).
  • Related: STARTSECTION, TWikiTemplates

NOTIFYTOPIC -- name of the notify topic

OLIVE -- start olive green colored text

  • OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %OLIVE% olive text %ENDCOLOR%
  • Expands to: olive text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

ORANGE -- start orange colored text

  • ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %ORANGE% orange text %ENDCOLOR%
  • Expands to: orange text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

P -- pencil icon

PINK -- start pink colored text

  • PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %PINK% pink text %ENDCOLOR%
  • Expands to: pink text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

PLUGINDESCRIPTIONS -- list of plugin descriptions

  • Syntax: %PLUGINDESCRIPTIONS%
  • Expands to:
    • SpreadSheetPlugin (any TWiki, $Rev: 17387 (11 Aug 2008) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
    • AlbumOfSnapsPlugin (Dakar, $Rev: 10613 (12 Dec 2008) $):
    • ApprovalPlugin (1.0, $Rev: 3923 (2009-05-16) $): Defines a set of states for one more or topics, with each state requiring approval by one or more users.
    • AttachmentList: (disabled)
    • AttachmentListPlugin (1.2.6, $Rev: 17172 (28 Jul 2008) $): Displays a formattable list of topic attachments, anywhere in a topic.
    • BatchUploadPlugin: (disabled)
    • CaptchaPlugin (Dakar, 1.5-pre4): To prevent automated bots from spamming
    • CommentPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
    • CounterPlugin (Dakar, $Rev: 14404 (12 Dec 2008) $): This plugin maintains the Visitor Count for the site.
    • EditTablePlugin (4.8.4, $Rev: 17302 (11 Aug 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
    • EmptyPlugin (TWiki-4.2, $Rev: 15942 (11 Aug 2008) $): Empty Plugin used as a template for new Plugins
    • ImageGalleryPlugin (3.72, $Rev: 17034 (16 Jul 2008) $): Displays image gallery with auto-generated thumbnails from attachments
    • ImagePlugin (2010-08-01, $Rev: 19301 (2010-08-01) $): Control the display and alignment of images using an easy syntax
    • InterwikiPlugin (03 Aug 2008, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
    • MultiEditPlugin: (disabled)
    • NewsPlugin (Dakar, $Rev: 15565 (12 Dec 2008) $): %NEWS% generates a short headlines topic from a list of news
    • PreferencesPlugin (TWiki-4.2, $Rev: 15487 (11 Aug 2008) $): Allows editing of preferences using fields predefined in a form
    • RenderListPlugin (2.0, $Rev: 16235 (11 Aug 2008) $): Render bullet lists in a variety of formats
    • SendEmailPlugin (1.2.2, $Rev: 17666 (12 Dec 2008) $): Allows to send e-mail through an e-mail form
    • SlideShowPlugin (02 Aug 2008, $Rev: 17260 (11 Aug 2008) $): Create web based presentations based on topics with headings.
    • SmiliesPlugin (Dakar, $Rev: 16049 (11 Aug 2008) $): Render smilies as icons, like smile for  :-) or eek! for  :eek:
    • TablePlugin (1.034, $Rev: 17367 (11 Aug 2008) $): Control attributes of tables and sorting of table columns
    • TagMePlugin (TWiki 4, 1.046): Tag wiki content collectively to find content by keywords
    • TinyMCEPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Integration of TinyMCE? with WysiwygPlugin
    • TopicTranslationsPlugin (Dakar, $Rev: 15568 (12 Dec 2008) $): Manages a topic's translations into several languages.
    • TwistyPlugin (1.4.10, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
    • WysiwygPlugin (03 Aug 2008, $Rev: 17359 (11 Aug 2008) $): Translator framework for Wysiwyg editors
  • Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API

  • Syntax: %PLUGINVERSION{"name"}% to get the version of a specific plugin
  • Example: %PLUGINVERSION{"InterwikiPlugin"}% expands to $Rev: 14913 (17 Sep 2007) $
  • Syntax: %PLUGINVERSION% to get the version of the API
  • Expands to: 1.2
  • Related: WIKIVERSION, ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINDESCRIPTIONS

PUBURL -- the base URL of attachments

PUBURLPATH -- the base URL path of attachments

PURPLE -- start purple colored text

  • PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %PURPLE% purple text %ENDCOLOR%
  • Expands to: purple text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

Q -- question icon

QUERYPARAMS -- show paramaters to the query

  • Expands the parameters to the query that was used to display the page.
  • Syntax: %QUERYPARAMS{...}%
  • Parameters:
    • format="..." format string for each entry, default $name=$value
    • separator="..." separator string, default separator="$n" (newline)
    • encoding="..." the encoding to apply to parameter values; see ENCODE for a description of the available encodings. If this parameter is not given, no encoding is performed.
  • The following escape sequences are expanded in the format string:
Sequence: Expands To:
$name Name of the parameter
$value String value of the parameter. Multi-valued parameters will have a "row" for each value.
$n or $n() New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$nop or $nop() Is a "no operation". This variable gets removed; useful for nested search
$quot Double quote (") (\" also works)
$percnt Percent sign (%)
$dollar Dollar sign ($)

  • Example:
    • %QUERYPARAMS{format="<input type='hidden' name='$name' value='$value' encoding="entity" />"}%
  • See also QUERYSTRING, URLPARAM

QUERYSTRING -- full, unprocessed string of parameters to this URL

  • String of all the URL parameters that were on the URL used to get to the current page. For example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
  • ALERT! Note: URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and %QUERYPARAMS%.
  • Syntax: %QUERYSTRING%
  • Expands to: sortcol=2;table=20;up=0
  • Related: QUERYPARAMS, URLPARAM

RED -- start red colored text

  • RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %RED% red text %ENDCOLOR%
  • Expands to: red text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

RENDERLIST -- render bullet lists in a variety of formats

  • The %RENDERLIST% variable is handled by the RenderListPlugin
  • Syntax: %RENDERLIST%
  • Syntax: %RENDERLIST{ "org" focus="Sales.WestCoastTeam" }%
  • Example:
    %RENDERLIST{ "org" }%
       * [[Eng.WebHome][Engineering]]
          * [[Eng.TechPubs][Tech Pubs]]
       * [[Sales.WestCoastTeam][Sales]]
          * [[Sales.EastCoastTeam][East Coast]]
          * [[Sales.WestCoastTeam][West Coast]]
  • Related: RenderListPlugin

REVINFO -- revision information of current topic

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

  • Syntax: %REVINFO{"format"}%
  • Supported parameters:
    Parameter: Description: Default:
    <-- -->
    Sorted ascending
    "format" Format of revision information, see supported variables below "r1.$rev - $date - $wikiusername"
    topic="..." Topic name Current topic
    web="..." Name of web Current web
    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
    $username Login username of revision jsmith
    $wikiname WikiName of revision JohnSmith
    $wikiusername WikiName with Main web prefix Main.JohnSmith
    $date Revision date. Actual date format defined as {DefaultDateFormat} in configure 21 Sep 2006
    $time Revision time 23:24:25
    $iso Revision date in ISO date format 2006-09-22T06:24:25Z
    $min, $sec, etc. Same date format qualifiers as GMTIME{"format"}  
  • Example: %REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
  • Related: GMTIME{"format"}, REVINFO

S -- red star icon

SCRIPTNAME -- name of current script

  • The name of the current script is shown, including script suffix, if any (for example viewauth.cgi)
  • Syntax: %SCRIPTNAME%
  • Expands to: rdiff
  • Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH

SCRIPTSUFFIX -- script suffix

  • Some TWiki installations require a file extension for CGI scripts, such as .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH

SCRIPTURL -- base URL of TWiki scripts

SCRIPTURL{"script"} -- URL of TWiki script

  • Syntax: %SCRIPTURL{"script"}%
  • Expands to: http://twiki.ufba.br/twiki/bin/script
  • Example: To get the authenticated version of the current topic you can write %SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to http://twiki.ufba.br/twiki/bin/viewauth/TWiki/TWikiVariables
  • ALERT! Note: In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better
  • Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SCRIPTURLPATH{"script"}

SCRIPTURLPATH -- base URL path of TWiki scripts

  • As %SCRIPTURL%, but doesn't include the protocol and host part of the URL
  • Syntax: %SCRIPTURLPATH%
  • Expands to: /twiki/bin
  • Note: The edit script should always be used in conjunction with ?t=%GMTIME{"$epoch"}% to ensure pages about to be edited are not cached in the browser
  • Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH{"script"}

SCRIPTURLPATH{"script"} -- URL path of TWiki script

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "text" Search term. Is a keyword search, literal search, regular expression search, or query, depending on the type parameter. SearchHelp has more required
    search="text" (Alternative to above) N/A
    web="Name"
    web="Main, Know"
    web="all"     		Comma-separated list of webs to search. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb". The special word all means all webs that do not have the NOSEARCHALL variable set to on in their WebPreferences. Note that TWikiAccessControls are respected when searching webs; it is much better to use them than NOSEARCHALL. 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. Note this is a list of topic names and must not include web names. 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. Note this is a list of topic names and must not include web names. None
    scope="topic"
    scope="text"
    scope="all"     		Search topic name (title); the text (body) of topic; or all (title and body) "text"
    type="keyword"
    type="word"
    type="literal"
    type="regex"
    type="query"     		Control how the search is performed when scope="text" or scope="all"
    keyword: use Google-like controls as in soap "web service" -shampoo; searches word parts: using the example, topics with "soapsuds" will be found as well, but topics with "shampoos" will be excluded
    word: identical to keyword but searches whole words: topics with "soapsuds" will not be found, and topics with "shampoos" will not be excluded
    literal: search for the exact string, like web service
    regex: use a RegularExpression search like soap;web service;!shampoo; to search on whole words use \bsoap\b
    query: query search of form fields and other meta-data, like (Firstname='Emma' OR Firstname='John') AND Lastname='Peel'     		%SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
    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; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table). 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
    date="..." limits the results to those pages with latest edit time in the given time interval. All results
    reverse="on" Reverse the direction of the search Ascending search
    casesensitive="on" Case sensitive search Ignore case
    bookview="on" BookView search, e.g. show complete topic text Show topic summary
    nonoise="on" Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" Off
    nosummary="on" Show topic title only Show topic summary
    nosearch="on" Suppress search string Show search string
    noheader="on" Suppress default search header
    Topics: Changed: By: , unless a header is explicitly specified     		Show default search header, unless search is inline and a format is specified (Cairo compatibility)
    nototal="on" Do not show number of topics found Show number
    zeroresults="off" Suppress all output if there are no hits zeroresults="on", displays: "Number of topics: 0"
    noempty="on" Suppress results for webs that have no hits. Show webs with no hits
    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
    nofinalnewline="on" If on, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. off
    recurse="on" Recurse into subwebs, if subwebs are enabled. off
    separator=", " Line separator between search hits "$n" (Newline)
    newline="%BR%" Line separator within a search hit. Useful if the format="" parameter contains a $pattern() that captures more than one line, i.e. contents of a textfield in a form. "$n" (Newline)
  • 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 Hint: 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, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 14:13
  • ALERT! Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SESSIONID -- unique ID for this session

SESSIONVAR -- name of CGI and session variable that stores the session ID

SESSION_VARIABLE -- get, set or clear a session variable

SILVER -- start silver colored text

  • SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %SILVER% silver text %ENDCOLOR%
  • Expands to: silver text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

SLIDESHOWEND -- end slideshow

SLIDESHOWSTART -- convert a topic with headings into a slideshow

  • The %SLIDESHOWSTART% variable is handled by the SlideShowPlugin
  • Syntax: %SLIDESHOWSTART%
  • Syntax: %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
  • Example:
    %SLIDESHOWSTART%
    ---++ Sample Slide 1
        * Bullet 1
        * Bullet 2
    ---++ Sample Slide 2
        * Bullet 1
        * Bullet 2
    %SLIDESHOWEND%
  • Related: SLIDESHOWEND, SlideShowPlugin

SPACEDTOPIC -- topic name, spaced and URL-encoded deprecated

  • The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
  • Syntax: %SPACEDTOPIC%
  • Expands to: Var%20*SPACEDTOPIC
  • ALERT! Note: This is a deprecated variable. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
  • Related: SPACEOUT, TOPIC, ENCODE

SPACEOUT{"string"} -- renders string with spaces inserted in sensible places

  • Inserts spaces after lower case letters that are followed by a digit or a capital letter, and after digits that are followed by a capital letter.
  • Useful for spacing out WikiWords
  • Syntax: %SPACEOUT{ "%TOPIC%" }%
  • Expands to: TWiki Variables
  • Supported parameters:
    Parameter: Description: Default:
    separator The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies ' '
  • TIP Hint: Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home
  • Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin

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 everything exept the %STARTINCLUDE% variable itself.
  • Note: If you want more than one part of the topic included, use %STARTSECTION{type="include"}% instead
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, STARTSECTION, STOPINCLUDE

STARTSECTION -- marks the start of a section within a topic

  • Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%.
  • Sections may be given a name to help identify them, and/or a type, which changes how they are used.
    • type="section" - the default, used for a generic section, such as a named section used by INCLUDE.
    • type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want (%STARTINCLUDE% is restricted to only one).
    • type="templateonly" - start position of text to be removed when a template topic is used. This is used to embed text that you do not want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
  • Syntax: %STARTSECTION{"name"}% ................ %ENDSECTION{"name"}%
  • Syntax: %STARTSECTION{type="include"}% ........ %ENDSECTION{type="include"}%
  • Syntax: %STARTSECTION{type="templateonly"}% ... %ENDSECTION{type="templateonly"}%
  • Supported parameters:
    Parameter: Description: Default
    "name" Name of the section. Must be unique inside a topic. Generated name
    type="..." Type of the section; type "section", "include" or "templateonly" "section"
  • ALERT! Note: If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with _SECTION0 for the first unnamed section in the topic, _SECTION1 for the second, etc..
  • ALERT! Note: You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.
  • Related: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, 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

SYSTEMWEB -- name of TWiki documentation web

  • The web containing all documentation and default preference settings
  • Syntax: %SYSTEMWEB%
  • Expands to: TWiki
  • Related: USERSWEB

T -- tip icon

TABLE{ attributes } -- control attributes of tables and sorting of table columns

  • The %TABLE{}% variable is handled by the TablePlugin
  • Syntax: %TABLE{ attributes }%

  • Supported attributes:
    Argument Comment Default value Example
    sort Set table sorting by clicking headers "on" or "off". unspecified sort="on"
    initsort Column to sort initially ("1" to number of columns). unspecified initsort="2"
    initdirection Initial sorting direction for initsort, set to "up" (descending) or "down" (ascending). unspecified initdirection="up"
    disableallsort Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table. unspecified disableallsort="on"
    headerbg Header cell background colour. "#6b7f93" headerbg="#999999"
    headerbgsorted Header cell background colour of a sorted column. the value of headerbg headerbgsorted="#32596c"
    headercolor Header cell text colour. "#ffffff" headercolor="#0000cc"
    databg Data cell background colour, a comma separated list. Specify "none" for no colour, that is to use the colour/background of the page the table is on. "#edf4f9,#ffffff" databg="#f2f2f2,#ffffff"
    databgsorted Data cell background colour of a sorted column; see databg. the values of databg databgsorted="#d4e8e4,#e5f5ea"
    datacolor Data cell text colour, a comma separated list. unspecified datacolor="#0000CC, #000000"
    tableborder Table border width (pixels). "1" tableborder="2"
    tableframe Table frame, set to "void" (no sides), "above" (the top side only), "below" (the bottom side only), "hsides" (the top and bottom sides only), "lhs" (the left-hand side only), "rhs" (the right-hand side only), "vsides" (the right and left sides only), "box" (all four sides), "border" (all four sides). unspecified tableframe="hsides"
    tablerules Table rules, set to "none" (no rules), "groups" (rules will appear between row groups and column groups only), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). unspecified tablerules="rows"
    cellpadding Cell padding (pixels). "0" cellpadding="0"
    cellspacing Cell spacing (pixels). "0" cellspacing="3"
    cellborder Cell border width (pixels). unspecified cellborder="0"
    valign Vertical alignment of cells and headers, set to "top", "middle", "bottom" or "baseline". unspecified valign="top"
    headervalign Vertical alignment of header cells; overrides valign. unspecified headervalign="top"
    datavalign Vertical alignment of data cells; overrides valign. unspecified datavalign="top"
    headeralign Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified headeralign="left,right"
    dataalign Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified dataalign="center"
    tablewidth Table width: Percentage of window width, or absolute pixel value. unspecified tablewidth="100%"
    columnwidths Column widths: Comma delimited list of column widths, percentage or absolute pixel value. unspecified columnwidths="80%,20%"
    headerrows Number of header rows to exclude from sort. (will be rendered in a HTML thead section) "1" headerrows="1"
    footerrows Number of footer rows to exclude from sort. (will be rendered in a HTML tfoot section) "0" footerrows="1"
    id Unique table identifier string, used for targeting a table with CSS. tableN (where N is the table order number on the page) id="userTable"
    summary Table summary used by screenreaders: A summary of what the table presents. It should provide an orientation for someone who listens to the table. unspecified summary="List of subscribed users"
    caption Table caption: A title that will be displayed just above the table. unspecified caption="Users"

  • Example:
    %TABLE{ tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" }%
    | *A1* | *B1* |
    | A2 | B2 |
  • Related: See TablePlugin for more details

TEAL -- start teal colored text

  • TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %TEAL% teal text %ENDCOLOR%
  • Expands to: teal text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

  • 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
  • Syntax: %TOC{"SomeTopic" ...}%
  • 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
  • TIP Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
  • Related: TOC

TOPIC -- name of current topic

  • %TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic.
  • Syntax: %TOPIC%
  • Expands to: TWikiVariables, renders as TWikiVariables
  • Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB

TOPICLIST{"format"} -- topic index of a web

  • List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The $topic variable gets expanded to the topic name, $marker to marker parameter where topic matches selection, and $web to the name of the web, or any of the standard FormatTokens.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "format" Format of one line, may include $web (name of web), $topic (name of the topic), $marker (which expands to marker for the item matching selection only) "$topic"
    format="format" (Alternative to above) "$topic"
    separator=", " line separator "$n" (new line)
    marker="selected" Text for $marker if the item matches selection "selected"
    selection="TopicA, TopicB" Current value to be selected in list (none)
    web="Name" Name of web Current web
  • Example: %TOPICLIST{"   * $web.$topic"}% creates a bullet list of all topics
  • Example: %TOPICLIST{separator=", "}% creates a comma separated list of all topics
  • Example: %TOPICLIST{" <option>$topic</option>"}% creates an option list (for drop down menus)
  • Example: <select>%TOPICLIST{" <option $marker value='$topic'>$topic</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected
  • Related: SEARCH, WEBLIST

TOPICURL -- shortcut to viewing the current topic

TWIKIWEB -- synonym for SYSTEMWEB

  • Deprecated. Please use %SYSTEMWEB% instead.

U -- "updated" icon

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

  • Returns the value of a URL parameter.
  • 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. See ENCODE for more details. no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 no encoding
    encode="quote" Escape double quotes with backslashes (\"), does not change other characters; required when feeding URL parameters into other TWiki variables 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
  • ALERT! Notes:
    • URL parameters passed into HTML form fields must be entity ENCODEd.
    • Double quotes in URL parameters must be escaped when passed into other TWiki variables.
      Example: %SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }%
    • When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
    • Watch out for TWiki internal parameters, such as rev, skin, template, topic, web; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts.
    • If you have %URLPARAM{ in the value of a URL parameter, it will be modified to %<nop>URLPARAM{. This is to prevent an infinite loop during expansion.
    • There is a risk that this variable could be misused for cross-site scripting.
  • Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING

USERINFO{"name"} -- retrieve details about a user

  • Syntax: %USERINFO%
  • Expands to: guest, TWikiGuest, (comma-separated list of the username, wikiusername, and emails)
  • With formatted output, using tokens $emails, $username, $wikiname, $wikiusername, $groups and $admin ($admin returns 'true' or 'false'):
    • Example: %USERINFO{ format="$username is really $wikiname" }%
    • Expands to: guest is really TWikiGuest
  • Retrieve information about another user:
    • Example: %USERINFO{ "TWikiGuest" format="$username is really $wikiname" }%
    • Expands to: guest is really TWikiGuest
    • Note: The parameter should be the wikiname of a user. Since TWiki 4.2.1, you can also pass a login name. You can only get information about another user if the {AntiSpam}{HideUserDetails} configuration option is not enabled, or if you are an admin. (User details are hidden in this TWiki)
  • Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress

USERNAME -- your login username

USERSWEB -- name of users web

  • The web containing individual user topics, TWikiGroups, and customised site-wide preferences.
  • Syntax: %USERSWEB%
  • Expands to: Main
  • Related: SYSTEMWEB

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 #FFEFA6
  • Related: WEBPREFSTOPIC

VBAR -- vertical bar

WEB -- name of current web

  • %WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web where the included topic is located.
  • Syntax: %WEB%
  • Expands to: TWiki
  • Related: BASEWEB, INCLUDINGWEB, TOPIC

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

  • List of all webs. Obfusticated 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 (the name of the web), $qname (the name of the web in double quotes), $indentedname (the name of the web with parent web names replaced by indents, for use in indented lists), and $marker (which expands to marker for the item matching selection only) "$name"
    format="format" (Alternative to above) "$name"
    separator=", " Line separator "$n" (new line)
    web="" if you specify $web in format, it will be replaced with this ""
    webs="public" Comma separated list of webs, public expands to all non-hidden.
    NOTE: Administrators will see all webs, not just the public ones     		"public"
    marker="selected" Text for $marker if the item matches selection "selected"
    selection="%WEB%" Current value to be selected in list selection="%WEB%"
    subwebs="Sandbox" show webs that are a sub-web of this one (recursivly) ""
  • Example: %WEBLIST{"   * [[$name.WebHome]]"}% - creates a bullet list of all webs.
  • Example: <form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form> - creates a dropdown of all public webs + Trash web, with the current web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WHITE -- start white colored text

  • WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %WHITE% white text %ENDCOLOR%
  • Expands to: white text  (shown with a gray background here)
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors

WIKIHOMEURL -- site home URL

  • Syntax %WIKIHOMEURL%
  • Expands to /twiki/bin/view
  • Defined in TWikiPreferences and normally per default set to %SCRIPTURLPATH{"view"}%
  • ALERT! Note: For the top bar logo URL use %WIKILOGOURL% defined in WebPreferences instead.
  • 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

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

X -- warning icon

Y -- "yes" icon

YELLOW -- start yellow colored text

  • YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
  • Syntax: %YELLOW% yellow text %ENDCOLOR%
  • Expands to: yellow text
  • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
  • Related: ENDCOLOR, TWikiPreferences, StandardColors
 
Changed:
<
<
>
>
  Related Topics: UserDocumentationCategory

Revision 7927 Mar 2005 - Main.TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 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.
>
>		TWikiVariables are text strings - %VARIABLE% or %VARIABLE{ parameter="value" }% - that expand into content whenever a topic is rendered for viewing. There are two types of variables:
  1. Preferences variables: Can be defined and changed by the user
  2. Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a %CALC{}% variable)

Using Variables

To use a variable type its name. For example,

  • type %T% to get TIP (a preferences variable)
  • type %TOPIC% to get TWikiVariables (a predefined variable)
  • type %CALC{ "$UPPER(Text)" }% to get TEXT (a variable defined by Plugin)

Note:

  • 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
  • Type %ALLVARIABLES% to get a full listing of all variables defined for a particular topic
 
Deleted:
<
<		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.
 
Changed:
<
<

Predefined Variables

>
>

Preferences Variables

 
Changed:
<
<		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.
>
>		Unlike predefined variables, preferences variables can be defined by the user in various places.
 
Changed:
<
<
  • 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%.
>
>

Setting Preferences Variables

You can set variables in all the following places:
  1. local site level in TWikiPreferences
  2. user level in individual user topics in Main web
  3. web level in WebPreferences of each web
  4. topic level in topics in webs
  5. plugin topics (see TWikiPlugins)
  6. session variables (if sessions are enabled)

Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.

The syntax for setting 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] = [space] value

Examples:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.
Example: 
	* Set VARIABLENAME = value starts here
	  and continues here
 
Changed:
<
<		This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - expands the following variables (enclosed in % percent signs):
>
>		Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
 
Changed:
<
<

Warning: Can't find topic TWiki.TWikiVariablesAtoM

Warning: Can't find topic TWiki.TWikiVariablesNtoZ

>
>
Example: Create a custom logo variable
  • To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences topic, 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, e.g. LogoTopic. Sample variable setting in WebPreferences:
    • Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif
 
Changed:
<
<		Note: Above text is included from TWikiVariablesAtoM? and TWikiVariablesNtoZ?
>
>		You can also set preferences variables on a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are not visible in the topic text, but take effect nevertheless.
 
Added:
>
>

Access Control Variables

 
Changed:
<
<

Preferences Variables

>
>		These are special types of preferences variables to control access to content. TWikiAccessControl explains these security settings in detail.
 
Changed:
<
<		Additional variables are defined in the preferences topics:

Variable: Level: What: Expands to:
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl) TWikiAdminGroup  
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl) TWikiAdminGroup?  
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the TWiki web. (More in TWikiAccessControl) TWikiAdminGroup  
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl) 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:  
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl) %DENYTOPICCHANGE%  
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl) %DENYTOPICRENAME%  
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl) %DENYWEBCHANGE%  
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl) %DENYWEBRENAME%  
%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:  
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20 20  
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70 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% width:99%  
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, ALLOWWEBRENAME, DENYWEBRENAME  
%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.  
%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 ) %NEWTOPICBGCOLOR%  
%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views ) %NEWTOPICFONTCOLOR%  
%NOSEARCHALL% WL 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: %RELEASEEDITLOCKCHECKBOX% %RELEASEEDITLOCKCHECKBOX%  
%WEBBGCOLOR% WL Background color of web #FFD8AA  
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics) This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables  
%WEBTOPICLIST% WL Common links of web (second line of topics) Welcome  |  Register  |  Changes  |  Topics  |  Index  |  Search  |  Go  
%WIKIWEBLIST% SL List of TWiki webs (in upper right corner of topics) Main  |  TWiki  |  Sandbox?  
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is twiki@ufba.br twiki@ufba.br  
>
>

Local values for variables

Certain topics (a users home topic, web site and default preferences topics) have a problem; variables defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the variable definition. For example, if the user sets the following in their home topic: 
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then when they are editing any other topic, they will get a 10 high edit box. However when they are editing their home topic, they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all variables in their evaluation order, so you can see variable scope if you get confused.

Frequently Used Preferences Variables

The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings:

  • %BR% - line break
  • %BULLET% - bullet sign
  • %BB% - line break and bullet combined
  • %BB2% - indented line break and bullet
  • %RED% text %ENDCOLOR% - colored text (also %YELLOW%, %ORANGE%, %PINK%, %PURPLE%, %TEAL%, %NAVY%, %BLUE%, %AQUA%, %LIME%, %GREEN%, %OLIVE%, %MAROON%, %BROWN%, %BLACK%, %GRAY%, %SILVER%, %WHITE%)
  • %H% - HELP Help icon
  • %I% - IDEA! Idea icon
  • %M% - MOVED TO... Moved to icon
  • %N% - NEW New icon
  • %P% - REFACTOR Refactor icon
  • %Q% - QUESTION? Question icon
  • %S% - PICK Pick icon
  • %T% - TIP Tip icon
  • %U% - UPDATED Updated icon
  • %X% - ALERT! Alert icon
  • %Y% - DONE Done icon
 
Changed:
<
<		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.
>
>		There are additional useful preferences variables defined in TWikiPreferences, in Main.TWikiPreferences, and in WebPreferences of every web.
 
Changed:
<
<

Setting Preferences

>
>

Predefined Variables

 
Changed:
<
<
  • 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
>
>		Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH%, are powerful and general tools.
 
Changed:
<
<

Creating Custom Variables

>
>
  • ALERT! Predefined variables can be overridden by preferences variables
  • ALERT! Plugins may extend the set of predefined variables (see individual Plugins topics for details)
  • 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%.
 
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.
>
>		This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - predefines the following variables:
 
Changed:
<
<
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
>
>

Warning: Can't find topic TWiki.TWikiVariablesAtoM

Warning: Can't find topic TWiki.TWikiVariablesNtoZ

 
Deleted:
<
<		-- TWiki:Main.PeterThoeny - 14 Aug 2004
-- TWiki:Main.MikeMannix - 12 May 2002
 
Changed:
<
<		Crawford split up this topic into included TWikiVariablesAtoM? and TWikiVariablesNtoZ? .

-- PeterThoeny - 26 Jul 2004

>
>		Related Topics: UserDocumentationCategory
 

Revision 7814 Aug 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - 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 14:13
  • 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 2025-10-31T17:13:29Z
    $rcs RCS format timestamp 2025/10/31 17:13:29
    $http E-mail & http format timestamp Fri, 31 Oct 2025 17:13:29 GMT
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 31 Oct, 2025 - 17:13:29
  • 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 bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip
  • Example: %ICON{"pdf"}% expands to pdf
  • 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://twiki.ufba.br/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 TWiki

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

SCRIPTURLPATH -- script URL path of TWiki

SCRIPTSUFFIX -- script suffix

  • Some TWiki 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 14:13
  • 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 TWiki
  • 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 #FFEFA6
  • 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 TWiki, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: /twiki/bin/view
  • 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 TWiki 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: TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
  • Related: WIKITOOLNAME
>
>

Warning: Can't find topic TWiki.TWikiVariablesAtoM

Warning: Can't find topic TWiki.TWikiVariablesNtoZ

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:
>
>
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 TWiki web. (More in TWikiAccessControl)
Added:
>
>
TWikiAdminGroup  
 
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the TWiki 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 TWiki web. (More in TWikiAccessControl)
Added:
>
>
%DENYWEBCHANGE%  
 
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
Added:
>
>
%DENYWEBRENAME%  
 
%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 20
Added:
>
>
20  
 
%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:
>
>
NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, ALLOWWEBRENAME, DENYWEBRENAME  
 
%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:
>
>
%NEWTOPICBGCOLOR%  
 
%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views )
Added:
>
>
%NEWTOPICFONTCOLOR%  
 
%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: %RELEASEEDITLOCKCHECKBOX%
Added:
>
>
%RELEASEEDITLOCKCHECKBOX%  
 
%WEBBGCOLOR% WL Background color of web
Added:
>
>
#FFD8AA  
 
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
Added:
>
>
This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables  
 
%WEBTOPICLIST% WL Common links of web (second line of topics)
Added:
>
>
Welcome  |  Register  |  Changes  |  Topics  |  Index  |  Search  |  Go  
 
%WIKIWEBLIST% SL List of TWiki webs (in upper right corner of topics)
Added:
>
>
Main  |  TWiki  |  Sandbox?  
 
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is twiki@ufba.br
Added:
>
>
twiki@ufba.br  
 
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

 

Revision 7709 May 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 18 to 18
  This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - expands the following variables (enclosed in % percent signs):
Changed:
<
<
Variable: Expanded to:
%WIKIHOMEURL% The base script URL of TWiki, is the link of the Home icon in the upper left corner, is /twiki/bin/view
%SCRIPTURL% The script URL of TWiki, is http://twiki.ufba.br/twiki/bin
%SCRIPTURLPATH% The path of the script URL of TWiki, is /twiki/bin
%SCRIPTSUFFIX% The script suffix, ex: .pl, .cgi is
%PUBURL% The public URL of TWiki, is http://twiki.ufba.br/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 TWiki, is /twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://twiki.ufba.br/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 bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns pdf
%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 14:13
  • 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 - TWiki
%WIKIVERSION% Your current TWiki version - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
%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 TWiki - 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 Oct 2025 - 17:13
%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 2025-10-31T17:13:29Z
$rcs RCS format timestamp 2025/10/31 17:13:29
$http E-mail & http format timestamp Fri, 31 Oct 2025 17:13:29 GMT
Changed:
<
<		 Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Oct, 2025 - 17:13:29
%SERVERTIME% Server time, is 31 Oct 2025 - 14:13
%SERVERTIME{"format"}% Formatted server time. Same format qualifiers as %GMTIME%
Example: %SERVERTIME{"$hou:$min"}% is 14:13
%DISPLAYTIME% Display time, is 31 Oct 2025 - 14:13
%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 14:13
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 216.73.216.131
%REMOTE_PORT% REMOTE_PORT environment variable, is 20758
%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 Oct, 2025 - 17:13:29
  • 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 bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip
  • Example: %ICON{"pdf"}% expands to pdf
  • 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://twiki.ufba.br/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 TWiki

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

SCRIPTURLPATH -- script URL path of TWiki

SCRIPTSUFFIX -- script suffix

  • Some TWiki 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 14:13
  • 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 #FFEFA6
>
>
"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 TWiki
  • 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 #FFEFA6
  • 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 TWiki, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: /twiki/bin/view
  • 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 TWiki 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: TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
  • 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 twiki@ufba.br
%WIKIWEBLIST% SL List of TWiki 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 TWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
 
WL
Changed: <
<
Background color of web
%NOSEARCHALL%
>
>
List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
%ATTACHLINKBOX% SL , UL Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%DENYWEBCHANGE%
 
WL
Changed: <
<
Exclude web from a web="all" search (set variable to on for hidden webs)
%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 TWiki web. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the TWiki 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 20
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: %RELEASEEDITLOCKCHECKBOX%
%DONTNOTIFYCHECKBOX% SL , UL Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%ATTACHLINKBOX% SL , UL Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
>
>
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
 
%HTTP_EQUIV_ON_EDIT% SL , UL http-equiv meta tags for edit script.
Changed: <
<>
>  
%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.
Changed: <
<
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the TWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the TWiki web. (More in TWikiAccessControl)
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%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 TWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME%
>
>
Exclude web from a web="all" search (set variable to on for hidden webs)
%RELEASEEDITLOCKCHECKBOX% SL , UL Default state of the "Release edit lock" (UnlockTopic? ) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: %RELEASEEDITLOCKCHECKBOX%
%WEBBGCOLOR%
 
WL
Changed: <
<
List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%FINALPREFERENCES%
>
>
Background color of web
%WEBCOPYRIGHT%
 
SL , WL
Changed: <
<
List of preferences that are not allowed to be overridden by next level preferences
>
>
Copyright notice (bottom right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WIKIWEBLIST% SL List of TWiki webs (in upper right corner of topics)
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is twiki@ufba.br
  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

Revision 7601 Apr 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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.

Revision 7517 Mar 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 2025-10-31T17:13:29Z
$rcs RCS format timestamp 2025/10/31 17:13:29
$http E-mail & http format timestamp Fri, 31 Oct 2025 17:13:29 GMT
  Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Oct, 2025 - 17:13:29
%SERVERTIME% Server time, is 31 Oct 2025 - 14:13
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 14:13
>
>
Formatted server time. Same format qualifiers as %GMTIME%
Example: %SERVERTIME{"$hou:$min"}% is 14:13
%DISPLAYTIME% Display time, is 31 Oct 2025 - 14:13
%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 14:13
 
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
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

Revision 7418 Jan 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 47 to 47
 
%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns pdf
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"}%

Revision 7318 Jan 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 16 to 16
  This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - 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

Revision 7216 Jan 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 47 to 47
 
%ICON{"type"}% Small 16x16 pixel icon of common attachment types, like bmp bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns pdf
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 - TWiki
Line: 202 to 209
 
Table of Contents of current topic.
%TOC{"SomeTopic" ...}%
Changed:
<
<
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Parameters are topic name, web and depth:
>
>
Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC. Supported parameters:
 
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

Revision 7110 Jan 2004 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 pdf
>
>
Small 16x16 pixel icon of common attachment types, like bmp bmp, doc doc, gif gif, hlp hlp, html html, wav mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip, etc. Specify file type only, file name, or full path name. Example: %ICON{"pdf"}% returns pdf
 
%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:

Revision 7001 Nov 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 6928 Sep 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 pdf
%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%" }%

Revision 6829 Aug 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 6723 Aug 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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%

Revision 6623 Aug 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 pdf
%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

Revision 6530 Jun 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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 pdf
 
%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

Revision 6422 Mar 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 6308 Feb 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 295 to 295
 
SL , UL Vertical size of edit box, is 20
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: %RELEASEEDITLOCKCHECKBOX%

Revision 6227 Jan 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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):

Revision 6119 Jan 2003 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 6011 Dec 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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)

Revision 5923 Nov 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 5805 Oct 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 5725 Aug 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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%

Revision 5604 Jun 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 5524 May 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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=

Revision 5417 May 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 33 to 33
 
The script suffix, ex: .pl, .cgi is
%PUBURL%
Changed:
<
<
The public URL of TWiki, is http://twiki.ufba.br/twiki/pub
>
>
The public URL of TWiki, is http://twiki.ufba.br/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 TWiki, 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 - TWiki

Revision 5315 May 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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/"}%

Revision 5212 May 2002 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 5107 Apr 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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/"}%

Revision 5008 Mar 2002 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 4916 Feb 2002 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 4823 Jan 2002 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="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

Revision 4706 Jan 2002 - MikeMannix

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

This version of TWiki - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396 - 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 TWiki
>
>
The name of your TWiki site - TWiki
 
%WIKIVERSION%
Changed:
<
<
Wiki tool version is TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
>
>
Your current TWiki version - TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
 
%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 TWiki is TWiki
>
>
The web containing all documentation and site-wide preference settings for TWiki - 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

Revision 4602 Dec 2001 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Line: 16 to 16
  TWiki 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

Revision 4530 Nov 2001 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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.
  TWiki 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

Revision 4425 Oct 2001 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
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

Revision 4315 Sep 2001 - MikeMannix

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Deleted:
<
<

Warning: Can't find topic TWiki.UtilTempDocNote

 

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:
<
<		TWiki expands the following variables enclosed in % percent signs:
>
>		TWiki 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

Revision 4214 Sep 2001 - PeterThoeny

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Warning: Can't find topic TWiki.UtilTempDocNote

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

Revision 4113 Sep 2001 - JohnTalintyre

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="WebHome"
 

Warning: Can't find topic TWiki.UtilTempDocNote

Line: 40 to 41
 
The path of the public URL of TWiki, is /twiki/pub
%ATTACHURL%
Changed:
<
<
The attachment URL of the current topic, is http://twiki.ufba.br/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://twiki.ufba.br/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 Oct, 2025 - 17:13:31
>
>		 Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
31 Oct, 2025 - 17:13:31
 
%SERVERTIME% Server time, is 31 Oct 2025 - 14:13
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 14:13
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 14:13
 
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
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 #FFEFA6
Line: 332 to 346
 

Setting Preferences

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

Creating Custom Variables

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

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

Revision 4012 Sep 2001 - MikeMannix

Line: 1 to 1
Added:
>
>

Warning: Can't find topic TWiki.UtilTempDocNote

 

TWiki Variables

Revision 3907 Sep 2001 - MikeMannix

Line: 1 to 1
 
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.

Revision 3807 Sep 2001 - MikeMannix

Line: 1 to 1
 
On this page:

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

Revision 3701 Sep 2001 - MikeMannix

Line: 1 to 1
 
On this page:

TWiki Variables

Changed:
<
<		TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
>
>		TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables are replaced by their actual values. TWiki has two types of variable, predefined and Preference-based, where usually you determine the content. Through Preference variables, you can also define custom variables, creating new variable name and value. TWiki variables are as simple to use as they are powerful, and vice versa!
 

Predefined Variables

Added:
>
>		With a couple of notable exceptions, predefined variables return set values that are defined one-time on installation and left alone. Most are directory names and file paths, customized for your server, and only have to be updated once in the main configuration file if your server set-up changes.
 TWiki expands the following variables enclosed in % percent signs:
Changed:
<
<
Variable: Expanded to:
>
>
Variable: Expanded to:
 
%WIKIHOMEURL% The base script URL of TWiki, is the link of the Home icon in the upper left corner, is /twiki/bin/view
Line: 203 to 206
 
%VAR{"NAME" web="Web"}% Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFEFA6
Deleted:
<
<
 
Added:
>
>
 [1] Note: The search form uses identical names for input fields.

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

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

Revision 3631 Aug 2001 - MikeMannix

Line: 1 to 1
 
On this page:

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

Revision 3530 Aug 2001 - MikeMannix

Line: 1 to 1
 
On this page:

TWiki Variables

About Variables

Changed:
<
<		Include/write if not found elsewhere.
>
>		TWikiVariables are text strings enclosed in percentage signs: %VARIABLE% that represent stored data. When a topic is rendered for viewing, defined variables replaced by their actual values. TWiki has two types of variable, predefined, and Preference-based, where you can change settings. Through Preference variables, you can even define custom variables. Clearly, they are a power TWiki feature.
 

Predefined Variables

Line: 24 to 24
 
The path of the script URL of TWiki, is /twiki/bin
%SCRIPTSUFFIX%
Changed:
<
<
The script suffix, i.e. .pl, is
>
>
The script suffix, ex: .pl, .cgi is
 
%PUBURL% The public URL of TWiki, is http://twiki.ufba.br/twiki/pub
Line: 39 to 39
 
The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}%
Changed:
<
<
Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
>
>
Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
 
%WIKITOOLNAME% Name of wiki tool, is TWiki
%WIKIVERSION%
Changed:
<
<
Wiki tool version, is TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
>
>
Wiki tool version is TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
 
%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 TWiki. Is TWiki
>
>
The web containing all documentation and configuration of TWiki is TWiki
 
%WEB%
Changed:
<
<
The current web, is TWiki
>
>
The current web is TWiki
 
%BASEWEB% The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include.
Line: 320 to 320
 
SL , WL List of preferences that are not allowed to be overridden by next level preferences
Changed:
<
<

Setting and Creating New Preferences

>
>

Setting Variable Preferences

 
  • The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
    [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
    Example:
    • Set VARIABLENAME = value
Changed:
<
<
  • You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, images.
    Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
>
>

Creating Custom Variables

  • You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.
    Example: To place a logo anywhere in a web by typing %MYLOGO%, define the variable in the web's WebPreferences topic, like this (in this case, you also have to upload logo.gif to the same directory):
 
    • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif
Changed:
<
<		-- MikeMannix? - 26 Aug 2001
>
>		-- MikeMannix? - 30 Aug 2001

Revision 3430 Aug 2001 - MikeMannix

Line: 1 to 1
 
On this page:

TWiki Variables

Revision 3328 Aug 2001 - MikeMannix

Line: 1 to 1
 
On this page:

TWiki Variables

Added:
>
>

About Variables

Include/write if not found elsewhere.

 

Predefined Variables

TWiki 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

Revision 3227 Aug 2001 - MikeMannix

Line: 1 to 1
 
On this page:

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

Revision 3126 Aug 2001 - MikeMannix

Line: 1 to 1
Added:
>
>
 

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

Revision 3015 Aug 2001 - PeterThoeny

Line: 1 to 1
 

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

Revision 2907 Aug 2001 - JohnTalintyre

Line: 1 to 1
 

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 Oct 2025 - 17:13
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 TWiki web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the TWiki web. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
 
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences

Revision 2823 Jul 2001 - PeterThoeny

Line: 1 to 1
 

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

Revision 2714 Jul 2001 - PeterThoeny

Line: 1 to 1
 

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

Revision 2611 Jul 2001 - PeterThoeny

Line: 1 to 1
 

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

Revision 2525 Jun 2001 - PeterThoeny

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

Revision 2407 Jun 2001 - PeterThoeny

Line: 67 to 67
 
%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 Oct 2025 - 17:13

Revision 2301 Jun 2001 - PeterThoeny

Line: 31 to 31
 
%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 TWiki

Revision 2225 Mar 2001 - PeterThoeny

Line: 118 to 118
 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

Revision 2116 Mar 2001 - PeterThoeny

Line: 1 to 1
Added:
>
>

TWiki Variables

Predefined Variables

 TWiki 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 #FFEFA6
>
>
Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #FFEFA6
 

[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

Revision 2001 Mar 2001 - PeterThoeny

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

Revision 1920 Jan 2001 - PeterThoeny

Line: 42 to 42
 
%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 Oct 2025 - 17:13
%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 Oct, 2025 - 17:13:32
 
%SERVERTIME% Server time, is 31 Oct 2025 - 14:13
%SERVERTIME{"format"}%
Changed:
<
<
Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
>
>
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 14:13
 
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br

Revision 1820 Jan 2001 - PeterThoeny

Line: 94 to 94
 
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

Revision 1716 Jan 2001 - PeterThoeny

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

Revision 1618 Dec 2000 - PeterThoeny

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

Revision 1515 Dec 2000 - PeterThoeny

Line: 12 to 12
 
%SCRIPTURLPATH% The path of the script URL of TWiki, is /twiki/bin
Added:
>
>
%SCRIPTSUFFIX% The script suffix, i.e. .pl, is
 
%PUBURL% The public URL of TWiki, is http://twiki.ufba.br/twiki/pub

Revision 1414 Dec 2000 - PeterThoeny

Line: 34 to 34
 
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):

Revision 1310 Nov 2000 - PeterThoeny

Line: 1 to 1
Changed:
<
<		TWiki expands the following variables enclosed in % percent signs:
>
>		TWiki 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 /twiki/bin/view
>
>
The base script URL of TWiki, is the link of the Home icon in the upper left corner, is /twiki/bin/view
 
%SCRIPTURL%
Changed:
<
<
The script URL of TWiki, is http://twiki.ufba.br/twiki/bin
>
>
The script URL of TWiki, is http://twiki.ufba.br/twiki/bin
 
%SCRIPTURLPATH%
Changed:
<
<
The path of the script URL of TWiki, is /twiki/bin
>
>
The path of the script URL of TWiki, is /twiki/bin
 
%PUBURL% The public URL of TWiki, is http://twiki.ufba.br/twiki/pub
%PUBURLPATH%
Changed:
<
<
The path of the public URL of TWiki, is /twiki/pub
>
>
The path of the public URL of TWiki, is /twiki/pub
 
%ATTACHURL% The attachment URL of the current topic, is http://twiki.ufba.br/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 #FFEFA6
>
>
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 #FFEFA6
 
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 TWiki web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the TWiki web. (More in TWikiAccessControl)
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
 

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

Revision 1202 Nov 2000 - PeterThoeny

Line: 87 to 87
 
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 #FFEFA6
 

[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

Revision 1119 Sep 2000 - PeterThoeny

Line: 120 to 120
 
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

Revision 1019 Sep 2000 - PeterThoeny

Line: 42 to 42
 
%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 Oct 2025 - 17:13
Line: 142 to 145
 
http-equiv meta tags for preview script.
Changed:
<
<		-- PeterThoeny - 17 Aug 2000
>
>		-- PeterThoeny - 18 Sep 2000

Revision 918 Aug 2000 - PeterThoeny

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

Revision 828 Jul 2000 - PeterThoeny

Line: 34 to 34
 
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 Oct 2025
 
%GMTIME%
Changed:
<
<
Todays date (GM time), is 31 Oct 2025 - 17:13
>
>
GM time, is 31 Oct 2025 - 17:13
%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 Oct 2025 - 14:13
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
 
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
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:

Revision 729 May 2000 - PeterThoeny

Line: 43 to 43
 
The current topic name, is TWikiVariables
%DATE%
Changed:
<
<
Todays date, is 31 Oct 2025
>
>
Todays date (local server time), is 31 Oct 2025
%GMTIME% Todays date (GM time), is 31 Oct 2025 - 17:13
 
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
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

Revision 622 Apr 2000 - PeterThoeny

Line: 4 to 4
 
Variable: Expanded to:
%WIKIHOMEURL%
Changed:
<
<
The base script URL of TWiki, link of Home icon in upper left corner is /twiki/bin/view
>
>
The base script URL of TWiki, link of Home icon in upper left corner, is /twiki/bin/view
 
%SCRIPTURL% The script URL of TWiki, is http://twiki.ufba.br/twiki/bin
Line: 45 to 45
 
%DATE% Todays date, is 31 Oct 2025
Added:
>
>
%HTTP_HOST% HTTP_HOST environment variable, is twiki.ufba.br
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 216.73.216.131
%REMOTE_PORT% REMOTE_PORT environment variable, is 20758
%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

Revision 521 Mar 2000 - PeterThoeny

Line: 93 to 93
 
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20
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:
 

Revision 401 Mar 2000 - PeterThoeny

Line: 7 to 7
 
The base script URL of TWiki, link of Home icon in upper left corner is /twiki/bin/view
%SCRIPTURL%
Changed:
<
<
The base script URL of TWiki, is http://twiki.ufba.br/twiki/bin
>
>
The script URL of TWiki, is http://twiki.ufba.br/twiki/bin
%SCRIPTURLPATH% The path of the script URL of TWiki, is /twiki/bin
 
%PUBURL%
Changed:
<
<
The base public URL of TWiki, is http://twiki.ufba.br/twiki/pub
>
>
The public URL of TWiki, is http://twiki.ufba.br/twiki/pub
%PUBURLPATH% The path of the public URL of TWiki, is /twiki/pub
 
%ATTACHURL% The attachment URL of the current topic, is http://twiki.ufba.br/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 TWiki

Revision 328 Feb 2000 - PeterThoeny

Line: 15 to 15
 
%ATTACHURL% The attachment URL of the current topic, is http://twiki.ufba.br/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 twiki@ufba.br
 
%WIKITOOLNAME% Name of wiki tool, is TWiki
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 twiki@ufba.br
%WIKIWEBLIST% SL List of TWiki webs (in upper right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBBGCOLOR% WL Background color of web
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20

Revision 230 Jan 2000 - PeterThoeny

Line: 39 to 39
 
%DATE% Todays date, is 31 Oct 2025
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"}%
 

Revision 113 Jun 1999 - 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 /twiki/bin/view
%SCRIPTURL% The base script URL of TWiki, is http://twiki.ufba.br/twiki/bin
%PUBURL% The base public URL of TWiki, is http://twiki.ufba.br/twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://twiki.ufba.br/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 twiki@ufba.br
%WIKITOOLNAME% Name of wiki tool, is TWiki
%WIKIVERSION% Wiki tool version, is TWiki-4.2.2, Wed, 06 Aug 2008, build 17396
%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 Oct 2025
%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"%
View topic | History: r84 < r83 < r82 < r81 | More topic actions...
 
This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariables