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

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 a rules topic

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

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

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Copyright:	© 2006, TWiki:Main.AndreaSterbini, Peter Thoeny
License:	GPL (GNU General Public License)
Plugin Version:	11935
Change History:
08 Nov 2006:	11935 - Added css `class="interwikiLink"` (TWiki:Main.PeterThoeny)
07 Nov 2006:	11924 - Added INTERLINKFORMAT; removed redundant SUPPRESSTOOLTIP; allow @ signs in page part of interwiki link; support single digit page part (TWiki:Main.PeterThoeny)
26 Feb 2005:	1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready
25 Aug 2004:	1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change)
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:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Benchmarks:	GoodStyle 100%, FormattedSearch 98%, InterwikiPlugin 98%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/InterwikiPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/InterwikiPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/InterwikiPluginAppraisal

-- TWiki:Main.PeterThoeny - 08 Nov 2006

Topic InterwikiPlugin . { Edit | Ref-By | Printable | Diffs r10 < r9 < r8 < r7 < r6 | More }

java.net RSS

Revision r10 - 08 Nov 2006 - 22:23:38 - PeterThoeny	TWiki (TM) Copyright © 1999-2003 by Peter Thoeny ALL RIGHTS RESERVED