PmWiki | PmWiki / LayoutVariables

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

: $A c t i o n S k i n : T h i s a r r a y i s u s e d t o o v e r r i d e t h e c u r r e n t s k i n w h e n p e r f o r m i n g a g i v e n a c t i o n . T h e m o s t c o m m o n u s e i s t o s e t @ @$ ActionSkin['print']='foo' to use the 'foo' skin when printing, regardless of what the $S k i n @ @ v a r i a b l e i s s e t t o .$

$W i k i T i t l e$: A variable which contains the Wiki title as displayed by the browser
$H T M L S t y l e s F m t$: 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.
$H T M L H e a d e r F m t$: An array of HTML text to be included in the page's <head> section, at the point where the skin template specifies a  directive. 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['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" />';

Another example, if you want to get the rss notification on some browsers (the rss icon in firefox for instance):

 
$HTMLHeaderFmt['rss'] =
  '<link rel="alternate" type="application/rss+xml" title="Rss All recent Changes" 
     href="$ScriptUrl/Site/AllRecentChanges?action=rss" />';

: $H T M L F o o t e r F m t : L i k e$ 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  directive (usually just before a closing </body> tag). Primarily used by scripts to add custom HTML output after the body of the page output.

: $M e t a R o b o t s : S e t s t h e v a l u e o f t h e$ <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
         $M e t a R o b o t s$  = 'noindex,nofollow';
        # disable the robots tag entirely
         $M e t a R o b o t s$  = '';

$M e s s a g e s F m t$: 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.
$R e c e n t C h a n g e s F m t$: 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.

Also note that this variable has other uses, such as not reporting at all to RecentChanges and AllRecentChanges as found here PmWiki Questions.

: $R e c e n t U p l o a d s F m t : A n a r r a y s p e c i f y i n g t h e f o r m a t f o r u p l o a d e d f i l e s a t t h e R e c e n t C h a n g e s l i s t i n g . I t i s s i m i l a r t o$ RecentChangesFmt. If enabled, newly uploaded files will be logged to the RecentChanges pages. Default is disabled. See Cookbook:RecentUploadsLog for more information.

$D r a f t R e c e n t C h a n g e s F m t$: An array specifying the format of the RecentChanges listing when saving Draft pages.

R e c e n t C h a n g e s F m t i s s e t t o

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'] = '';

$R C L i n e s M a x$: The maximum number of lines to be stored in RecentChanges pages. The default is zero, meaning "no limit".

         $R C L i n e s M a x$  = 1000;       # maintain at most 1000 recent changes

$P a g e R e d i r e c t F m t$

The text to be used when a page is redirected via the (:redirect:) markup.

$PageRedirectFmt = '<p><i>redirected from $FullName</p>';
$PageRedirectFmt = '';

For display options, see also the FAQ on PageDirectives.

$W i k i S t y l e$: An array which contains the predefined WikiStyles which can be used on a textpage.
See: PmWiki.CustomWikiStyles

