THE EARTH - Online Monthly Newspaper of the Ringing Cedars movement

Dec 22, 2024

Sign up for the e-mail issue

Ctrl+Enter

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 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:

{$Group} - page's group name, as in "PmWiki"

{$Groupspaced} - spaced group name, as in "Pm Wiki"

{$DefaultGroup} - default group name, as in "Main"

{$SiteGroup} - default group name for e.g. RecentChanges, as in "Site"

{$Name} - page name, as in "PageVariables"

{$Namespaced} - spaced page name, as in "Page Variables"

{$DefaultName} - name of default page, as in "HomePage"

{$FullName} - page's full name, as in "PmWiki.PageVariables"

{$Title} - page title (may differ from Name), as in "Page-specific Variables"

{$Titlespaced} - title/spaced page name, as in "Page-specific Variables"

{$Description} - page's description from the (:description:) markup, as in "Documentation for "variables" that are associated with pages."

{$LastModified} - date page was edited, as in "June 23, 2006, at 04:02 PM EST"

{$LastModifiedBy} - page's last editor, as in "Pico"

{$LastModifiedHost} - IP of page's last editor, as in "12.33.45.37"

{$LastModifiedSummary} - Summary from last edit, as in "Supplied "as in" example for {$ScriptUrl}"

Note: Enclose {$LastModifiedSummary} with [= and =] to avoid having PmWiki process any markup that may be contained in the summary.

{$PageUrl} - page's url, as in "http://www.ringingcedarsofrussia.org/theearth/PmWiki/PageVariables"

{$Action} - page's url action argument, as in "browse"

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 "" Please note the lower case 'd'. {$AuthID} returns nothing

{$Version} - PmWiki version, as in "pmwiki-2.1.27"

{$VersionNum} - The internal version number, as in "2001027"

{$ScriptUrl} - The url to the pmwiki script, as in "http://www.ringingcedarsofrussia.org/theearth"

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"]';

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

Making a {$WikiTitle} markup doesn't quite follow the formula above. Instead you need to use

$FmtPV['$WikiTitle'] = '$GLOBALS["WikiTitle"]';

The information contained in this mail is presented for educational purposes only. The information should not be considered complete, nor should it be relied on to suggest a course of treatment for a particular individual. Always consult with your physician, Doctor or other qualified health care provider before embarking on a new treatment, diet or fitness program. You should never disregard medical advice or delay in seeking it because of something you have read in this email. The information contained in this mail is compiled from a variety of sources ("Information Providers") and experiences. Neither this email nor Information Providers directly or indirectly practice medicine or dispense medical services, and so all information should be treated as thus. You hereby hold RingingCedarsofRussia.org, or ANY companies/individuals associated with RingingCedarsofrussia.org and it's affiliates NOT responsible for any injury that may occur either directly or indirectly by use or misuse of the information or ideas contained within.

The content of "The Earth - Online Newspaper" is copyrighted by http://www.ringingcedarsofrussia.org, and, occasionally, other rights holders. You may forward this Newsletter by e - mail an unlimited number of times, provided you do not alter the content in any way and that you include all applicable notices and disclaimers. You may print a single copy of each issue of E - News for your own personal, noncommercial use only, provided you include all applicable notices and disclaimers. Any other use of the content is strictly prohibited without the prior written permission of http://www.ringingcedarsofrussia.org, and any other applicable rights holders.