Skip to topic | Skip to bottom
Powered by TWiki

TWiki

Log In

You are here: TWiki > TWikiVariables
r0 - 27 Mar 2005 - 13:14 - TWikiContributor


TMPL:P{"i18n:start_of_topic"}% | TMPL:P{"i18n:skip_to_actions"}%

TWiki Variables

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

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

Most predefined variables return values that were either set in the configuration 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.

  • 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 - Mon, 29 Aug 2005 build 6193 - expands the following variables (enclosed in % percent signs):

ACTIVATEDPLUGINS -- list of currently activated plugins

ATTACHURL -- full URL for attachments in the current topic

  • Syntax: %ATTACHURL%
  • Expands to: http://www.socialscience-ed.org/pages/pub/TWiki/TWikiVariablesAtoM
  • Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
  • Related: ATTACHURLPATH, PUBURLPATH, SCRIPTURL, FileAttachments

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

DATE - signature format date

warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in configure. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 22:48
  • 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 " 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

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

  • Syntax: %FAILEDPLUGINS%
  • Expands to: =
    PluginErrors
    CommentPluginnone
    InterwikiPlugin 
    Plugins: could not fully register InterwikiPlugin, no plugin topic
TWiki::Plugins::InterwikiPlugin could not be loaded.  Errors were: 
Can't locate TWiki/Plugins/InterwikiPlugin.pm in @INC (@INC contains: /www/data/ssec/pages/lib . /usr/local/lib/perl5/5.8.7/i386-freebsd /usr/local/lib/perl5/5.8.7 /usr/local/lib/perl5/site_perl/5.8.7/i386-freebsd /usr/local/lib/perl5/site_perl/5.8.7 /usr/local/lib/perl5/site_perl/5.8.2 /usr/local/lib/perl5/site_perl/5.8.0 /usr/local/lib/perl5/site_perl/5.6.1 /usr/local/lib/perl5/site_perl/5.005 /usr/local/lib/perl5/site_perl) at (eval 28) line 1.
BEGIN failed--compilation aborted at (eval 28) line 1.

----
    PreferencesPlugin 
    Plugins: could not fully register PreferencesPlugin, no plugin topic
TWiki::Plugins::PreferencesPlugin could not be loaded.  Errors were: 
Can't locate TWiki/Plugins/PreferencesPlugin.pm in @INC (@INC contains: /www/data/ssec/pages/lib . /usr/local/lib/perl5/5.8.7/i386-freebsd /usr/local/lib/perl5/5.8.7 /usr/local/lib/perl5/site_perl/5.8.7/i386-freebsd /usr/local/lib/perl5/site_perl/5.8.7 /usr/local/lib/perl5/site_perl/5.8.2 /usr/local/lib/perl5/site_perl/5.8.0 /usr/local/lib/perl5/site_perl/5.6.1 /usr/local/lib/perl5/site_perl/5.005 /usr/local/lib/perl5/site_perl) at (eval 31) line 1.
BEGIN failed--compilation aborted at (eval 31) line 1.

----
    SmiliesPlugin 
    Plugins: could not fully register SmiliesPlugin, no plugin topic
TWiki::Plugins::SmiliesPlugin could not be loaded.  Errors were: 
Can't locate TWiki/Plugins/SmiliesPlugin.pm in @INC (@INC contains: /www/data/ssec/pages/lib . /usr/local/lib/perl5/5.8.7/i386-freebsd /usr/local/lib/perl5/5.8.7 /usr/local/lib/perl5/site_perl/5.8.7/i386-freebsd /usr/local/lib/perl5/site_perl/5.8.7 /usr/local/lib/perl5/site_perl/5.8.2 /usr/local/lib/perl5/site_perl/5.8.0 /usr/local/lib/perl5/site_perl/5.6.1 /usr/local/lib/perl5/site_perl/5.005 /usr/local/lib/perl5/site_perl) at (eval 32) line 1.
BEGIN failed--compilation aborted at (eval 32) line 1.

----
    SpreadSheetPlugin 
    Plugins: could not fully register SpreadSheetPlugin, no plugin topic
TWiki::Plugins::SpreadSheetPlugin could not be loaded.  Errors were: 
Can't locate TWiki/Plugins/SpreadSheetPlugin.pm in @INC (@INC contains: /www/data/ssec/pages/lib . /usr/local/lib/perl5/5.8.7/i386-freebsd /usr/local/lib/perl5/5.8.7 /usr/local/lib/perl5/site_perl/5.8.7/i386-freebsd /usr/local/lib/perl5/site_perl/5.8.7 /usr/local/lib/perl5/site_perl/5.8.2 /usr/local/lib/perl5/site_perl/5.8.0 /usr/local/lib/perl5/site_perl/5.6.1 /usr/local/lib/perl5/site_perl/5.005 /usr/local/lib/perl5/site_perl) at (eval 33) line 1.
BEGIN failed--compilation aborted at (eval 33) line 1.

