<< BasicVariables | Variables | LinkVariables >>

This page documents the variables that are typically used for controlling page layout and display. More information about layouts is available from LayoutBasics and CustomHeadersAndFooters.

$PageLogoUrl

In a standard layout $PageLogoUrl contains the URL of an image to be display in the location of the logo. See LayoutBasics.

        $PageLogoUrl = "http://server.com/mylogo.gif";

$PageLogoFmt

The HTML code to be generated for the page logo in the default PmWiki template. Defaults to the value below, but you can set it to whatever you wish.

        $PageLogoFmt = "<div id='wikilogo'><a 
          href='$ScriptUrl'><img src='$PageLogoUrl'
          alt='$WikiTitle' border='0' /></a></div>";

$PageTemplateFmt

Specifies the name of the template file to be used to generate pages.

        $PageTemplateFmt = 'pub/skins/pmwiki/pmwiki.tmpl';

$PrintTemplateFmt

Specifies the name of the template file to be used to generate pages in Printable View (?action=print).

        $PrintTemplateFmt = 'pub/skins/print/print.tmpl';

$PageStartFmt

$PageEndFmt

These arrays contain all of the HTML and other layout code to be processed before and after the main text of each page. Normally $PageStartFmt and $PageEndFmt are initialized by code in scripts/tlayout.php, which builds the values of $PageStartFmt and $PageEndFmt from the information in the "template file" specified by $PageTemplateFmt.

$PageHeaderFmt

$PageFooterFmt

$PageTitleFmt

These variables, which may be strings or arrays of strings, contain the HTML and other layout code to be printed for the header, footer, and title of each page in PmWiki. The variables exist to allow the [[noheader]], [[nofooter]], and [[notitle]] directives to work. In a typical installation, these variables are initialized as part of processing the template files in scripts/tlayout.php and then placed by reference into the $PageStartFmt or $PageEndFmt variables. Other functions (such as ProcessTextDirectives) can then suppress or change the display of the corresponding output by simply setting these variables to an empty string or other value.

$HTMLLineBreak

This string, if set, determines how line breaks entered in a page's markup are handled and displayed. By default it is set to an empty string, which causes successive lines of text to be wrapped together. To get PmWiki to honor line breaks in the markup, set $HTMLLineBreak to generate a <br /> tag:

        $HTMLLineBreak = '<br />';