From Burdett Real Estate

PmWiki: BasicVariables

<< | PmWiki.Variables | Layout Variables >>

$LastModifiedBy
Name of last author to have changed the current page

$DefaultGroup
WikiGroup used by default (on startup) when no group is specified in the URL.

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

$DefaultPage
Startup page when PmWiki is called without a page specified, normally $DefaultGroup.$DefaultName

$SiteGroup
Default group for storing configuration and utility pages such as Site.Search, Site.EditForm, Site.PageNotFound, etc.

$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

$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

$AsSpacedFunction
The name of the function used to convert WikiWords into normal, spaced strings. Defaults to 'AsSpaced'.
        $AsSpacedFunction = 'MyAsSpaced';

$EnablePGCust
Allows/disables per-page and per-group customizations. Can be set to zero in any local customization file to prevent remaining page/group customizations from being loaded.
        $EnablePGCust=0;              # turn off per-page/group configs

$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 Main, PmWiki, and MyGroup
        $GroupPattern = '(?:Main|PmWiki|MyGroup)';

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

$WikiWordPattern
The pattern that describes a WikiWord.

$Author
Set to the current reader, who is potentially an author (see discussion)

$AuthorGroup
The WikiGroup for user profiles. Defaults to 'Profiles'.
        $AuthorGroup = 'Users';

$AuthID
For sites using user-based authorization?, tracks the "reader" or login name.

$TimeFmt
The format to use for dates and times, in 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"

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

$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_'

$Version
A string representing the release version of PmWiki, as in "pmwiki-2.1.40".

$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.
Retrieved from http://burdett.co.nz/wiki/pmwiki.php?n=PmWiki.BasicVariables
Page last modified on September 30, 2005, at 08:41 PM