r1 - 14 Mar 2006 - 16:37:44 - TWikiContributorYou are here: Astrophysics Wiki >  TWiki Web  > TWikiVariablesQuickStart

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

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

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r1 | More topic actions

key Log In or Register
Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen





 
Astrophysics Wiki


Edit Wysiwyg Attach Printable
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 Astrophysics Wiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiVariablesQuickStart