TWiki Variables Quickstart
TWiki Variables are names that are enclosed in percent signs% that are expanded on the fly. Some variables take arguments, such as %INCLUDE%. For those variables, the arguments are included in curly braces ({ and }).
| Variable | In brief | Full documentation |
|---|---|---|
%TOC% |
Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. | VarTOC |
%WEB% |
The current web, is TWiki. | VarWEB |
%TOPIC% |
The current topic name, is TWikiVariablesQuickStart. | VarTOPIC |
%ATTACHURL% |
The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text. |
VarATTACHURL |
%INCLUDE{"SomeTopic"}% |
Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}% |
VarINCLUDE |
%SEARCH{"sushi"}% |
Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications. | VarSEARCH |
- Line break: Write
%BR%to start a new line. - Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colorsto get: Red and blue colors.
%ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: 
, 
, and 
, respectively. TWikiDocGraphics lists them all.
To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%. Topic revision: r2 - 2007-01-03 - TWikiContributor
Site map
TWiki web
User registration
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
 |
 |
|
|
|
|
Copyright &© 1999-2024 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.TWikiVariablesQuickStart.