Basic Variables

Editing PmWiki.BasicVariables

(:Summary: core variables:)

Where the variables are available as wiki markup they are shown as ''Variable value "[={$=]VariableName}"''.

:$AsSpacedFunction:The name of the function used to convert WikiWords into normal, spaced strings.  Defaults to 'AsSpaced'.
:{$AsSpacedFunction}      :[@$AsSpacedFunction = 'MyAsSpaced';@]

%rfloat%Variable value "{$Author}"
:$Author [==]: Set to the current reader, who is potentially an author ([[PmWiki:AuthoringPhilosophy|see discussion]]). See also $EnablePostAuthorRequired.

(:if ! equal '{$AuthorGroup}' '':)%rfloat%Variable value "{$AuthorGroup}"(:ifend:)
:$AuthorGroup: The WikiGroup for user profiles. Defaults to 'Profiles'. This variable is implicit in the markup [@[[~AuthorName]]@]
:      :[@$AuthorGroup = 'Users';@]

(:if ! equal '{$AuthId}' '':)%rfloat%Variable value "{$AuthId}"(:ifend:)
:$AuthId: For sites using [[AuthUser | user-based authorization]], tracks the "reader" or login name.
:      :[@SessionAuth($pagename);@]
:      :[@if( isset($AuthId) ) { // this person has been authenticated@]

(:if ! equal '{$AuthPw}' '':)
%rfloat%Variable value "{$AuthPw}"
(:ifend:)
:$AuthPw: Request for documentation, meanwhile see [[http://permalink.gmane.org/gmane.comp.web.wiki.pmwiki.user/30037|here]].
:      :[@SessionAuth($pagename);@]
:      :[@if( isset($AuthPw) ) { // this person has entered a password@]

%rfloat%Variable value "{$BaseName}"
:$BaseName:
:$BaseNamePatterns:Allows population of the [@{$BaseName}@] PageVariable.  The key to the hash is the pattern to be replaced and the value is the replacement string.
:      :[@
# If {$FullName} is 'Group.Page-Draft' then {$BaseName} is 'Group.Page'
$BaseNamePatterns['/-Draft$/'] = '';
# If {$FullName} is 'Comments-Group.Page' then {$BaseName} is 'Group.Page'
$BaseNamePatterns['/^Comments-/'] = '';@]

(:if ! equal '{$CategoryGroup}' '':)
%rfloat%Variable value "{$CategoryGroup}"
(:ifend:)
:$CategoryGroup: The WikiGroup used for categories. Defaults to 'Category'.  (See [[Categories]]). This variable is implicit in the markup [@[[!CategoryName]]@]

(:if ! equal '{$CookiePrefix}' '':)
%rfloat%Variable value "{$CookiePrefix}"
(:ifend:)
:$CookiePrefix: A string prefix to be prepended to cookies set from PmWiki scripts.  It defaults to '', but can be set to a different value to avoid conflicts with similar-named cookies from other applications, or to allow multiple wikis from the same domain to store separate cookies.
:      :[@$CookiePrefix = 'pmwiki_';@]     # set cookie prefix to 'pmwiki_'
::If you have a [[WikiFarm(s)]], use the following in each field's ''config.php'' to get a unique prefix for each field in the farm, thus isolating each field's cookies.:
:      :[@$CookiePrefix = substr($tmp = md5(__FILE__), 0, 5).'_';@]

%rfloat%Variable value "{$DefaultGroup}"
:$DefaultGroup:[[WikiGroup]] used by default (on startup) when no group is specified in the URL.

%rfloat%Variable value "{$DefaultName}"
:$DefaultName:Name of the default HomePage of each WikiGroup.  Used when the group doesn't have a page with the same name as the group.

(:if ! equal '{$DefaultPage}' '':)
%rfloat%Variable value "{$DefaultPage}"
(:ifend:)
:$DefaultPage:Startup page when PmWiki is called without a specified page, normally ''$DefaultGroup.$DefaultName''.
-> Note: for $DefaultGroup, $DefaultName and $DefaultPage variables to work, they should be defined in the beginning of (farm)config.php, before any call to the function ResolvePageName(). This means, before any script from PmWiki and before any recipe that might be using this function.

(:if ! equal '{$EnableLocalConfig}' '':)
%rfloat%Variable value "{$EnableLocalConfig}"
(:ifend:)
:$EnableLocalConfig:Allows/disables local/config.php customizations (usually for a farm's wikis).  Can be set to zero in local/farmconfig.php to prevent the farm's wikis' local/config.php from being loaded.
:      :[@$EnableLocalConfig = 0;    # disable PmWiki's local/config@]

(:if ! equal '{$EnablePGCust}' '':)
%rfloat%Variable value "{$EnablePGCust}"
(:ifend:)
:$EnablePGCust:Allows/disables per-page and [[GroupCustomizations | per-group customizations]].  Can be set to zero in any [[local customization(s)]] file to prevent remaining page/group customizations from being loaded.
:      :[@$EnablePGCust=0;              # turn off per-page/group configs@]

:$EnableRedirect:When enabled (default), causes page redirects to automatically be performed by the browser.  Setting $EnableRedirect to zero causes PmWiki to pause and issue a "Redirect to ''link''" message instead.  This is sometimes useful when debugging recipes to be able to see the results of actions before page redirections occur.

(:if ! equal '{$EnableWikiWords}' '':)
%rfloat%Variable value "{$EnableWikiWords}"
(:ifend:)
:$EnableWikiWords:Enable [[WikiWord]] processing.

:$EnableWSPre:Enables a markup rule that causes lines with leading spaces to be treated as sections of preformatted text.  If set to a value greater than 1, indicates the minimum number of leading spaces required for this treatment.
:      :[@$EnableWSPre = 1;             # leading spaces are preformatted text@]
:      :[@$EnableWSPre = 0;             # leading spaces are normal lines of text@]
:      :[@$EnableWSPre = 4;             # 4+ spaces are preformatted text@]

:$FTimeFmt:Can be used to override the default date format used by the "ftime" function.  The default $FTimeFmt is $TimeFmt.  (See [[Markup Expressions]])

:$GroupPattern: The regular expression pattern used for valid [[WikiGroup]] name specifications.  Defaults to allowing any group name beginning with an uppercase letter, but can be set to limit the valid group names (see Cookbook:LimitWikiGroups).
:      :[@# limit groups to Site, SiteAdmin, PmWiki, and MyGroup@]
:      :[@$GroupPattern = '(?:Site|SiteAdmin|PmWiki|MyGroup)';@]
:      :[@#for case-sensitive group names, note the ?-i switch:@]
:      :[@$GroupPattern = '(?-i:Site|SiteAdmin|PmWiki|MyGroup)';@]

:$LinkWikiWords:If set, then bare WikiWords in a page are automatically linked to pages of the same name.  Note that this value can also be affected by the [@(:linkwikiwords:)@] and [@(:nolinkwikiwords:)@] directives.
:      :[@$LinkWikiWords = 1;           # turn on WikiWord links@]
:      :[@$LinkWikiWords = 0;           # disable WikiWord links@]
:      :Note, this setting requires WikiWords to be enabled, see $EnableWikiWords.

:$LogoutRedirectFmt: Identifies the page to which the visitor should be sent after an [@?action=logout@].  Defaults to the current page.
:      :[@$LogoutRedirectFmt = 'Site.Logout';    # ?action=logout target@]

:$LogoutCookies: An array of cookie names to be removed when [@?action=logout@] is invoked.

(:if ! equal '{$NamePattern}' '':)
%rfloat%Variable value "{$NamePattern}"
(:ifend:)
:$NamePattern: The regular expression pattern used for valid page names.  Defaults to allowing pages beginning with an uppercase letter or digit, followed by sequences of alphanumeric characters, hyphens, and underscores.

%rfloat%Variable value "{$SiteGroup}"
:$SiteGroup:Default group for storing configuration and utility pages such as [[Site.Search]], [[Site.EditForm]], [[Site.PageNotFound]], etc.

:$SiteAdminGroup:Default group for locked administrative pages such as [[SiteAdmin.AuthList]], [[SiteAdmin.AuthUser]], [[SiteAdmin.ApprovedUrls]], etc, defaults to 'SiteAdmin'.

(:if ! equal '{$SpaceWikiWords}' '':)
%rfloat%Variable value "{$SpaceWikiWords}"
(:ifend:)
:$SpaceWikiWords:If set, then WikiWords in pages are automatically spaced according to $AsSpacedFunction.  Note that this value can also be affected by the [@(:spacewikiwords:)@] and [@(:nospacewikiwords:)@] directives.
:      :[@$SpaceWikiWords = 1;          # turn on WikiWord spacing@]
:      :[@$SpaceWikiWords = 0;          # turn off WikiWord spacing@]

(:if ! equal '{$TimeFmt}' '':)
%rfloat%Variable value "{$TimeFmt}"
(:ifend:)
:$TimeFmt: The format to use for dates and times, in [[http://php.net/strftime | strftime()]] format.  The default value is [@'%B %d, %Y at %I:%M %p'@], which gives dates of the form "September 8, 2005 at 10:57 PM".
:      :[@$TimeFmt = '%B %d, %Y';        # dates as "September 8, 2005"@]
:      :[@$TimeFmt = '%Y-%m-%d';         # dates as "2005-09-08"@]

%rfloat%Variable value "{$Version}"
:$Version: A string representing the release version of PmWiki.

%rfloat%Variable value "{$VersionNum}"
:$VersionNum: A number representing the release version of PmWiki,
 with the major and minor release components padded with zeroes to
 produce three digits.  Thus, release "pmwiki-2.1.40" will have $VersionNum set to 2001040.

The first digit is a 2, the next three digits are the major
 release number, and the last three digits are the minor release
 number. Beta releases use 900-999 for the minor release number.
 Thus:
--> [@
2.1.0          2001000
2.1.1          2001001
...
2.1.27         2001027
2.2.0-beta1    2001901
2.2.0-beta2    2001902
...
2.2.0-beta18   2001918
...
2.2.0          2002000
@]

(:if ! equal '{$WikiWordPattern}' '':)
%rfloat%Variable value "{$WikiWordPattern}"
(:ifend:)
:$WikiWordPattern: The pattern that describes a WikiWord.

:$EnableRelativePageVars:This setting controls how [[Page variables]] in included pages are understood by PmWiki.
: :@@$EnableRelativePageVars = 1; # PmWiki current default@@\\
In this case @@[={$Name}=]@@ displays the name of the physical page where it written. If @@[={$Name}=]@@ is in an included page, it will display the name of the included page. (This is currently PmWiki's default.)
: :@@$EnableRelativePageVars = 0; # revert to previous default@@\\
In this case @@[={$Name}=]@@ displays the name of the currently browsed page. Even if @@[={$Name}=]@@ is in an included page, it will display the name of the browsed page. This was PmWiki's default in versions 2.2.8 and earlier, and changed in 2.2.9, but you can revert it back with this line in config.php.
: : @@[={*$Name}=]@@ with an asterisk always displays the name of the currently browsed page, regardless of $EnableRelativePageVars.

Categories: [[!PmWiki Developer]]

Sumario:
Autor: Esta es una edición menor
Introduzca el código:

Edición básica - Reglas de formato de texto - Índice documentación	Tablas: simple - avanzado
Parrafos: Para un parrafo nuevo, usa una línea en blanco;	Cambio de línea: \\ o [[<<]]
-> Sangría en todo el parrafo, -< Sangría colgante,	Juntar líneas: \
Listas: * por puntos, # numeradas, :term:definición para listas con definiciones
Resaltos: ''cursiva'' '''negrita''' '''''*negrita y cursiva*''''' @@`Anchura fija`@@
Links: [[otra página]], [[http://ejemplo.com/]], [[otra página \| texto del enlace]], [[#ancla]], [[#ancla \| texto del enlace]]	Firmas: nombre: ~~~
Grupos: [[Grupo/Página]] muestra Page, [[Grupo.Página]] muestra Grupo.Página, [[Grupo(.Página)]] muestra Grupo, [[Grupo/]] Enlaza la página principal del Grupo	nombre y fecha: ~~~~
Separadores: !!, !!! para cabeceras, ---- para una línea horizontal	Sin formato: [=...=]
Otros: [+grande+] [++más grande++] [-pequeño-] [--más pequeño--] '^^superíndice^' '__subíndice_' {+insertado+} {-~~tachado~~-}	Preformateado: [@...@] o >>pre<<...>><<