Interwiki Plugin
The InterwikiPlugin links
ExternalSite:Page
text to external sites based on aliases defined in the
InterWikis topic. This plugin is inspired by UseMod Wiki's inter-wiki links,
http://www.usemod.com/cgi-bin/wiki.pl?InterWiki.
Syntax Rules
- Enter
ExternalSite:Page
to create a link that points to the Page
on the ExternalSite
server.
- Enter
[[ExternalSite:Page][any label]]
to specify a custom label.
- All
ExternalSite
aliases are defined in the InterWikis topic.
- Add and edit aliases in InterWikis.
- Each entry must be of format:
| External site alias | URL | Tooltip help text |
.
- Site aliases must start with an upper case letter and may contain alphanumeric letters.
- The URL and Tooltip Text may contain optional
$page
fromatting tokens; the token gets expanded to the page name.
For Foswiki and TWiki sites, both the web and the topic have to be specified: Foswiki:Webname/SomePage
Foswiki:Extensions/InterwikiPlugin or Foswiki:Extensions.InterwikiPlugin
InterwikiPlugin Settings
You can override the default settings using
preferences. These preferences can be set in your
SitePreferences, or in WebPreferences, or in individual topics.
Preference |
Use to |
Default |
INTERWIKIPLUGIN_RULESTOPIC |
Change the link rules topic name |
InterWikis |
INTERWIKIPLUGIN_INTERLINKFORMAT |
Set the interlink format |
<a href="$url" title="$tooltip" class="interwikiLink"><noautolink>$label</noautolink></a> |
The
INTERWIKIPLUGIN_INTERLINKFORMAT
supports a number of formatting tokens:
Token |
Meaning |
$site |
Site alias |
$page |
Page (part after colon) |
$url |
Site URL (might contain $page) |
$label |
Equal to $site:$page |
$tooltip |
Tooltip message |
Plugin Installation Instructions
You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.
Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".
If you have any problems, or if the extension isn't available in
configure
, then you can still install manually from the command-line. See
http://foswiki.org/Support/ManuallyInstallingExtensions for more help.
Plugin Info