TWiki Web>InterwikiPlugin (revision 7)~~EditAttach~~

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.

On this page:

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 or 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

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version:	09 Mar 2004, 1.005
Change History:
09 Mar 2004:	Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler
16 Feb 2004:	Support `[[Site:Page][label]]` Interwiki links (PTh); use TWiki::Func interface for I18N? regular expressions (Walter Mundt)
18 Jan 2003:	Allow number sign `#` in Page name (PTh)
31 Aug 2002:	Allow percent sign `%` in page name (PTh)
27 Jul 2001:	Allow numbers `0-9` in site name
26 Jul 2001:	Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin)
14 Jul 2001:	Changed to plug & play
16 Jun 2001:	Made tooltips optional; prevent `Module::Sub` type of link
12 Jun 2001:	Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional `$page` in URL
10 Jun 2001:	Changed rules topic to table-based syntax
20 Feb 2001:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/InterwikiPlugin (TWiki:Plugins/InterwikiPlugin)
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/InterwikiPluginDev (TWiki:Plugins/InterwikiPluginDev)

Related Topics: InterWikis, TWikiPreferences, TWikiPlugins

-- TWiki:Main.AndreaSterbini - 20 Oct 2000
-- TWiki:Main.PeterThoeny - 09 Mar 2004
-- TWiki:Main.MikeMannix - 01 Oct 2001

Topic revision: r7 - 10 Mar 2004 - 03:20:04 - PeterThoeny

TWiki

Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.InterwikiPlugin