Link Variables {PmWiki}

<< Layout Variables | PmWiki.Variables | Notify >> admins (advanced)

$WikiWordCountMax

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

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

$WikiWordCount

An array that allows the number of WikiWord conversions to be set on a per-WikiWord 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['WikiWord']=5;  # Convert WikiWord 5 times
        # the following lines keep a page from linking to itself
        $title = FmtPageName('$Title_',$pagename);
        $WikiWordCount[$title]=0;    

$PagePathFmt

DocumentationToDo. But look at Cookbook:PagePaths for some ideas.

$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'>\$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>"; 

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

$InterMapFiles

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

$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