data/TWiki/TWikiVariablesQuickStart.txt,v
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/TWikiVariablesQuickStart.txt,v	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,98 @@
     1.4 +head	1.3;
     1.5 +access;
     1.6 +symbols;
     1.7 +locks; strict;
     1.8 +comment	@# @;
     1.9 +
    1.10 +
    1.11 +1.3
    1.12 +date	2008.01.22.03.21.35;	author TWikiContributor;	state Exp;
    1.13 +branches;
    1.14 +next	1.2;
    1.15 +
    1.16 +1.2
    1.17 +date	2007.01.16.04.12.02;	author TWikiContributor;	state Exp;
    1.18 +branches;
    1.19 +next	1.1;
    1.20 +
    1.21 +1.1
    1.22 +date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
    1.23 +branches;
    1.24 +next	;
    1.25 +
    1.26 +
    1.27 +desc
    1.28 +@buildrelease
    1.29 +@
    1.30 +
    1.31 +
    1.32 +1.3
    1.33 +log
    1.34 +@buildrelease
    1.35 +@
    1.36 +text
    1.37 +@%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="3"}%
    1.38 +---++ TWiki Variables Quickstart
    1.39 +
    1.40 +%STARTINCLUDE%
    1.41 +
    1.42 +TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic
    1.43 +is displayed. For example, =%<nop>TOPIC%= is expanded to %TOPIC%.
    1.44 +Some variables can take arguments in curly braces - for example, =%<nop>INCLUDE{"OtherTopic" ARG="arg"}%=.
    1.45 +
    1.46 +Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own
    1.47 +TWiki Variables at the entire site, individual web, or individual topic level. For more information,
    1.48 +go to *[[TWikiVariables]]*
    1.49 +
    1.50 +TWiki Variables are fully expanded _before_ any of the TWiki text formatting rules are applied.
    1.51 +
    1.52 +*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.53 +
    1.54 +%ICON{"tip"}% To "escape" a variable, prefix it with an exclamation mark. Write: =!%<nop>SOMEVARIABLE%= to get: !%SOMEVARIABLE%.
    1.55 +%STOPINCLUDE%
    1.56 +@
    1.57 +
    1.58 +
    1.59 +1.2
    1.60 +log
    1.61 +@buildrelease
    1.62 +@
    1.63 +text
    1.64 +@d1 1
    1.65 +a1 1
    1.66 +%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="2"}%
    1.67 +d6 7
    1.68 +a12 1
    1.69 +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 }).
    1.70 +d14 1
    1.71 +a14 13
    1.72 +| *Variable* | *In brief* | *Full documentation* |
    1.73 +| =%<nop>TOC%= | Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. |VarTOC |
    1.74 +| =%<nop>WEB%= | The current web, is <b><nop>%WEB%</b>. | VarWEB |
    1.75 +| =%<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 |
    1.76 +| =%<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 |
    1.77 +| =%<nop>INCLUDE{"SomeTopic"}%= | Server side include, includes another topic. The current web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%</b>= | VarINCLUDE |
    1.78 +| =%<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 |
    1.79 +
    1.80 +TWikiPreferences defines some site-wide variables. Among them are:
    1.81 +   * *Line break:* Write =%<nop>BR%= to start a new line.
    1.82 +   * *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.
    1.83 +
    1.84 +There are many more variables. To see them all, go to *[[TWikiVariables]]*.
    1.85 +a17 1
    1.86 +
    1.87 +@
    1.88 +
    1.89 +
    1.90 +1.1
    1.91 +log
    1.92 +@buildrelease
    1.93 +@
    1.94 +text
    1.95 +@d1 1
    1.96 +a1 1
    1.97 +%META:TOPICINFO{author="TWikiContributor" date="1142354264" format="1.1" version="1"}%
    1.98 +d22 1
    1.99 +a22 1
   1.100 +*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.
   1.101 +@