<< Basic Variables | PmWiki.Variables | Path Variables >>
Variable substitutions in the skin template are all managed by the FmtPageName() function from pmwiki.php. Pmwiki variable substitutions available on pages are managed by the {$var} substitutions from stdmarkup.php or superseded in local/config files.
$WikiTitle- A variable which contains the Wiki title as displayed by the browser
$HTMLStylesFmt- An array of CSS statements to be included in the page's output along with other HTML headers. This array provides an easy place for scripts to add custom CSS statements.
$HTMLHeaderFmt- An array of HTML text to be included in the page's <head> section. This array provides an easy place for scripts to add custom HTML headers.
For example, if you want to specify a logo for all the pages of your wiki (a png image for Firefox (and others...), an ico for Internet Explorer):
$HTMLHeaderFmt['$PageUrl'] =
'<link rel="alternate" type="application/rss+xml" title="Rss All recent Changes"
href=""http://your/wiki/path/pmwiki.php/Site/
AllRecentChanges?action=rss&order=-time&count=0&list=normal" />'
Another example, if you want to get the rss notification on some browsers (the rss icon in firefox for instance):
$HTMLHeaderFmt['$PageUrl'] =
'<link href="http://your/wiki/path/to/your/logo/logo.png" type="image/png" rel="icon" />
<link href="http://your/wiki/path/to/your/logo/logo.ico" type="image/x-icon" rel="shortcut icon" />'
$MessagesFmt- An array of HTML text to be displayed at the point of any
(:messages:) markup. Commonly used for displaying messages with respect to editing pages.
$RecentChangesFmt- An array specifying the format of the RecentChanges listing.
The format can be specified in your config.php using the following:
$RecentChangesFmt['$SiteGroup.AllRecentChanges'] =
'* [[$Group.$Name]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]';
$RecentChangesFmt['$Group.RecentChanges'] =
'* [[$Group/$Name]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]';
Note that changes made to the format will only affect new edits. In other words, you will need to edit a page for your new format to be visible. Note also that you need to have two spaces between the page name and the other information about the edit.
$RCLinesMax- The maximum number of lines to be stored in RecentChanges pages. The default is zero, meaning "no limit".
$RCLinesMax = 1000; # maintain at most 1000 recent changes
$PageRedirectFmt- The text to be used when a page is redirected via the
(:redirect:) markup.
$PageRedirectFmt = '<p><i>redirected from $FullName</p>';
$PageRedirectFmt = '';
$WikiStyle- An array which contains the predefined WikiStyles which can be used on a textpage.
See: PmWiki.CustomWikiStyles
$MaxIncludes- Controls the number of times that pages can be included via the
(:include:) and other directives, used to control recursion and otherwise pose a sanity check on page contents. $MaxIncludes defaults to 50, but can be set to any value by the wiki administrator.
$MaxIncludes = 50; # default
$MaxIncludes = 1000; # allow lots of includes
$MaxIncludes = 0; # turn off includes
- $Skin
- Points to the directory of an own or different layout skin.
$SkinDirUrl- Set by scripts/skins.php to be the base url of the current skin's directory (i.e., within a 'pub/skins/' directory). This variable is typically used inside of a skin .tmpl file to provide access to .css files and graphic images associated with the skin.
$PageLogoUrl- is the url that refers to a logo image which most skins display somewhere in the page's header (top left usually).
$EnablePathInfo- Changes the handling of the page URL. When set to
1 page URL will be ...wiki.php/Main/Main, when set to 0 (default) it will be ...wiki.php?n=Main.Main.
$GroupHeaderFmt- Defines the markup placed at the top of every page. Default value is:
$GroupHeaderFmt = '(:include $Group.GroupHeader:)(:nl:)';
$GroupFooterFmt- Defines the markup placed at the bottom of every page. Default value is:
$GroupFooterFmt = '(:include $Group.GroupFooter:)(:nl:)';
$PageNotFoundHeaderFmt- Specifies the HTTP header to send when attempting to browse a page that doesn't exist. Some webserver packages (notably Microsoft's "Personal Web Server") require that this variable be changed in order to work.
# default
$PageNotFoundHeaderFmt = 'HTTP/1.1 404 Not Found';
# return all pages as found
$PageNotFoundHeaderFmt = 'HTTP/1.1 200 Ok';
See also: Edit Variables