Difference: TWikiVariablesQuickStart (2 vs. 3)

Revision 32007-01-03 - TWikiContributor

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

Added:

>
> is displayed. For example, %TOPIC% is expanded to TWikiVariablesQuickStart. Some variables can take arguments in curly braces - for example, %INCLUDE{"OtherTopic" ARG="arg"}%.

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
`%WEB%`	The current web, is TWiki.	VarWEB

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

Deleted:

<
<

`%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

Changed:

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

>
> TWiki Variables are fully expanded before any of the TWiki text formatting rules are applied.

Deleted:

<
<

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.

Deleted:

<
< 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 , respectively. TWikiDocGraphics lists them all.

Deleted:

<
<

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.