PmWiki: Link Variables

$EnableLinkPageRelative

When enabled, causes PmWiki to use relative urls for page links instead of absolute urls.

       $EnableLinkPageRelative = 1;

$PagePathFmt

This array lists the order in which PmWiki looks for the page that you most likely are attempting to link to. The default is listed below. Look at Cookbook:PagePaths for some ideas.

       array('{$Group}.$1', '$1.$1', '$1.{$DefaultName}')

$LinkPageExistsFmt

The (HTML) string to output for links to already existing wiki pages. Defaults to

       <a class='wikilink' href='\$LinkUrl'>\$LinkText</a>

$LinkPageCreateFmt

The (HTML) string to output for links to non-existent wiki pages. The default is to add a ‘?’ after the link text with a link to the page edit/create form. Defaults to

       <a class='createlinktext' href='\$PageUrl?action=edit'>\$LinkText</a>
       <a class='createlink' href='\$PageUrl?action=edit'>?</a>

$LinkPageCreateSpaceFmt

Same as $LinkPageCreateFmt, but used when the link text has a space in it.

$LinkPageSelfFmt

The (HTML) string to output for self-referencing links (i.e. links to the page itself). Defaults to

       <a class='selflink' href='\$LinkUrl'>\$LinkText</a>

$UrlLinkFmt

The (HTML) string to output for URL-links that begin with ‘http:’, ‘ftp:’, etc. Defaults to

       <a class='urllink' href='\$LinkUrl' title='\$LinkAlt' rel='nofollow'>\$LinkText</a>

$IMapLinkFmt

an array of link formats for various link “schemes”. Not set as default.

        $IMapLinkFmt['http:'] = "<a class='httplink urllink' href='\$LinkUrl'>\$LinkText</a>";  

        $IMapLinkFmt['https:'] = "<a class='httpslink urllink' href='\$LinkUrl'>\$LinkText</a>";   

        $IMapLinkFmt['PmWiki:'] = "<a class='pmwikilink urllink' href='\$LinkUrl'>\$LinkText</a>";

$InterMapFiles

An array consisting a list of files and pages containing InterMap entries to be loaded.

$MakePageNameFunction

Name of a custom function to replace MakePageName(), which converts strings into valid page names.

$MakePageNamePatterns

$MakePageNamePatterns is an array of regular expression replacements that is used to map the page link in a free link such as [[free link]] into a page name. Currently the default sequence is:

    "/'/" => '',                           # strip single-quotes
    "/[^$PageNameChars]+/" => ' ',         # convert non-alnums to spaces
    "/((^|[^-\\w])\\w)/e" 
      => "strtoupper('$1')",               # initial caps after spaces
    "/ /" => ''                            # strip spaces

$MakePageNameSplitPattern

See Cookbook:DotsInLinks.

$WikiWordCountMax

The maximum number of times to convert each Wiki Word encountered on a page. Defaults to 1,000,000. Common settings for this variable are zero (disable Wiki Word links) and one (convert only the first occurrence of each Wiki Word).

       $WikiWordCountMax = 0;     # disable Wiki Word links
       $WikiWordCountMax = 1;     # convert only first Wiki Word

$WikiWordCount

An array that allows the number of Wiki Word conversions to be set on a per-Wiki Word basis. The default is to use $WikiWordCountMax unless a value is set in this array. By default PmWiki sets $WikiWordCount[‘PmWiki’]=1 to limit the number of conversions of “PmWiki”.

       $WikiWordCount['PhD']=0;     # Don't convert "PhD"
       $WikiWordCount[‘Wiki Word’]=5;  # Convert Wiki Word 5 times
       # the following lines keep a page from linking to itself
       $title = FmtPageName(‘$Title_’,$pagename);
       $WikiWordCount[$title]=0;   

$EnableRedirectQuiet

Enable the quiet=1 parameter for the redirect directive. On publicly edited wikis it is advisable not to enable quiet redirects.

       $EnableRedirectQuiet = 0;     # disable quiet redirects (default)
       $EnableRedirectQuiet = 1;     # enable quiet redirects

Categories: PmWiki Developer

Copyright © 2025 the Affinity Projects wiki and its authors — Attribution ShareAlike