< I18n Variables | Variables | Link 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 substitutions from stdmarkup.php or superseded in local/config files.
$ActionSkin
- This array is used to override the current skin when performing a given action. The most common use is to set
to use the 'foo' skin when printing, regardless of what the$ActionSkin
['print']='foo'
variable is set to.$Skin
$WikiTitle
- A variable which contains the Wiki title as displayed in the browser tab and at the top of the browser window.
$EnablePageTitlePriority
- A variable defining how to treat multiple
(:title ...:)
page directives (added in PmWiki 2.2.9). -
# PmWiki default, last encountered title wins (the title may be changed from included pages or GroupFooter).$EnablePageTitlePriority
= 0; -
# First title wins; if a title is defined in the page, directives from included pages cannot change it.$EnablePageTitlePriority
= 1; $EnableDiffInline
- If set to 0, this variable switches off the word-level highlighting on the markup in the page history.
-
# Disable colors, show plain text differences$EnableDiffInline
= 0; $HTMLTagAttr
- A string containing attributes of the
<html...>
tag in the skin template, default empty. For example, to add a "lang" attribute, set in config.php:$HTMLTagAttr = 'lang="en" xml:lang="en"';
- For this variable to work in a custom skin, add it in the template file, for example:
<html xmlns="http://www.w3.org/1999/xhtml" $HTMLTagAttr>
$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, at the point where the skin template specifies a
<!--HTMLHeader-->
directive. This array provides an easy place for scripts to add custom HTML headers.
$HTMLHeaderFmt['logo'] = '<link href="http://path/to/logo.png" type="image/png" rel="icon" /> <link href="http://path/to/logo.ico" type="image/x-icon" rel="shortcut icon" />';
$HTMLHeaderFmt['rss'] = '<link rel="alternate" type="application/rss+xml" title="Rss All recent Changes" href="$ScriptUrl/Site/AllRecentChanges?action=rss" />';
$HTMLFooterFmt
- Like
$HTMLHeaderFmt
above, this contains an array of HTML text to be included near the end of an HTML document, at the point where the skin template specifies a<!--HTMLFooter-->
directive (usually just before a closing </body> tag). Primarily used by scripts to add custom HTML output after the body of the page output. $MetaRobots
- Sets the value of the
<meta name='robots' ... />
tag generated by PmWiki to control search engine robots accessing the site. PmWiki's default setting tells robots to not index anything but the normal page view, and to not index pages in the PmWiki wiki group. Explicitly setting$MetaRobots
overrides this default.
# never index this site$MetaRobots
= 'noindex,nofollow'; # disable the robots tag entirely$MetaRobots
= '';
$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.
$RecentChangesFmt['$SiteGroup.AllRecentChanges']
'* [[{$Group}.{$Name}]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]'
. . .
). The two spaces separate two parts of the format: the first part doesn't change (e.g. a link to the changed page) and the second part does change (e.g. the date and author of the change). Upon saving a page, PmWiki removes a line that matches the first part and adds a line with the current format before the first line with 2 spaces. This way, any line without two consecutive spaces stays at the top of the recent changes page.
$RecentChangesFmt['$SiteGroup.AllRecentChanges'] = '* [[{$Group}.{$Name}]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]'; $RecentChangesFmt['$Group.RecentChanges'] = '* [[{$Group}/{$Name}]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]';
$RecentUploadsFmt
- An array specifying the format for uploaded files at the RecentChanges listing. It is similar to
$RecentChangesFmt
. If enabled, newly uploaded files will be logged to the RecentChanges pages. Default is disabled. See Cookbook:RecentUploadsLog for more information. $DraftRecentChangesFmt
- An array specifying the format of the RecentChanges listing when saving Draft pages.
$RecentChangesFmt
is set to $DraftRecentChangesFmt
when a Draft page is saved. For example, you could save drafts in a separate Recent Draft Changes page and not list in the normal group's Recent Changes page:
$DraftRecentChangesFmt['$Group.RecentDraftChanges'] = '* [[{$Group}/{$Name}]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]'; $DraftRecentChangesFmt['$Group.RecentChanges'] = '';
$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 $WikiStyleApply
- An array which defines the scope of wiki styling per HTML element. Default settings are:
'item' => 'li|dt', 'list' => 'ul|ol|dl', 'div' => 'div', 'pre' => 'pre', 'img' => 'img', 'block' => 'p(?!\\sclass=)|div|ul|ol|dl|li|dt|pre|h[1-6]', 'p' => 'p(?!\\sclass=)'
- LI elements using the item keyword
- UL, OL, DL elements using the list keyword
- etc.
* %apply=item red%Here is a red styled list item * This item would not be styled. |
|
$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
- Lists the name(s) of skins to load, unless overridden by
$ActionSkin
. Normally$Skin
contains a single string which is a the name of a skin directory, but it may also be an array of names, in which case the first skin found from the list is used. $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.
$SkinLibDirs
- An array which, given the filesystem path (array key) to a skin (or a directory containing several skins), provides the corresponding URL (array value).
$SkinLibDirs
is set to:$SkinLibDirs = array( "./pub/skins/\$Skin" => "$PubDirUrl/skins/\$Skin", "$FarmD/pub/skins/\$Skin" => "$FarmPubDirUrl/skins/\$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 to0
(default) it will be...wiki.php?n=Main.Main
. $EnableFixedUrlRedirect
- When PmWiki is given a partial page name (e.g., just the name of a WikiGroup), it uses
$PagePathFmt
in order to make a complete page name from the partial one, then issues a "redirect" to the browser to tell it to reload the page with the correct full page name. Setting$EnableFixedUrlRedirect
=0; blocks the redirect, so that PmWiki continues processing with the adjusted page name rather than issuing the redirect. $GroupHeaderFmt
- Defines the markup placed at the top of every page. Default value is:
$GroupHeaderFmt = '(:include {$Group}.GroupHeader self=0 basepage={*$FullName}:)(:nl:)';
$GroupPrintHeaderFmt
- Defines the markup placed at the top of every page when
action=print
. Default value is:
SDV($GroupPrintHeaderFmt,'(:include $Group.GroupPrintHeader basepage={*$FullName}:)(:nl:)');
$GroupFooterFmt
- Defines the markup placed at the bottom of every page. Default value is:
$GroupFooterFmt = '(:nl:)(:include {$Group}.GroupFooter self=0 basepage={*$FullName}:)';
$GroupPrintFooterFmt
- Defines the markup placed at the bottom of every page when
action=print
. Default value is:
SDV($GroupPrintFooterFmt,'(:nl:)(:include $Group.GroupPrintFooter basepage={*$FullName}:)');
$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';
$PageNotFoundHeaderFmt
MUST be set to return 200 as described above in order to get the expected behaviour with all browsers.
$HTMLVSpace
- Setting
$HTMLVSpace = '';
in a local customizationfile (e.g.,local/config.php
) prevents insertion of spacer paragraphs (<p class='vspace'></p>
) in generated HTML code. To limit this change to a single skin, place the$HTMLVSpace = '';
statement in a skin.php file, preceded by the statementglobal $HTMLVSpace;
. $HTMLPNewline
- This variable allows to enable linebreaks by default, i.e. without having the directive (:linebreaks:) in a page or in a GroupHeader. To enable line breaks, add to config.php such a line:
$HTMLPNewline
= '<br/>'; $SimpleTableDefaultClassName
- This variable can contain a CSS classname to be used for simple tables, if a "class=" attribute is not defined in the wiki page (default unset):
$SimpleTableDefaultClassName
= "wikisimpletable";
See for sample code PITS:00638. $TableCellAttrFmt
- For Tables, defines the HTML attributes given to each
<td>
or<th>
cell in the output. Can contain references to $TableCellCount which holds the horizontal column number of the current cell. $TableCellAlignFmt
- For Tables, defines the HTML attributes for alignment of each
<td>
or<th>
cell. Default is" align='%s'"
where %s will be replaced with 'center', 'left' or 'right'. For a valid HTML5 output you may want to change this in config.php:$TableCellAlignFmt
= " class='%s'";
then define the CSS classes td.center, td.right and td.left (also th). $TableRowAttrFmt
- For Tables, defines the HTML attributes given to each
<tr>
element in the output. Can contain references to $TableRowCount to give the absolute row number within the table, or $TableRowIndex to provide a repeating row index from 1 to$TableRowIndexMax
.
# Give each row a unique CSS class based on row number (tr1, tr2, tr3, ... )$TableRowAttrFmt
= "class='tr\$TableRowCount'"; # Give each row alternating CSS classes (ti1, ti2, ti1, ti2, ti1, ... )$TableRowIndexMax
= 2;$TableRowAttrFmt
= "class='ti\$TableRowIndex'";
$TableRowIndexMax
- The maximum value for $TableRowIndex in Tables.
# Set rows indexes as 1, 2, 3, 1, 2, 3, 1, 2, ...
$TableRowIndexMax
= 3;
$EnableTableAutoValignTop
- Advanced tables are intended for layout, and automatically insert the
valign='top'
attribute if there is novalign
attribute defined in the markup source. Setting this variable to 0 in config.php will prevent the automatic addition.
$EnableTableAutoValignTop
= 0; # disable automatic valign='top' attr
$FmtV
['$TableCellCount']- PMWiki internal variable - Horizontal column number of the current cell. For use in
$TableCellAttrFmt
and$TableRowAttrFmt
. Administrators can use in$TableCellAttrFmt
and/or$TableRowAttrFmt
.
Example: $TableCellAttrFmt = 'class=col\$TableCellCount';
$FmtV
['$TableRowCount']- PMWiki internal variable - Current row number. Administrators can use in
$TableCellAttrFmt
and/or$TableRowAttrFmt
.
Example: TableRowAttrFmt = "class='row\$TableRowCount'";
$FmtV
['$TableRowIndex']- PMWiki internal variable - Row index number derived from
$TableRowIndexMax
. (1,2,3,1,2,3,...). Administrators can use in$TableCellAttrFmt
and/or$TableRowAttrFmt
.
Example: $TableRowAttrFmt = "class='ind\$TableRowIndex'";
See also: Edit Variables
< I18n Variables | Variables | Link Variables >
This page may have a more recent version on pmwiki.org: PmWiki:LayoutVariables, and a talk page: PmWiki:LayoutVariables-Talk.