Difference: TWikiVariablesQuickStart (1 vs. 3)

Revision 303 Jan 2007 - Main.TWikiContributor

Line: 1 to 1
 

TWiki Variables Quickstart

Changed:
<
<
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 }).
>
>
TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, %TOPIC% is expanded to TWikiVariablesQuickStart. Some variables can take arguments in curly braces - for example, %INCLUDE{"OtherTopic" ARG="arg"}%.

Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own TWiki Variables at the entire site, individual web, or individual topic level. For more information, go to TWikiVariables

 
Changed:
<
<
Variable In brief
<-- -->
Sorted ascending
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
%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
%INCLUDE{"SomeTopic"}% Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}% VarINCLUDE
%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
%TOPIC% The current topic name, is TWikiVariablesQuickStart.
<-- using BASETOPIC instead of TOPIC for the example because this document is normally included in TextFormattingRules -->
VarTOPIC
%WEB% The current web, is TWiki. VarWEB

TWikiPreferences defines some site-wide variables. Among them are:

  • Line break: Write %BR% to start a new line.
  • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

There are many more variables. To see them all, go to TWikiVariables.

>
>
TWiki Variables are fully expanded before any of the TWiki text formatting rules are applied.
  Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: HELP, TIP, and ALERT!, respectively. TWikiDocGraphics lists them all.

Revision 203 Jan 2007 - Main.TWikiContributor

Line: 1 to 1
 

TWiki Variables Quickstart

Line: 19 to 19
  There are many more variables. To see them all, go to TWikiVariables.
Changed:
<
<
Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"|%, and %icon{"warning"}% to get: HELP, TIP, and ALERT!. To see all of the graphics available, see TWikiDocGraphics.
>
>
Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: HELP, TIP, and ALERT!, respectively. TWikiDocGraphics lists them all.
 

tip To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

Revision 114 Mar 2006 - Main.TWikiContributor

Line: 1 to 1
Added:
>
>

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.
<-- using BASETOPIC instead of TOPIC for the example because this document is normally included in TextFormattingRules -->
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

TWikiPreferences defines some site-wide variables. Among them are:

  • Line break: Write %BR% to start a new line.
  • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

There are many more variables. To see them all, go to TWikiVariables.

Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"|%, and %icon{"warning"}% to get: HELP, TIP, and ALERT!. To see all of the graphics available, see TWikiDocGraphics.

tip To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

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