welcome: please sign in

The following 180 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
access   accessed   also   Anarcat   and   any   anywhere   appear   appropriate   are   areas   as   At   be   better   but   cached   can   code   comments   Contents   contribution   course   Creation   Current   data   Date   date   Dated   Description   dict   Dict   Dictionaries   dictionary   displays   does   domain   each   especially   etc   Every   Example   example   excluded   expand   Expanding   expansion   fancy   fetched   file   following   For   for   format   from   get   Get   Getting   global   happens   Help   helpful   his   Home   how   If   in   In   including   instead   instructions   is   just   Just   like   link   loaded   loginname   long   macro   Mail   mailto   memory   might   more   must   My   name   Name   None   normal   not   Note   Of   of   On   on   once   opening   or   Other   other   page   Page   pages   parsing   pickle   Predefined   preview   process   processing   public   put   R1   R2   Refresh   Renders   replaced   require   running   saved   saving   Saving   see   set   Signature   signing   sites   special   substituted   substitution   system   T06   Table   tells   template   Templates   templates   than   that   The   the   then   there   these   they   think   This   those   Time   time   to   To   unreplaced   use   useful   User   user   using   Val   value   values   var1   var2   var3   variable   Variable   variables   Variables   very   When   when   wiki   Wiki   will   with   within   You   you   your  

Clear message
Page Locked

HelpOnVariables

This page tells you more how you can use variables in wiki pages. This is especially helpful within templates, but also on "normal" wiki pages (like for signing a contribution).

Contents

  1. Predefined Variables
  2. Expanding Variables
  3. Getting Variables
    1. At Every Page Refresh
    2. When Saving the Page

1. Predefined Variables

The following variables are substituted when a page is saved. Note that they will appear unreplaced in the preview!

Variable

Description

Example

@PAGE@

Name of the page (useful for template pages)

HelpOnPageCreation

@DATE@

Current date in the system's format

2004-08-30

@TIME@

Current date and time in the user's format

2004-08-30 06:38:05

@ME@

Just the user's name

TheAnarcat

@USERNAME@

Just the user's name (or his domain/IP)

TheAnarcat

@USER@

Signature "-- loginname"

-- TheAnarcat

@SIG@

Dated Signature "-- loginname date time"

-- TheAnarcat 2004-08-30 06:38:05

@MAILTO@

A fancy mailto: link with the user's data

None - on public sites, better use the MailTo macro

2. Expanding Variables

You can use HomePageName/MyDict to expand those variables, just put a dictionary (see HelpOnDictionaries) there with your variables and values. For example, 

 VAR1:: substitution 1
 VAR2:: substitution 2

3. Getting Variables

3.1. At Every Page Refresh

You can use these values using the GetVal macro: 

<<GetVal(WikiDict,var1)>> <<GetVal(WikiDict,var2)>> <<GetVal(WikiDict,var3)>>

Renders as:

3.2. When Saving the Page

If the variables are set on !UserName/!MyDict (UserName must of course be replaced as appropriate), you can get the variables when saving any page with @var1@, @var2@, ...etc. instead of the GetVal macro.

/!\ Note that data in dict pages is cached and does not require opening and parsing the page file for each access to the value. In CGI, the value is fetched from a pickle, in long running process, the pickle is loaded once and then the value is accessed from memory.

/!\ Note that saving template pages and using preview does not expand variables. Other than that, variable expansion is very global and happens anywhere on the page, including code displays, comments, processing instructions and other "special" areas of a page you might think are excluded.