PmWiki»Custom InterMap

Custom InterMap

Introduction

This page describes how a wiki administrator can create additional InterMap links.

The file intermap.txt in the scripts/ directory specifies the default InterMap links that are distributed with PmWiki. Each line of intermap.txt has the following format:

MapPrefix http://www.somehost.com/partial/url/

For example, intermap.txt has the following entries:

ISBN            http://www.amazon.com/exec/obidos/ASIN/
IMDB            http://www.imdb.com/find?q=
Meatball        http://www.usemod.com/cgi-bin/mb.pl?
PmWiki          http://www.pmichaud.com/wiki/PmWiki/
UseMod          http://www.usemod.com/cgi-bin/wiki.pl?
Wiki            http://c2.com/cgi/wiki?
Wikipedia       http://www.wikipedia.com/wiki/

To create your own InterMap links, do not edit the intermap.txt file directly! You'll lose your changes when you do a PmWiki.Upgrade. Instead, create a file called localmap.txt in the local/ subdirectory containing your InterMap links in the format described above. PmWiki will automatically read your links after loading the intermap.txt entries.

You can also define InterMap 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:

Jargon http://www.catb.org/~esr/jargon/html/$1.html

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

Variables and InterMap Links

It is possible to use variables together with the URLs in the InterMap entries. For instance, you can add something like this to your local/localmap.txt file, creating ThisWiki: and ThisPage: shortcuts:

ThisWiki        $ScriptUrl
ThisPage        $PageUrl

InterMap Links in a Farm

Note that if you want to use InterMap links in a farm. The file to put into the Farm local directory is farmmap.txt, and not localmap.txt

<< Wiki Farms | DocumentationIndex | Custom markup >>