The Inter Map (also called Inter Wiki? in some other wikis) is a system for defining links between WikiWikiWeb sites that was first developed by Use Mod? and Meatball (see UseMod:InterWiki and Meatball:InterWiki). The method is to use a word shortcut that stands for a defined path. Inter Map links have the form MapPrefix:PagePath, where the host prefix is converted to a partial URL based on entries in the site's intermap.txt and localmap.txt files.

The default intermap.txt

The default intermap.txt distributed with Pm Wiki (in the scripts/ directory) includes the following Inter Map entries:

 Pm Wiki:     https://www.pmwiki.org/wiki/PmWiki/(approve sites) 
 Cookbook:   https://www.pmwiki.org/wiki/Cookbook/(approve sites) 
 Wiki:       http://www.c2.com/cgi/wiki(approve sites)? 
 Use Mod?:     http://www.usemod.com/cgi-bin/wiki.pl(approve sites)? 
 Meatball:   http://www.usemod.com/cgi-bin/mb.pl(approve sites)? 
 Wikipedia:  https://en.wikipedia.org/wiki/(approve sites) 
 PITS:       https://www.pmwiki.org/wiki/PITS/(approve sites) 
 Pm L10n?:     https://www.pmwiki.org/wiki/Localization/(approve sites)
 Path:

The page Site.InterMap?

You can map your own prefixes in your local page Site.InterMap?.

Thus, "PmWiki:Variables" becomes "https://www.pmwiki.org/wiki/PmWiki/(approve sites)" + "Variables", a link to the PmWiki.Variables(approve sites) page on the official Pm Wiki web site, Wiki:FrontPage is a link to the front page of the first Wiki Wiki Web, and Wikipedia:Stonehenge takes you to the Wikipedia article about the famous megaliths in England.

Usage in a wiki page

Like other links, you can use the double-bracket syntax to get different link text:

* [[Meatball:StartingPoints | starting points]] over at Meatball
* [[starting points -> Meatball:StartingPoints]] over at Meatball

If you want to link just to what the intermap says (e.g. https://www.wikipedia.com/wiki/(approve sites) for Wikipedia), then do [[Wikipedia:. | Wikipedia's main page]], which produces Wikipedia's main page. Note the . (period) after the Map: reference.

The special Path: Inter Map entry can be used to create "relative urls" in links.

Custom Inter Map prefixes

The actual set of Inter Map links at any site is defined by the site administrator via the Site.InterMap? page and the local/localmap.txt file.

An intermap entry takes the following format:

MapPrefix:      https://example.com/partial/url/

The Inter Map entry can be for any of the link schemes supported by Pm Wiki.
You can create your own Inter Map links by doing one or more of the following:

• Modify the page called Site.InterMap? and place entries like the ones above in it.
• Create a file called local/localmap.txt and place entries like the ones above in it.
• In a WikiFarm installation you can create a file called local/farmmap.txt and there place entries like the ones above in it. These prefixes will be common to all the wikis in the farm.
• Ensure that there is a space after the colon.

Do not edit the file scripts/intermap.txt directly! If you do, you'll lose your changes when you upgrade Pm Wiki.

Variables and Inter Map links

It's possible to use variables within your Inter Map entries. The following entries create ThisWiki: and ThisPage: shortcuts:

ThisWiki:        $ScriptUrl
ThisPage:        {$PageUrl}

You can also define Inter Map entries where the text of the entry is substituted into the middle of the URL. Just include '$1' in the URL where you want the substitution to take place. For example:

would cause Jargon:F/feature-creep to be converted to http://catb.org/~esr/jargon/html/F/feature-creep.html.

Tips and tricks

It is possible to document your intermap prefixes directly in the page Site.InterMap?. The extra text will not cause a performance penalty, nor will it break the definition of prefixes. However, be aware that anything matching a line starting with a word and a colon (:) will be considered to define a prefix.

The order in which various sources are checked for definitions of prefixes is controlled by the variable $InterMapFiles. Currently the precedence (highest to lowest is as follows):

• local/localmap.txt
• $SiteGroup.Inter Map
• $FarmD/local/farmmap.txt
• $FarmD/scripts/intermap.txt

      $LinkFunctions['PmWikiHome:'] = 'LinkIMap';
      $IMap['PmWikiHome:'] = 'https://pmwiki.org/wiki/$1';