: $M a x I n c l u d e s : C o n t r o l s t h e n u m b e r o f t i m e s t h a t p a g e s c a n b e i n c l u d e d v i a t h e$ (: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.

         $M a x I n c l u d e s$  = 50;            # default
         $M a x I n c l u d e s$  = 1000;          # allow lots of includes
         $M a x I n c l u d e s$  = 0;             # turn off includes

: $S k i n : L i s t s t h e n a m e (s) o f s k i n s t o l o a d, u n l e s s o v e r r i d d e n b y$ ActionSkin. Normally $S k i n c o n t a i n s a s i n g l e s t r i n g w h i c h i s a t h e n a m e o f a s k i n d i r e c t o r y, b u t i t m a y a l s o b e a n a r r a y o f n a m e s, i n w h i c h c a s e t h e f i r s t s k i n f o u n d f r o m t h e l i s t i s u s e d .$

$S k i n D i r U r l$: 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.
$S k i n L i b D i r s$: An array which, given the filesystem path (array key) to a skin (or a directory containing several skins), provides the corresponding URL (array value).

The array key is the directory containing the skin.tmpl and skin.php files, as seen by the PmWiki program. It does not have to be publicly accessible.

The value is the URL (web address) of the directory containing the .css, .gif, and other files which appear in the HTML code sent by PMWiki to the browser. This directory must be publicly accessible.

By default $S k i n L i b D i r s$ is set to:

$SkinLibDirs = array(
  "./pub/skins/\$Skin" => "$PubDirUrl/skins/\$Skin",
  "$FarmD/pub/skins/\$Skin" => "$FarmPubDirUrl/skins/\$Skin");

Extra details: When PMWiki is searching for a skin it looks for a directory named for the skin in the array index/keys, and if it finds it then it will use the files in that directory and also the files in the matching array value url. The two sides normally point to the same publicly accessible directory, but they do not have to.

$P a g e L o g o U r l$: is the url that refers to a logo image which most skins display somewhere in the page's header (top left usually).
$E n a b l e P a t h I n f o$: 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.

: $E n a b l e F i x e d U r l R e d i r e c t : W h e n P m W i k i i s g i v e n a p a r t i a l p a g e n a m e (e . g ., j u s t t h e n a m e o f a W i k i G r o u p), i t u s e s$ 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 $E n a b l e F i x e d U r l R e d i r e c t$ =0; blocks the redirect, so that PmWiki continues processing with the adjusted page name rather than issuing the redirect.

$G r o u p H e a d e r F m t$: Defines the markup placed at the top of every page. Default value is:

         $G r o u p H e a d e r F m t = ʹ (: i n c l u d e$ Group.GroupHeader:)(:nl:)';

$G r o u p P r i n t H e a d e r F m t$: Defines the markup placed at the top of every page when action=print. Default value is:

        SDV( $G r o u p P r i n t H e a d e r F m t, ʹ (: i n c l u d e$ Group.GroupPrintHeader:)(:nl:)');

$G r o u p F o o t e r F m t$: Defines the markup placed at the bottom of every page. Default value is:

         $G r o u p F o o t e r F m t = ʹ (: i n c l u d e$ Group.GroupFooter:)(:nl:)';

$G r o u p P r i n t F o o t e r F m t$: Defines the markup placed at the bottom of every page when action=print. Default value is:

        SDV( $G r o u p P r i n t F o o t e r F m t, ʹ (: n l :) (: i n c l u d e$ Group.GroupPrintFooter:)');

$P a g e N o t F o u n d H e a d e r F m t$

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';

Beware when expecting to return the content of a Group(header|footer) for an non existent page! By default PmWiki returns 404 (because the page does not exist), despite there is some content to show. Firefox shows the content, while Internet Explorer displays its default 404 page. $P a g e N o t F o u n d H e a d e r F m t$ MUST be set to return 200 as described above in order to get the expected behaviour with all browsers.

$H T M L V S p a c e$: Setting $H T M L V S p a c e = ʺ;$ 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 $H T M L V S p a c e = ʺ;$ statement in a skin.php file, preceded by the statement global $H T M L V S p a c e;$ .

: $T a b l e C e l l A t t r F m t : F o r [[T a b l e s]], d e f i n e s t h e H T M L a t t r i b u t e s g i v e n t o e a c h @ @ < t d > @ @ o r @ @ < t h > @ @ c e l l i n t h e o u t p u t . C a n c o n t a i n r e f e r e n c e s t o$ TableCellCount which holds the horizontal column number of the current cell.

: $T a b l e R o w A t t r F m t : F o r [[T a b l e s]], d e f i n e s t h e H T M L a t t r i b u t e s g i v e n t o e a c h @ @ < t r > @ @ e l e m e n t i n t h e o u t p u t . C a n c o n t a i n r e f e r e n c e s t o$ TableRowCount to give the absolute row number within the table, or $T a b l e R o w I n d e x t o p r o v i d e a r e p e a t i n g r o w i n d e x f r o m 1 t o$ TableRowIndexMax.

        # Give each row a unique CSS class based on row number (tr1, tr2, tr3, ... )
         $T a b l e R o w A t t r F m t = " c l a s s = ʹ t r $$ TableRowCount'";
        # Give each row alternating CSS classes (ti1, ti2, ti1, ti2, ti1, ... )
         $T a b l e R o w I n d e x M a x$  = 2;
         $T a b l e R o w A t t r F m t = " c l a s s = ʹ t i $$ TableRowIndex'";

: $T a b l e R o w I n d e x M a x : T h e m a x i m u m v a l u e f o r$ TableRowIndex in Tables.

        # Set rows indexes as 1, 2, 3, 1, 2, 3, 1, 2, ...
         $T a b l e R o w I n d e x M a x$  = 3;

$F m t V [ʹ$ TableCellCount']: PMWiki internal variable - Horizontal column number of the current cell. For use in $T a b l e C e l l A t t r F m t a n d$ TableRowAttrFmt. Administrators can use in $T a b l e C e l l A t t r F m t a n d / o r$ TableRowAttrFmt.

        Example:  $T a b l e C e l l A t t r F m t = ʹ c l a s s = c o l $ T a b l e C e l l C o u n t ʹ;$

$F m t V [ʹ$ TableRowCount']: PMWiki internal variable - Current row number. Administrators can use in $T a b l e C e l l A t t r F m t a n d / o r$ TableRowAttrFmt.

        Example: TableRowAttrFmt = "class='row$TableRowCount'";

$F m t V [ʹ$ TableRowIndex']: PMWiki internal variable - Row index number derived from $T a b l e R o w I n d e x M a x . (1, 2, 3, 1, 2, 3, . . .) . A d m i n i s t r a t o r s c a n u s e i n$ TableCellAttrFmt and/or $T a b l e R o w A t t r F m t$ .

        Example:  $T a b l e R o w A t t r F m t = " c l a s s = ʹ i n d $ T a b l e R o w I n d e x ʹ ";$