data/TWiki/TWikiVariablesQuickStart.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
head	1.3;
colas@0
     2
access;
colas@0
     3
symbols;
colas@0
     4
locks; strict;
colas@0
     5
comment	@# @;
colas@0
     6
colas@0
     7
colas@0
     8
1.3
colas@0
     9
date	2008.01.22.03.21.35;	author TWikiContributor;	state Exp;
colas@0
    10
branches;
colas@0
    11
next	1.2;
colas@0
    12
colas@0
    13
1.2
colas@0
    14
date	2007.01.16.04.12.02;	author TWikiContributor;	state Exp;
colas@0
    15
branches;
colas@0
    16
next	1.1;
colas@0
    17
colas@0
    18
1.1
colas@0
    19
date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
colas@0
    20
branches;
colas@0
    21
next	;
colas@0
    22
colas@0
    23
colas@0
    24
desc
colas@0
    25
@buildrelease
colas@0
    26
@
colas@0
    27
colas@0
    28
colas@0
    29
1.3
colas@0
    30
log
colas@0
    31
@buildrelease
colas@0
    32
@
colas@0
    33
text
colas@0
    34
@%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="3"}%
colas@0
    35
---++ TWiki Variables Quickstart
colas@0
    36
colas@0
    37
%STARTINCLUDE%
colas@0
    38
colas@0
    39
TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic
colas@0
    40
is displayed. For example, =%<nop>TOPIC%= is expanded to %TOPIC%.
colas@0
    41
Some variables can take arguments in curly braces - for example, =%<nop>INCLUDE{"OtherTopic" ARG="arg"}%=.
colas@0
    42
colas@0
    43
Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own
colas@0
    44
TWiki Variables at the entire site, individual web, or individual topic level. For more information,
colas@0
    45
go to *[[TWikiVariables]]*
colas@0
    46
colas@0
    47
TWiki Variables are fully expanded _before_ any of the TWiki text formatting rules are applied.
colas@0
    48
colas@0
    49
*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.
colas@0
    50
colas@0
    51
%ICON{"tip"}% To "escape" a variable, prefix it with an exclamation mark. Write: =!%<nop>SOMEVARIABLE%= to get: !%SOMEVARIABLE%.
colas@0
    52
%STOPINCLUDE%
colas@0
    53
@
colas@0
    54
colas@0
    55
colas@0
    56
1.2
colas@0
    57
log
colas@0
    58
@buildrelease
colas@0
    59
@
colas@0
    60
text
colas@0
    61
@d1 1
colas@0
    62
a1 1
colas@0
    63
%META:TOPICINFO{author="TWikiContributor" date="1167863098" format="1.1" version="2"}%
colas@0
    64
d6 7
colas@0
    65
a12 1
colas@0
    66
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 }).
colas@0
    67
d14 1
colas@0
    68
a14 13
colas@0
    69
| *Variable* | *In brief* | *Full documentation* |
colas@0
    70
| =%<nop>TOC%= | Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. |VarTOC |
colas@0
    71
| =%<nop>WEB%= | The current web, is <b><nop>%WEB%</b>. | VarWEB |
colas@0
    72
| =%<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 |
colas@0
    73
| =%<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 |
colas@0
    74
| =%<nop>INCLUDE{"SomeTopic"}%= | Server side include, includes another topic. The current web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%</b>= | VarINCLUDE |
colas@0
    75
| =%<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 |
colas@0
    76
colas@0
    77
TWikiPreferences defines some site-wide variables. Among them are:
colas@0
    78
   * *Line break:* Write =%<nop>BR%= to start a new line.
colas@0
    79
   * *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.
colas@0
    80
colas@0
    81
There are many more variables. To see them all, go to *[[TWikiVariables]]*.
colas@0
    82
a17 1
colas@0
    83
colas@0
    84
@
colas@0
    85
colas@0
    86
colas@0
    87
1.1
colas@0
    88
log
colas@0
    89
@buildrelease
colas@0
    90
@
colas@0
    91
text
colas@0
    92
@d1 1
colas@0
    93
a1 1
colas@0
    94
%META:TOPICINFO{author="TWikiContributor" date="1142354264" format="1.1" version="1"}%
colas@0
    95
d22 1
colas@0
    96
a22 1
colas@0
    97
*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.
colas@0
    98
@