(:groupheader:)(:title Page specific variables:) (:description Documentation for "variables" that are associated with pages. :) (:Summary: variables that are associated with pages:) (:Audience: authors (intermediate) :) <:vspace> [[#desc]]This page describes the "variables" that are associated with pages. Page variables have the form @@{$''variable''}@@, and can be used in page markup or in certain formatting strings in PmWiki. For example, the markup "[@{$Group}@]" renders in this page as "{$Group}". <:vspace> Note: Do not confuse these variables (set and used only in PmWiki pages) with [[PmWiki/Variables|PHP variables]]. Page variables can be read in PHP with the [[Cookbook:Functions#PageVar|PageVar()]] function. <:vspace> Note that these variables do not necessarily exist in the PHP code, because they have to be determined for a specific page. (However, they are usable in [[FmtPageName]] strings.) <:vspace> There is also the form @@{''pagename''$''variable''}@@, which returns the value of the variable for another page. For example, "[@{MarkupMasterIndex$Title}@]" displays as "{MarkupMasterIndex$Title}". <:vspace> [[#specialreferences]] !! Special references Special referenced variables are used to specify the context of the [[variable(s)]] when: * the variable is [[PmWiki/IncludeOtherPages|included]] into a destination (target) page * the variable is used in a sidebar, header, or footer <:vspace> Prefixing the variable name with an asterisk (*) means the variable's value is related to the target page or main (body) page. <:vspace> * @@{'''[@*$@]'''PageVariablename}@@ - prefixed by an asterisk (*) - value reflects target page context Without the asterisk the variable's value is that in the page from which it originates, eg source page of include, sidebar, or header or footer. * @@{'''[@$@]'''PageVariablename}@@ - retains value in source page context -< See also $EnableRelativePageVars. -< Special references are also used in [[page text variables(#specialreferences)]] and [[page list templates(#specialreferences)]]. <:vspace> For example you can test to see if the page is part of another page (:markup:) (:if ! name {$FullName}:) %comment% name of this page is not the same as the page this text was sourced from ->[[{$FullName}#anchor | more ...]] (:ifend:) (:markupend:) or refer to the main page in a sidebar, footer, or header (:markup class=horiz:) This page is [[{*$FullName}]] (:markupend:) <:vspace> [[#specialreferencesend]] <:vspace> !! Default page variables <:vspace> The page variables defined for PmWiki are: <:vspace> ->[@{$Action}@] - page's url action argument, as in "{$Action}" ->[@{$BaseName}@] - page's "base" form (stripping any prefixes or suffixes defined via @@$BaseNamePatterns@@) as in "`{$BaseName}" ->[@{$DefaultGroup}@] - default group name, as in "{$DefaultGroup}" ->[@{$DefaultName}@] - name of default page, as in "`{$DefaultName}" ->[@{$Description}@] - page's description from the [@(:description:)@] markup, as in "{$Description}" ->[@{$FullName}@] - page's full name, as in "`{$FullName}" ->[@{$Group}@] - page's group name, as in "`{$Group}" ->[@{$Groupspaced}@] - spaced group name, as in "{$Groupspaced}" <:vspace> ->[@{$LastModified}@] - date page was edited, as in "{$LastModified}" ->[@{$LastModifiedBy}@] - page's last editor, as in "{$LastModifiedBy}" ->[@{$LastModifiedHost}@] - IP of page's last editor, as in "{$LastModifiedHost}" ->[@{$LastModifiedSummary}@] - Summary from last edit, as in "{$LastModifiedSummary}" ->[@{$LastModifiedTime}@] - time page was edited in unix-style timestamp, as in "{$LastModifiedTime}" -->This can be used (preceded by '@') in [[PmWiki.MarkupExpressions#ftime|[@{(ftime)}@]]] and other date/time markups. <:vspace> ->[@{$Name}@] - page name, as in "`{$Name}" ->[@{$Namespaced}@] - spaced page name, as in "{$Namespaced}" ->[@{$PageUrl}@] - page's url, as in "{$PageUrl}" ->[@{$PasswdRead}@] - "read" permissions for the page e.g. "{$PasswdRead}" ->[@{$PasswdEdit}@] - "edit" permissions for the page e.g. "{$PasswdEdit}" ->[@{$PasswdAttr}@] - "attr" permissions for the page e.g. "{$PasswdAttr}" ->[@{$RequestedPage}@] - page requested in URL, used on [[Site.PageNotFound]]. e.g. "{$RequestedPage}" ->[@{$SiteGroup}@] - default group name for e.g. RecentChanges, as in "{$SiteGroup}" ->[@{$Title}@] - page title (may differ from Name), as in "{$Title}" ->[@{$Titlespaced}@] - either the page title (if defined), or the spaced page name, as in "{$Titlespaced}" <:vspace> In addition to the above, there are some page-invariant variables available through this markup: <:vspace> ->[@{$Author}@] - the name of the person currently interacting with the site, as in "{$Author}" ->[@{$AuthId}@] - current authenticated id, as in "{$AuthId}" %red%note the lower case 'd'.%% <:vspace> ->[@{$Version}@] - PmWiki version, as in "{$Version}" ->[@{$VersionNum}@] - The internal version number, as in "{$VersionNum}" ->[@{$ScriptUrl}@] - The url to the pmwiki script, as in "{$ScriptUrl}" <:vspace> [[#security]] !! Page variable security ($authpage) <:vspace> The form @@{''pagename''$''variable''}@@ or some [[PageLists]], can display the values for other pages, regardless of the password protections. <:vspace> If the other pages are protected and the visitor has no read permissions, PageVariables, unlike [[PageTextVariables]], normally display the values. While most variables do not contain sensitive information, some of them could do: $Title, $Description and those starting with $LastModified. <:vspace> Administrators and module developers can redefine the sensitive page variables to respect authentications, by using the "$authpage" variable instead of "$page" in the definition. The following snippet can be added in local/config.php -- it will rewrite the default possibly sensitive definitions to the secure ones. <:vspace> [@ foreach($FmtPV as $k=>$v) { if(preg_match('/^\\$(Title(spaced)?|LastModified(By|Host|Summary|Time)?|Description)$/', $k)) $FmtPV[$k] = str_replace('$page', '$authpage', $v); } @] <:vspace> <:vspace> [[#custompv]] !! Custom page variables <:vspace> You may add custom page variables as a local customization. In a local configuration file or a recipe script, use the variable $FmtPV: <:vspace> ->[@ $FmtPV['$VarName'] = "'variable definition'"; $FmtPV['$CurrentSkin'] = '$GLOBALS["Skin"]'; $FmtPV['$WikiTitle'] = '$GLOBALS["WikiTitle"]'; @] <:vspace> Defines new Page Variable of name $CurrentSkin, which can be used in the page with [@{$CurrentSkin}@] (also for [[Conditional markup]]). It's necessary to use the single quotes nested inside double-quotes as shown above (preferred) or a double-quoted string nested inside single-quotes like ''[@'"this"'@]''. <:vspace> If you want to have a Page Variable that returns the currently used password (more precisely, the last password entered), you can use <:vspace> ->[@ $FmtPV['$AuthPw'] = 'reset(array_keys((array)@$_SESSION["authpw"]))'; @] <:vspace> !! See also <:vspace> * [[Cookbook:More custom page variables]] * [[PmWiki.Variables]] &mdash; about variables internal to PmWiki. * [[PmWiki.MarkupMasterIndex]] &mdash; complete list of PmWiki markups. * [[PmWiki/PageTextVariables]] &mdash; page variables automatically made available through natural page markup or explicit page markup within the wiki text of the page. * [[PmWiki.Markup Expressions]] &mdash; markup expressions can manipulate page variables <:vspace> >>faq<< [[#faq]] <:vspace> Q:Is there a variable like $LastModified, but which shows me the creation time? A:No, but you can create one in config.php. For instance: ->[@# add page variable {$PageCreationDate} in format yyyy-mm-dd $FmtPV['$PageCreationDate'] = 'strftime("%Y-%m-%d", $page["ctime"])';@] <:vspace> If you like the same format that you define in config.php with $TimeFmt use [@ $FmtPV['$Created'] = "strftime(\$GLOBALS['TimeFmt'], \$page['ctime'])"; @] <:vspace> Q: How can I test if a variable is set and/or not empty? A: Use @@ [=(:if ! equal "{$Variable}" "":) $Variable is not empty. (:ifend:)=]@@. Note that undefined/inexistent variables appear as empty ones.(:groupfooter:) <:block>