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.
• All ExternalSite aliases are defined in the InterWikis topic.
• Add and edit aliases in InterWikis.
• For TWiki sites, both the web and the topic have to be specified: TWikisite:Webname/SomePage
  • TWiki:Plugins/InterwikiPlugin

InterwikiPlugin Settings

Plugin settings are stored as Preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%

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

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

• Suppress tooltip help for links: (0 or 1, default is 0)
  • Set SUPPRESSTOOLTIP = 0

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

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

Related Topics: InterWikis, TWikiPreferences, TWikiPlugins

-- AndreaSterbini^? - 20 Oct 2000
-- PeterThoeny - 31 Aug 2002
-- MikeMannix^? - 01 Oct 2001

to top