head	1.5;
access;
symbols;
locks; strict;
comment	@# @;


1.5
date	2010.05.29.14.44.30;	author TWikiContributor;	state Exp;
branches;
next	1.4;

1.4
date	2009.04.29.20.53.30;	author TWikiContributor;	state Exp;
branches;
next	1.3;

1.3
date	2008.01.22.03.21.35;	author TWikiContributor;	state Exp;
branches;
next	1.2;

1.2
date	2007.01.16.04.12.02;	author TWikiContributor;	state Exp;
branches;
next	1.1;

1.1
date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
branches;
next	;


desc
@buildrelease
@


1.5
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1259181776" format="1.1" version="5"}%
%META:TOPICPARENT{name="TWikiVariables"}%
---+ TWiki Variables Quickstart

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

Many TWiki variables are built-in, and others are predefined for your convenience. [[TWikiVariables]] describes how you can also define your own TWiki Variables at the entire site, individual web, or individual topic level. Variables are fully expanded _before_ any of the TWiki text formatting rules are applied.

*Commonly used variables:*

   * =%<nop>TOC%= : Automatically generates a [[VarTOC][table of contents]] based on headings in a topic - see the top of this page for an example.
   * =%<nop>WEB%= : The current web, is <b>%WEB%</b>.
   * =%<nop>TOPIC%= : The current topic name, is <b>%TOPIC%</b>.
   * =%<nop>ATTACHURL%= : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as =<b>%<nop>ATTACHURL%/image.gif</b>= to show the URL of the file or the image in your text.
   * =%<nop>INCLUDE{"SomeTopic"}%= : Server side include, [[VarINCLUDE][includes another topic]]. The current web is the default web. Example: =<b>%<nop>INCLUDE{"%SYSTEMWEB%.SiteMap"}%</b>=
   * =%<nop>SEARCH{"sushi"}%= : [[VarSEARCH][Inline search]] showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
   * [[TWikiDocGraphics][Documentation Graphics]]: There are many graphics available to use in your topics. Use =%<nop>ICON{"help"}%=, =%<nop>ICON{"tip"}%=, and =%<nop>ICON{"warning"}%= to get: %H%, %T%, and %X%, respectively.
   * *[[TWikiVariables][See all TWiki variables]]*.

%ICON{"tip"}% To "escape" a variable, prefix it with an exclamation mark. Write: =!%<nop>SOMEVARIABLE%= to get: !%SOMEVARIABLE%.
%STOPINCLUDE%

__Related Topics:__ UserDocumentationCategory, TWikiVariables, TWikiVariablesSearch, TextFormattingRules
@


1.4
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1239665315" format="1.1" version="4"}%
d6 1
d8 1
a8 3
TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic
is displayed. For example, =%<nop>TOPIC%= is expanded to %TOPIC%.
Some variables can take arguments in curly braces - for example, =%<nop>INCLUDE{"OtherTopic" ARG="arg"}%=.
d10 1
a10 3
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]]*
d12 8
a19 3
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 =%<nop>ICON{"help"}%=, =%<nop>ICON{"tip"}%=, and =%<nop>ICON{"warning"}%= to get: %H%, %T%, and %X%, respectively. TWikiDocGraphics lists them all.
@


1.3
log
@buildrelease
@
text
@d1 3
a3 2
%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="3"}%
---++ TWiki Variables Quickstart
d21 2
@


1.2
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="2"}%
d6 7
a12 1
TWiki Variables are names that are enclosed in percent signs =%= that are expanded on the fly. Some variables take arguments, such as =%<nop>INCLUDE%=. For those variables, the arguments are included in curly braces ({ and }).
d14 1
a14 13
| *Variable* | *In brief* | *Full documentation* |
| =%<nop>TOC%= | Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. |VarTOC |
| =%<nop>WEB%= | The current web, is <b><nop>%WEB%</b>. | VarWEB |
| =%<nop>TOPIC%= | The current topic name, is <b>%BASETOPIC%</b>. <!-- using BASETOPIC instead of TOPIC for the example because this document is normally included in TextFormattingRules --> | VarTOPIC |
| =%<nop>ATTACHURL%= | The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as =<b>%<nop>ATTACHURL%/image.gif</b>= to show the URL of the file or the image in your text. | VarATTACHURL |
| =%<nop>INCLUDE{"SomeTopic"}%= | Server side include, includes another topic. The current web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%</b>= | VarINCLUDE |
| =%<nop>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 =%<nop>BR%= to start a new line.
   * *Colored text:* Write: =%<nop>RED% Red %<nop>ENDCOLOR% and %<nop>BLUE% blue %<nop>ENDCOLOR% colors= to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.

There are many more variables. To see them all, go to *[[TWikiVariables]]*.
a17 1

@


1.1
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1142354264" format="1.1" version="1"}%
d22 1
a22 1
*Documentation Graphics:* There are many graphics available to use in your topics. Use =%<nop>ICON{"help"}%=, =%<nop>ICON{"tip"|%=, and =%<nop>icon{"warning"}%= to get: %H%, %T%, and %X%. To see all of the graphics available, see TWikiDocGraphics.
@
