Difference: InterwikiPlugin (r11 vs. r10)

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.
  • 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.
  • HELP For TWiki sites, both the web and the topic have to be specified: TWikisite:Webname/SomePage

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

Plugin Installation Instructions

ALERT! 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, 2001-2007, Andrea Sterbini, Peter Thoeny ( TWiki:Main.AndreaSterbini TWIKI.NET , ), Peter TWikiContributor Thoeny
License: GPL (GNU General Public License)
Plugin Version: 11935 16052 (22 Jan 2008)
Change History:  
08 25 Nov 2006: 2007: 11935 15752 - Added css class="interwikiLink"TWikibug:Item5006( - Renamed Bugs rule to TWikibug rule (PTh) TWiki:Main.PeterThoeny)
07 Nov 2006: 13 Aug 2007: 11924 14545 - Added INTERLINKFORMAT; removed redundant SUPPRESSTOOLTIP; allow @ signs in page part of interwiki link; support single digit page part ( TWiki:Main.PeterThoeny TWikibug:Item4451 - Added Bugs: rule (TWiki:Main.CrawfordCurrie)
26 Feb 2005: 11 Aug 2007: 1.008 14538 - Fixed broken ISBN link ( TWiki:Main.CrawfordCurrie TWiki:Main.PeterThoeny cleaned ) up code and made Dakar-ready
25 Aug 2004: 08 Nov 2006: 1.005 11935 - Added css class="interwikiLink" (TWiki:Main.PeterThoenyupdated ) InterWikis link rules (no code change)
09 Mar 2004: 07 Nov 2006: Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler 11924 - Added INTERLINKFORMAT; removed redundant SUPPRESSTOOLTIP; allow @ signs in page part of interwiki link; support single digit page part ( TWiki:Main.PeterThoeny)
16 26 Feb 2004: 2005: Support 1.008 [[Site:Page][label]]TWiki:Main.CrawfordCurrieInterwiki links (PTh); use TWiki::Func interface cleaned up code and made Dakar-ready for I18N regular expressions (Walter Mundt)
18 Jan 2003: 25 Aug 2004: Allow 1.005 number sign #TWiki:Main.PeterThoenyin updated Page name (PTh) InterWikis link rules (no code change)
31 Aug 2002: 09 Mar 2004: Allow percent sign Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler % in page name (PTh)
27 Jul 2001: 16 Feb 2004: Allow Support numbers 0-9 [[Site:Page][label]] in site name Interwiki links (PTh); use TWiki::Func interface for I18N regular expressions (Walter Mundt)
26 Jul 2001: 18 Jan 2003: Fixed alternating missed Allow number sign link bug due to greedy $postfixPattern (fix by Richard Donkin) # in Page name (PTh)
14 Jul 2001: 31 Aug 2002: Changed to plug Allow percent sign & play % in page name (PTh)
16 Jun 27 Jul 2001: Made tooltips Allow numbers optional; prevent Module::Sub0-9type of link in site name
12 Jun 26 Jul 2001: Added optional tool Fixed alternating missed tips (IE only); added the link rules topic name variable; added flexible link patterns; optional bug due to greedy $postfixPattern (fix by Richard Donkin) $page in URL
10 Jun 14 Jul 2001: Changed rules topic to table-based syntax plug & play
20 Feb 16 Jun 2001: TWiki:Main.AndreaSterbini Made tooltips optional; prevent , Module::SubTWiki:Main.PeterThoeny type of link - Initial version
CPAN Dependencies: 12 Jun 2001: none Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional $page in URL
Other Dependencies: 10 Jun 2001: none Changed rules topic to table-based syntax
Perl Version: 20 Feb 2001: 5.0 TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version
Benchmarks CPAN Dependencies: : GoodStyle none 100%, FormattedSearch 98%, InterwikiPlugin 98%
Plugin Home: Other Dependencies: http://TWiki.org/cgi-bin/view/Plugins/InterwikiPlugin none
Feedback: Perl Version: http://TWiki.org/cgi-bin/view/Plugins/InterwikiPluginDev 5.0
Appraisal: Benchmarks: http://TWiki.org/cgi-bin/view/Plugins/InterwikiPluginAppraisal 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

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

-- TWiki:Main.PeterThoeny- 08 25 Nov 2006 2007

 
This site is powered by the TWiki collaboration platformCopyright © 1999-2019 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.