Difference: TWikiVariablesQuickStart (1 vs. 8)

Revision 82016-02-13 - TWikiContributor

Line: 1 to 1

META TOPICPARENT	name="TWikiVariables"

TWiki Variables Quickstart

Changed:

<
< 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="value"}%.

>
> 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="value"}%.

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.

Line: 11 to 11

%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
%WEB% : The current web, is TWiki.

Changed:

<
<

%TOPIC% : The current topic name, is TWikiVariablesQuickStart.

>
>

%TOPIC% : The current topic name, is TWikiVariablesQuickStart.

%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.
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.

Revision 72015-01-16 - TWikiContributor

Line: 1 to 1

META TOPICPARENT	name="TWikiVariables"

TWiki Variables Quickstart

Line: 16 to 16

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively.

Changed:

<
<

Use the TWiki Variables Wizard to build your variables.

>
>

Use the TWiki Variables Wizard to find and compose variables.

See all TWiki Variables.

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

Revision 62012-11-16 - TWikiContributor

  META TOPICPARENT 
 name="TWikiVariables" 

 TWiki Variables Quickstart
- META TOPICPARENT
+ name="TWikiVariables"
-<
<
+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"}%.
->
>
+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="value"}%.
 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.
  %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
  %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
  Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively.
-<
<
+ See all TWiki variables.
->
>
+ Use the TWiki Variables Wizard to build your variables.
  See all TWiki Variables.
  To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.
-<
<
+Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesSearch, TextFormattingRules
->
>
+Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesWizard, TWikiVariablesSearch, TextFormattingRules

Revision 52009-11-25 - TWikiContributor

  META TOPICPARENT 
 name="TWikiVariables" 

 TWiki Variables Quickstart
- META TOPICPARENT
+ name="TWikiVariables"
->
>
+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"}%.
-<
<
+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. 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.
-<
<
+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
->
>
+Commonly used variables:
-<
<
+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: , , and , respectively. TWikiDocGraphics lists them all.
->
>
+ %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
  %WEB% : The current web, is TWiki.
  %TOPIC% : The current topic name, is TWikiVariablesQuickStart.
  %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.
  %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
  %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
  Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively.
  See all TWiki variables.
  To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

Revision 42009-04-13 - TWikiContributor

-<
<
+ TWiki Variables Quickstart
->
>
+ META TOPICPARENT 
 name="TWikiVariables" 

 TWiki Variables Quickstart
- META TOPICPARENT
+ name="TWikiVariables"
  To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.
->
>
+Related Topics: UserDocumentationCategory, TWikiVariables, TWikiVariablesSearch, TextFormattingRules

Revision 32007-01-03 - 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 <-- -->	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: , , and , respectively. TWikiDocGraphics lists them all.

Revision 22007-01-03 - 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: , , and . 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: , , and , respectively. TWikiDocGraphics lists them all.
	To "escape" a variable, prefix it with an exclamation mark. Write: `!%SOMEVARIABLE%` to get: %SOMEVARIABLE%.

Revision 12006-03-14 - 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: , , and . To see all of the graphics available, see TWikiDocGraphics.

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

View topic | History: r8 < r7 < r6 < r5 | More topic actions...

Copyright © 1999-2025 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.