InterwikiPlugin

InterwikiPlugin

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

• Write ExternalSite:Page to create automatically a link that points to the Page on the ExternalSite server.
• All ExternalSite aliases are defined in the InterWikis topic.
• To add new aliases just follows the instructions in InterWikis.

InterwikiPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is 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 pre-installed 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 Plugin web (see below)
• Unzip InterwikiPlugin.zip in your twiki installation directory. Content:

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

• Test if the plugin is correctly installed: Wiki:InterWiki should point to Wiki's http://c2.com/cgi/wiki?InterWiki topic.

Plugin Info

Related Topics: InterWikis, TWikiPreferences, TWikiPlugins

-- AndreaSterbini - 20 Oct 2000
-- PeterThoeny - 27 Jul 2001