Matrix - Introduction to Microcontroller Programming | PmWiki / Page specific variables

(:Summary: PmWiki group header. Includes styles and trail.:) (:comment please leave the multiple style definitions concatenated as a single line. Linebreaks do appear in the output when the wiki is configured with linebreaks enabled -- thanks!:) (:comment included in PmWiki localisation headers and footers :)

< Conditional markup | Documentation Index | Page text variables >

< Basic Variables | Variables | Page TextVariables >

authors (intermediate)

(:nl:)

(:Summary: variables that are associated with pages:) (:Audience: authors (intermediate) :)

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 "PmWiki".

Note: Do not confuse these variables (set and used only in PmWiki pages) with PHP variables. Page variables can be read in PHP with the PageVar() function.

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.)

There is also the form @@{''pagename''$''variable''}@@, which returns the value of the variable for another page. For example, "{MarkupMasterIndex$Title}" displays as "Markup Master Index".

Default page variables

The page variables defined for PmWiki are:

->{$Action} - page's url action argument, as in "browse" ->{$BaseName} - page's "base" form (stripping any prefixes or suffixes defined via @@$BaseNamePatterns@@) as in "PmWiki.PageVariables" ->{$DefaultGroup} - default group name, as in "Main" ->{$DefaultName} - name of default page, as in "HomePage" (take note also of $PagePathFmt for setting a homepage for a group) ->{$Description} - page's description from the (:description:) markup, as in "Documentation for "variables" that are associated with pages." ->{$FullName} - page's full name, as in "PmWiki.PageVariables" ->{$Group} - page's group name, as in "PmWiki" ->{$Groupspaced} - spaced group name, as in "Pm Wiki"

->{$LastModified} - date page was edited, as in "October 01, 2018, at 06:02 AM" ->{$LastModifiedBy} - page's last editor, as in "Petko" ->{$LastModifiedHost} - IP of page's last editor, as in "" ->{$LastModifiedSummary} - Summary from last edit, as in "Despam" ->{$LastModifiedTime} - time page was edited in unix-style timestamp, as in "1538373726" -->This can be used (preceded by '@') in {(ftime)} and other date/time markups.

->{$Name} - page name, as in "PageVariables" ->{$Namespaced} - spaced page name, as in "Page Variables" ->{$PageUrl} - page's url, as in "https://www.flowcode.co.uk/courses/itm/index.php?n=PmWiki.PageVariables" ->{$PasswdRead} - "read" permissions for the page e.g. "(protected)" ->{$PasswdEdit} - "edit" permissions for the page e.g. "(protected)" ->{$PasswdAttr} - "attr" permissions for the page e.g. "(protected)" ->{$RequestedPage} - page requested in URL, used on Site.PageNotFound. e.g. "PmWiki.PageVariables" ->{$SiteGroup} - default interface group name for e.g. SideBar, forms, templates, as in "Site" ->{$SiteAdminGroup} - default administrative group name for e.g. AuthUser, Blocklist, as in "SiteAdmin" ->{$WikiTitle} - title of the website, as in "Matrix - Introduction to Microcontroller Programming" ->{$Title} - page title (may differ from Name), as in "Page specific variables" ->{$Titlespaced} - either the page title (if defined), or the spaced page name, as in "Page specific variables"

In addition to the above, there are some page-invariant variables available through this markup:

->{$Author} - the name of the person currently interacting with the site, as in "" ->{$AuthId} - current authenticated id, as in "" note the lower case 'd'.

->{$Version} - PmWiki version, as in "pmwiki-2.2.131" ->{$VersionNum} - The internal version number, as in "2002131" ->{$ScriptUrl} - The url to the pmwiki script, as in "https://www.flowcode.co.uk/courses/itm/index.php"

Special references

Special referenced variables are used to specify the context of the variable when: * the variable is included into a destination (target) page * the variable is used in a sidebar, header, or footer.

Prefixing the variable name with an asterisk (*) means the variable's value is related to the browsed page or main (body) page.

* @@{'''*$'''PageVariablename}@@ - prefixed by an asterisk (*) - value reflects the context of the browsed page.
Without the asterisk the variable's value is provided by the page from which it originates, eg source page of include, sidebar, or header or footer.
With asterisk the value will be provided by the browsed page, even if the markup comes from an included page or from a sidebar. * @@{'''$'''PageVariablename}@@ - retains value in source page context. * @@{'''=$'''PageVariablename}@@ - used only in pagelist templates to print the variable provided by each page from the pagelist.

-< See also $EnableRelativePageVars. -< Special references are also used in page text variables and page list templates.

For example you can test to see if the page is part of another page

(:if ! name {$FullName}:) 
%comment% name of this page is not the same as the page this text was sourced from
->[[{$FullName}#anchor | more ...]]
(:ifend:)

or refer to the main page in a sidebar, footer, or header

This page is [[{*$FullName}]]

This page is PmWiki.PageVariables

Page variable security ($authpage)

The form @@{''pagename''$''variable''}@@ or some PageLists, can display the values for other pages, regardless of the password protections.

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.

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.

foreach($FmtPV as $k=>$v) {
  if(preg_match('/^\\$(Title(spaced)?|LastModified(By|Host|Summary|Time)?|Description)$/', $k))
    $FmtPV[$k] = str_replace('$page', '$authpage', $v);
}

Custom page variables

You may add custom page variables as a local customization. In a local configuration file or a recipe script, use the variable $FmtPV:

$FmtPV['$VarName'] = "'variable definition'";
$FmtPV['$CurrentSkin'] = '$GLOBALS["Skin"]';
$FmtPV['$WikiTitle'] = '$GLOBALS["WikiTitle"]';

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"'''.

You can make a string a Page Variable by adding the string to the $GLOBALS[] array first.

## Create a {$BaseUrl} page variable
$GLOBALS['BaseUrl'] = $UrlScheme."://".$_SERVER["HTTP_HOST"]."/Wiki";
$FmtPV['$BaseUrl'] = '$GLOBALS["BaseUrl"]';

You can also have a function create the string.

## Create a {$BaseUrl} page variable
function BaseUrl() { 
  global $UrlScheme;
  return $UrlScheme."://".$_SERVER['HTTP_HOST']."/Wiki"; 
}
$FmtPV['$BaseUrl'] = 'BaseUrl()';

>>frame<< Please note that the values of the elements of $FmtPV are @@eval()@@ed so '''always sanitize any user input'''. The following is very insecure:

->$FmtPV['$Var'] = $_REQUEST['Var']; # critically insecure, allows PHP code injection
$FmtPV['$Var'] = '"'. addslashes($_REQUEST['Var']).'"'; # critically insecure, allows PHP code injection

See the recipe Cookbook:HttpVariables for a better way to use these variables. >><<