Interwiki Plugin

Introduction

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. For example, type RFC:2397 to get RFC:2397.
• Enter [[ExternalSite:Page][any label]] to specify a custom label.
• All ExternalSite aliases are defined in the InterWikis topic.
• Optionally, the Page can be enclosed in single quotes or double quotes. Use quotes if your Page contains spaces or other special characters. Links of quoted pages are URL encoded. Example: Photos:"San Francisco Trip 2011".
• Add and edit aliases in InterWikis (or the one specified in the INTERWIKIPLUGIN_RULESTOPIC setting).
• 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 variables; the variable gets expanded to the page name.
• For TWiki sites, both the web and the topic have to be specified: TWikisite:Webname/SomePage
  • TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin

InterwikiPlugin Settings

This plugin can be configured with preferences settings in Main.TWikiPreferences (site level), a WebPreferences (web level) or in a topic (page level). Do not change the settings here, they are here only to illustrate the default values. To overload, copy the settings to one of the aforementioned topics.

• Link rules topic name: (default is InterWikis)
  • Set INTERWIKIPLUGIN_RULESTOPIC = InterWikis

• Inter-link format, with variables:

  $site	Site alias
  $page	Page (part after colon)
  $url	Site URL (might contain $page)
  $label	Equal to $site:$page
  $tooltip	Tooltip message

  • Set INTERWIKIPLUGIN_INTERLINKFORMAT = $label

Plugin Installation Instructions

Note: This plugin is included in the TWiki distribution package. You do not need to install it unless you want to upgrade to a newer version.

• Download the ZIP file from the TWiki:Plugins web (see below)
• Unzip InterwikiPlugin.zip in your TWiki installation directory. Content:

  File:	Description:
  data/TWiki/InterwikiPlugin.txt	Plugin topic
  data/TWiki/InterWikis.txt	Link rules topic for inter-site links
  lib/TWiki/Plugins/InterwikiPlugin.pm	Plugin Perl module

• Test: If the Plugin is correctly installed, this Wiki:InterWiki link should point to http://c2.com/cgi/wiki?InterWiki topic - try it out.

Plugin Info

• One-line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Link ExternalSite:Page text to external sites based on aliases defined in a rules topic

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, InterWikis