Interwiki Plugin

Page contents

• Introduction
• Syntax Rules
• InterwikiPlugin Settings
• Plugin Installation Instructions
• Plugin Info

Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic

Introduction

The InterwikiPlugin links ExternalSite:Page text to a page on an external site 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. For example, type RFC:2397 to get RFC:2397.
• Enter [[ExternalSite:Page][any label]] to specify a custom label.
• All ExternalSite aliases are defined in the InterWikis topic.
• Optionally, the Page can be enclosed in single quotes or double quotes. Use quotes if your Page contains spaces or other special characters. Links of quoted pages are URL encoded. Example: Photos:"San Francisco Trip 2011".
• Add and edit aliases in InterWikis (or the one specified in the INTERWIKIPLUGIN_RULESTOPIC setting).
• 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

This plugin can be configured with preferences settings in Main.TWikiPreferences (site level), a WebPreferences (web level) or in a topic (page level). Do not change the settings here, they are here only to illustrate the default values. To overload, copy the settings to one of the aforementioned topics.

• Link rules topic name: (default is %SYSTEMWEB%.InterWikis, pointing to InterWikis)
    * Set INTERWIKIPLUGIN_RULESTOPIC = %SYSTEMWEB%.InterWikis, %WEB%.InterWikis, AnotherWeb.CustomInterWikis

• 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 INTERWIKIPLUGIN_INTERLINKFORMAT = <a href="$url" title="$tooltip" class="interwikiLink"><noautolink>$label</noautolink></a>

Plugin Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Plugin Info

• One-line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic

Plugin Author: TWiki:Main/AndreaSterbini, TWiki:Main/PeterThoeny Copyright: © 2001-2009 Andrea Sterbini, © 2001-2013 Peter Thoeny, TWiki.org, © 2001-2013 TWiki:TWiki/TWikiContributor License: GPL (GNU General Public License) Plugin Version: 2013-02-22

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

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