----
    HandlerPlugins
    afterAttachmentSaveHandler
    afterCommonTagsHandler
    afterEditHandler
    afterSaveHandler
    beforeAttachmentSaveHandler
    beforeCommonTagsHandler
    beforeEditHandler
    beforeSaveHandlerCommentPlugin
    commonTagsHandlerCommentPlugin
    earlyInitPlugin
    endRenderingHandler
    initPluginCommentPlugin
    initializeUserHandler
    insidePREHandler
    modifyHeaderHandler
    mergeHandler
    outsidePREHandler
    postRenderingHandler
    preRenderingHandler
    redirectCgiQueryHandler
    registrationHandler
    renderFormFieldForEditHandler
    renderWikiWordHandler
    startRenderingHandler
    writeHeaderHandler
    =

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

    • Syntax: %FORMFIELD{"fieldname"}%
    • Supported parameters:
      Parameter:Description:Default:
      "fieldname" The name of a TWiki form field required
      topic="..." Topic where form data is located. May be of the form Web.TopicName Current topic
      format="..." Format string. $value expands to the field value, and $title expands to the field title "$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

    warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

    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 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 2008-07-03T22:48Z
      $rcs RCS format timestamp 2008/07/03 22:48:37
      $http E-mail & http format timestamp Thu, 03 Jul 2008 22:48:37 GMT
      $epoch Number of seconds since 00:00 on 1st January, 1970 1215125317
      • Variables can be shortened to 3 characters
      • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 03 Jul, 2008 - 22:48:37
      • Related: DISPLAYTIME, GMTIME, SERVERTIME

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

      HOMETOPIC -- home topic in each web

      HTTP -- get HTTP headers

      Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant.

      Examples:

      %HTTP% %HTTP%
      %HTTP{"Accept-language"}% %HTTP{"Accept-language"}%
      %HTTP{"User-Agent"}% %HTTP{"User-Agent"}%

      You can see the HTTP headers your browser sends to the server on a number of sites e.g. http://www.ericgiguere.com/tools/http-header-viewer.html

      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.

      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, mp3 mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip zip
      • Example: %ICON{"pdf"}% expands to pdf
      • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics
      If the file type is not recognised, the default icon is used.

      IFCONTEXT -- conditional sections based on rendering context

      In the example above, if the context identifier 'view' is set, then THEN will be included in the topic; otherwise ELSE will be included.

      What can be included in the THEN and ELSE parameters is obviously limited by standard TWiki syntax for parameters. The best way to use this feature is to define two TWikiVariables, one for the THEN case and the other for the ELSE case. FOr example:

      The following context identifiers are available:

      idcontext
      authenticated a user is authenticated
      body_text when the body text is being processed in a view
      can_login current environment supports login
      changes in changes script (see TWikiScripts)
      diff in rdiff script (see TWikiScripts)
      edit in edit script (see TWikiScripts)
      footer_text when the footer text is being processed in a view
      header_text when the header text is being processed in a view
      inactive if active links such as 'edit' and 'attach' should be disabled
      mirror if this is a mirror
      new_topic if the topic doesn't already exist
      oops in oops script (see TWikiScripts)
      preview in preview script (see TWikiScripts)
      rss if this is an rss skin rendering
      save in save script (see TWikiScripts)
      search in search script (see TWikiScripts)
      view in view script (see TWikiScripts)
      rest in rest script (see TWikiScripts)

      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/"}%
      tip if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.       		 
      pattern="..." A RegularExpression pattern to include a subset of a topic or page none
      rev="1.2" Include a previous topic revision; N/A for URLs top revision
      warn="off" Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) on preferences setting
      Any other parameters will be defined as variables within the scope of the included topic. For example, %INCLUDE{"AnotherTopic" PONE="val 1" PTWO="val 2"}% will result in %PONE% and %PTWO% being defined within the included topic.

      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

      LOCALSITEPREFS - web.topicname of site preferences topic

      • The full name of the local site preferences topic. This topic is read for preferences before TWiki.%TWIKIPREFSTOPIC% is read.
      • Syntax: %LOCALSITEPREFS%
      • Expands to: Main.TWikiPreferences

      LOGIN -- present a full login link

      LOGOUT -- present a full logout link

      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
        "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 current topic
        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
        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

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

      • Syntax: %NOP%
      • Syntax: %NOP{...}%
      • Available in template topics only. See TWikiTemplates for details. In normal topic text, simply expands to whatever is in the curly braces (if anything).

      NOTIFYTOPIC -- name of the notify topic

      PLUGINDESCRIPTIONS -- list of plugin descriptions

      PLUGINVERSION -- the version of the TWiki Plugin API

      • This is the $TWiki::Plugins::VERSION number, also indicating the version of the Func module
      • Syntax: %PLUGINVERSION%
      • Expands to: 1.026
      • Related: PLUGINVERSION{"name"}, WIKIVERSION

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

      PUBURL -- the base URL of attachments

      • Syntax: %PUBURL%
      • Expands to: http://www.socialscience-ed.org/pages/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

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

      REMOTE_ADDR -- environment variable

      REMOTE_PORT -- environment variable

      REMOTE_USER -- environment variable

      REVINFO -- revision information of current topic

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

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

      SESSION_VARIABLE -- get, set or clear a session variable

      help The users ID is in the AUTHUSER session variable, and is read-only.

      SESSIONID -- The unique ID for this session | 88122e412684e1b05856b1c99520efc6 |

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

      SCRIPTURL -- script URL of TWiki

      • Syntax: %SCRIPTURL%
      • Expands to: http://www.socialscience-ed.org/pages/bin
      • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://www.socialscience-ed.org/pages/bin/viewauth/TWiki/TWikiVariablesNtoZ
      • 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="SSECHome, Know"
        web="all"         		Comma-separated list of webs to search. The special word all means all webs that doe not have the NOSEARCHALL variable set to on in their WebPreferences. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb". Current web
        topic="WebPreferences"
        topic="*Bug"         		Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. All topics in a web
        excludetopic="Web*"
        excludetopic="WebHome, WebChanges"         		Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. None
        type="keyword"
        type="literal"
        type="regex"         		Do a keyword search like soap "web service" -shampoo; a literal search like web service; or RegularExpression search like soap;web service;!shampoo %SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
        scope="topic"
        scope="text"
        scope="all"         		Search topic name (title); the text (body) of topic; or all (both) "text"
        order="topic"
        order="created"
        order="modified"
        order="editby"
        order=
         "formfield(name)"                 		Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; in case you want to sort across webs, create a formatted table and sort it with TablePlugin? 's initsort Sort by topic name
        limit="all"
        limit="16"         		Limit the number of results returned. This is done after sorting if order is specified All results
        date="..." limits the results to those pages with latest edit time in the given TimeInterval. 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 search header
        Topics: Changed: By:         		Show search header
        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 tag on the same line will be rendered as part of the table generated by the search, if appropriate. off
        separator=", " Line separator between hits Newline "$n"
      • Example: %SEARCH{"wiki" web="SSECHome" 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.

      SERVERTIME -- server time

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

      SERVERTIME{"format"} -- formatted server time

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

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

      SPACEDTOPIC -- topic name, spaced and URL-encoded

      • The current topic name with added spaces, for regular expression search of Ref-By
      • Syntax: %SPACEDTOPIC%
      • Expands to: TWiki%20*Variables%20*Nto%20*Z
      • Related: TOPIC
      tip This rather bizarre function is provided almost exclusively for generating URLs for searching for backlinks to topics.

      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. An optional parameter can be used to control whether the content is expanded.
      • Syntax: %STARTINCLUDE%
      • Syntax: %STARTINCLUDE{param}%
        • If param does not expand to a non-zero integer, then nothing will be included.
      • Related: INCLUDE, STOPINCLUDE

      STATISTICSTOPIC -- name of statistics topic

      STOPINCLUDE -- end position of topic text if included

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

      TOC -- table of contents of current topic

      TOC{"Topic"} -- table of contents

      • Syntax: %TOC{"SomeTopic" ...}%
      • Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
      • Supported parameters:
        Parameter:Description:Default:
        "TopicName" topic name Current topic
        web="Name" Name of web Current web
        depth="2" Limit depth of headings shown in TOC 6
        title="Some text" Title to appear at top of TOC none
      • Example: %TOC{depth="2"}%
      • Example: %TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
      • Example: see TWiki:Sandbox.TestTopicInclude
      • Related: TOC

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

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

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

      warning Note that there is a risk that this variable could be misused for cross-scripting.

      USERNAME -- your login username

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details.

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

      • Syntax: %VAR{"NAME" web="Web"}%
      • Example: To get %WEBBGCOLOR% of the SSECHome web write %VAR{"WEBBGCOLOR" web="SSECHome"}%, which expands to #E6334D
      • 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

      WIKINAME -- your Wiki username

      warning When used in a template topic, this variable will be expanded when the template is used to create new topic. See TWikiTemplates for details.

      WIKIPREFSTOPIC -- name of site-wide preferences topic

      WIKITOOLNAME -- name of your TWiki site

      WIKIUSERNAME -- your Wiki username with web prefix

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

      warning When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates for details

      WIKIUSERSTOPIC -- name of topic listing all registers users

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

      WIKIVERSION -- the version of the installed TWiki engine

      Note: Above text is included from TWikiVariablesAtoM and TWikiVariablesNtoZ

      Preferences Variables

      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 17 17  
      %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, WIKIWEBMASTER, GLOBALFINALTESTPREF1, DENYWEBCHANGE, ALLOWWEBVIEW, DENYWEBRENAME, WEBCOPYRIGHT, ALLOWWEBRENAME, ATTACHFILESIZELIMIT, DENYWEBVIEW, GLOBALFINALTESTPREF2, ALLOWWEBCHANGE, WEBTOPICLIST  
      %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 ) #FFFFCE  
      %NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views ) #0000FF  
      %NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)