< 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
$ActionSkin
['print']='foo'
to use the 'foo' skin when printing, regardless of what the $Skin
variable is set to.
$ActionTitleFmt
$HTMLTitleFmt
or the skin template). By default it is localized "| action"
, but you can change it:
$ActionTitleFmt['edit'] = ': $[Edit]';
# use a ":" colon separator
$ActionTitleFmt['edit'] = ' $[Edit] ';
# space separator, may be placed at the start of $HTMLTitleFmt
$WikiTitle
$HTMLTitleFmt
<title>...</title>
element in the skin template. Here you can set this format without editing the skin template. For example:
$HTMLTitleFmt
= '$Title | $WikiTitle
$ActionTitle';
# Page title first, then $WikiTitle
, then the action e.g. "| Edit", and the wiki group $Group is omitted.
$HTMLTitleFmt
= '$Title | $GroupHomePageTitle';
# Page title first, then the title of the group landing page, see PageVariables.
$EnablePageTitlePriority
(:title ...:)
page directives (added in PmWiki 2.2.9).
$EnablePageTitlePriority
= 0;
# PmWiki default, last encountered title wins (the title may be changed from included pages or GroupFooter).
$EnablePageTitlePriority
= 1;
# First title wins; if a title is defined in the page, directives from included pages cannot change it.
$EnableDiffInline
$EnableDiffInline
= 0;
# Disable colors, show plain text differences
$EnableRCDiffBytes
(All)RecentChanges
pages will display the difference in bytes of the page content from the previous version like (+123) or $EnableRCDiffBytes
= 1;
# Show bytes difference from previous version
pub/css/local.css
something like: .diffmarkup { font-family: monospace; font-size: 0.9em; } .diffmarkup del { background: #ff9; text-decoration: none; } .diffmarkup ins { background: #9f9; text-decoration: none; }
$CurrentTime
$TimeFmt
. It is used in RecentChanges
(before 2.3.0), and in user signatures.
$CurrentLocalTime
RecentChanges
(since 2.3.0). This time stamp will be saved in the wiki source text in Greenwich Mean Time (UTC/GMT), but will be shown according to $TimeFmt
in the timezone of the wiki. When $EnableLocalTimes
is enabled, then it will be shown in the visitor's time zone. The same format is also saved in user signatures if $EnableLocalTimes
is enabled.
$EnablePmUtils
pub/pmwiki-utils.js
should be loaded or not. The script contains JavaScript utility functions for the table of contents, the syntax highlighting, the recent changes, and the email obfuscation, and the dark color theme. By default $EnablePmUtils
is 1 (enabled), but most functions need to be enabled individually ($EnableLocalTimes
, $EnableHighlight
, $PmTOC
, $LinkFunctions['mailto:'], $EnableCopyCode
, $EnableSortable
, $ToggleNextSelector
, $EnablePmSyntax
, $CustomSyntax
, $EnableCopyCode
, $EnableDarkThemeToggle
). Set this variable to 0 to disable all these functions.
$EnableDarkThemeToggle
$EnableDarkThemeToggle
= 0;
dark theme toggling is disabled, even the skin supports it
$EnableDarkThemeToggle
= 1;
dark theme toggling is enabled, with light theme by default
$EnableDarkThemeToggle
= 2;
dark theme toggling is enabled, with dark theme by default
$EnableDarkThemeToggle
= 3;
use automatically the theme preferred by the browser
$ImgDarkSuffix
.
$EnableLocalTimes
$EnableLocalTimes
= 2;
Enables long local times, as in MM/DD/YYYY HH:MM:SS.
$EnableLocalTimes
= 1;
Enables compact local times, either HH:MM (within 24 hours), MM/DD or DD/MM (within 11 months), and MM/DD/YYYY or DD/MM/YYYY if earlier than 11 months. The long format appears in a tooltip title when the mouse is over the short format.
$EnableLocalTimes
= 3;
Like the compact local times, but when the date is earlier than 11 months, shows MM'YY.
$EnablePmSyntax
$EnableHighlight
) When set to 1, enables PmSyntax, a syntax highlighting for the PmWiki markup language, which makes the documentation easy to read (from 2.3.0). When set to 2, it also enables the experimental syntax highlighting in the basic edit form: $EnablePmSyntax = 1; # highlight documentation blocks $EnablePmSyntax = 2; # both documentation and edit form if ($action=='edit') $EnablePmSyntax = 2; # only edit form
$CustomSyntax
$EnableHighlight
$EnablePmSyntax
) If set to 1, enables compatibility with the highlight.js library to highlight program code. In addition, you need to include the library and mark your code blocks with the wikistyle %highlight%
, see WikiStyles#highlight.
$EnableCopyCode
[+]
button near the top right of preformatted blocks. A user clicking on the button will have the text of the preformatted block copied to their system clipboard: $EnableCopyCode = 1; # add a [+] copy code button to pre blocks
$HTMLTagAttr
<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"';
<html xmlns="http://www.w3.org/1999/xhtml" $HTMLTagAttr>
$HTMLStylesFmt
$HTMLHeaderFmt
<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['favicon'] = '<link href="http://path/to/icon.png" type="image/png" rel="icon" /> <link href="http://path/to/icon.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" />';
$HTMLHeaderFmt['the-javascript'] = '<script> // the javascript code </script>';
$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
<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=]'
. . .
). 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=]';
$CurrentLocalTime
by default which shows exactly what $CurrentTime
previously showed, but when $EnableLocalTimes
is set, will rewrite the time and date in the local format and timezone of the visitor.
$RecentUploadsFmt
$RecentChangesFmt
. If enabled, newly uploaded files will be logged to the RecentChanges pages. Default is disabled. See Cookbook:RecentUploadsLog for more information. See also $EnableRecentUploads
.
$EnableRecentUploads
$RecentUploadsFmt
is not set, it enables Recent uploads in a default format, only on the page Site.AllRecentChanges. This was added in 2.3.0 to easily enable the feature with some default settings that may be good enough for many wikis.
$DraftRecentChangesFmt
$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
$RCLinesMax
= 1000; # maintain at most 1000 recent changes
$PageRedirectFmt
(:redirect:)
markup.
$PageRedirectFmt = '<p><i>redirected from $FullName</p>'; $PageRedirectFmt = '';
$WikiStyle
$WikiStyleApply
'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=)'
* %apply=item red%Here is a red styled list item * This item would not be styled. |
|
$WikiPageCSSFmt
$WikiPageCSSFmt
= 'Site.LocalCSS'; # global Site.LocalCSS page
$WikiPageCSSFmt
= '{$Group}.LocalCSS'; # per-group LocalCSS pages
$WikiPageCSSVars
$WikiPageCSSFmt
, this is an array with global PHP $variables available as pre-processor @variables in that page. By default the array contains: 'FarmPubDirUrl', 'PubDirUrl', 'Skin', 'action', 'SkinDirUrl'
.
$EnableSelfWikiPageCSS
$WikiPageCSSFmt
, that specific page doesn't have CSS applied to itself when browsed or edited. In case a grave mistake is made in the styles and the site becomes unusable, this page will still be viewable and editable. People familiar with CSS can set this to 1 and the styles will be applied to the page itself, also in "Preview" mode:
$EnableSelfWikiPageCSS
= 1; # Apply styles to the "wiki CSS page" itself
$PmTOC
$PmTOC
['Enable'] = 1; # Enable TOC; default is 0 (disabled).
$ToggleNextSelector
$MaxIncludes
(: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
$ActionSkin
. Normally $Skin
contains a single string which is 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
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
skin.tmpl
and skin.php
files, as seen by the PmWiki program. It does not have to be publicly accessible.
.css
, .gif
, and other files which appear in the HTML code sent by PMWiki to the browser. This directory must be publicly accessible.
$SkinLibDirs
is set to:
$SkinLibDirs = array( "./pub/skins/\$Skin" => "$PubDirUrl/skins/\$Skin", "$FarmD/pub/skins/\$Skin" => "$FarmPubDirUrl/skins/\$Skin");
$SkinTemplateIncludeLevel
<!--IncludeTemplate:...-->
directive. By default this directive is disabled. Setting it to 1 allows one level of inclusions, setting it to 2 allows included templates to include more templates. There can be up to 10 levels of inclusion. This variable can be defined either in local/config.php
or in pub/skins/skinname/skinname.php
(with SDV):# in config.php, allow one level of inclusions $SkinTemplateIncludeLevel = 1; # in skinname.php, allow 3 levels of inclusions SDV($GLOBALS['SkinTemplateIncludeLevel'], 3);
$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
$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 self=0 basepage={*$FullName}:)(:nl:)';
$GroupPrintHeaderFmt
action=print
. Default value is:
SDV($GroupPrintHeaderFmt,'(:include $Group.GroupPrintHeader basepage={*$FullName}:)(:nl:)');
$GroupFooterFmt = '(:nl:)(:include {$Group}.GroupFooter self=0 basepage={*$FullName}:)';
action=print
. Default value is:
SDV($GroupPrintFooterFmt,'(:nl:)(:include $Group.GroupPrintFooter basepage={*$FullName}:)');
$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;
.
$HTMLPNewline
(:linebreaks:)
in a page or in a GroupHeader. To enable line breaks, add to config.php
such a line:$HTMLPNewline
= '<br/>';
$SimpleTableDefaultClassName
$SimpleTableDefaultClassName
= "wikisimpletable";
$EnableSimpleTableRowspan
$EnableSimpleTableRowspan
= 1;
# See recipe
$EnableSortable
$EnableSortable = 1; # Enable sortable tables
$TableCellAttrFmt
<td>
or <th>
cell in the output. Can contain references to $TableCellCount which holds the horizontal column number of the current cell.
$TableCellAlignFmt
<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'";
$TableRowAttrFmt
<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
# Set rows indexes as 1, 2, 3, 1, 2, 3, 1, 2, ... $TableRowIndexMax = 3;
$EnableTableAutoValignTop
valign='top'
attribute if there is no valign
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
$EnableAutoSkinList
$PageSkinList
and Skins:SkinChange.
$PageSkinList
?skin=
or ?setskin=
URL query to the wiki. See also $EnableAutoSkinList
and Skins:SkinChange.
$TrailFmt
$TrailFmt['<<|'] = "<span class='wikitrail'><< \$prev | \$trailname | \$next >></span>"; $TrailFmt['<|'] = "<span class='wikitrail'>\$prev\$trailname\$next</span>"; $TrailFmt['^|'] = "<span class='wikitrail'>\$crumbs</span>";
$TrailPathSep
^|[[TrailIndexPage]]|^
). For instance $TrailPathSep
= ' > ';
will output "TrailIndexPage > TrailPage2 > TrailPage4".
$InputLabelFmt
$InputLabelFmt = ' <label for="$LabelFor" $LabelTitle>$LabelText</label> ';
$FmtV
['$TableCellCount']$TableCellAttrFmt
and $TableRowAttrFmt
. Administrators can use in $TableCellAttrFmt
and/or $TableRowAttrFmt
.
$TableCellAttrFmt
= 'class=col\$TableCellCount';
$FmtV
['$TableRowCount']$TableCellAttrFmt
and/or $TableRowAttrFmt
.
TableRowAttrFmt = "class='row\$TableRowCount'";
$FmtV
['$TableRowIndex']$TableRowIndexMax
. (1,2,3,1,2,3,...). Administrators can use in $TableCellAttrFmt
and/or $TableRowAttrFmt
.
$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.