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 @@$ActionSkin['print']='foo' to use the 'foo' skin when printing, regardless of what the
$Skin@@ variable is set to.
$WikiTitle
$HTMLStylesFmt
$HTMLHeaderFmt
<!--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
(:messages:)
markup. Commonly used for displaying messages with respect to editing pages.
$RecentChangesFmt
$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
$DraftRecentChangesFmt['$Group.RecentDraftChanges'] = '* [[{$Group}/{$Name}]] . . . $CurrentTime $[by] $AuthorLink: [=$ChangeSummary=]'; $DraftRecentChangesFmt['$Group.RecentChanges'] = '';
$RCLinesMax
$RCLinesMax
= 1000; # maintain at most 1000 recent changes
$PageRedirectFmt
(:redirect:)
markup.
$PageRedirectFmt = '<p><i>redirected from $FullName</p>'; $PageRedirectFmt = '';
$WikiStyle
:$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
$SkinLibDirs
$SkinLibDirs
is set to:$SkinLibDirs = array( "./pub/skins/\$Skin" => "$PubDirUrl/skins/\$Skin", "$FarmD/pub/skins/\$Skin" => "$FarmPubDirUrl/skins/\$Skin");
$PageLogoUrl
$EnablePathInfo
1
page URL will be ...wiki.php/Main/Main
, when set to 0
(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
$GroupHeaderFmt = '(:include $Group.GroupHeader:)(:nl:)';
$GroupPrintHeaderFmt
action=print
. Default value is:
SDV($GroupPrintHeaderFmt,'(:include $Group.GroupPrintHeader:)(:nl:)');
$GroupFooterFmt
$GroupFooterFmt = '(:include $Group.GroupFooter:)(:nl:)';
$GroupPrintFooterFmt
action=print
. Default value is:
SDV($GroupPrintFooterFmt,'(:nl:)(:include $Group.GroupPrintFooter:)');
$PageNotFoundHeaderFmt
# 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
$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 statement global $HTMLVSpace;
.
:$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.
:$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;
Example: $TableCellAttrFmt = 'class=col\$TableCellCount';
Example: TableRowAttrFmt = "class='row\$TableRowCount'";
$TableRowAttrFmt
.
Example: $TableRowAttrFmt = "class='ind\$TableRowIndex'";
See also: Edit Variables