Delta Controls Interwikiplugin

Delta Controls

InterwikiPlugin

No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval system or translated into any language (natural or computer), in any form or by any means, without the prior written permission of Delta Controls Inc.

Limited permission is granted to reproduce documents released in Adobe Portable Document Format (PDF) electronic format in paper format. Documents released in PDF electronic format may be printed by end users for their own use using a printer such as an inkjet or laser device. Authorized distributors of Delta Controls Inc. products (Delta Partners) may print PDF documents for their own internal use or for use by their customers. Authorized Delta Partners may produce copies of released PDF documents with the prior written permission of Delta Controls Inc.

Information in this document is subject to change without notice and does not represent a commitment to past versions of this document on the part of Delta Controls Inc.

Interwiki Plugin...... 1 of 3 Syntax Rules...... 1 of 3 InterwikiPlugin Settings...... 1 of 3 Plugin Installation Instructions...... 2 of 3 Plugin Info...... 2 of 3

i 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. ♦ If Page contains spaces, it can be enclosed in single or double quotes. Example: MySite:'My Photo.jpg'. Special characters contained within the quotes are URL encoded. • 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 fromatting tokens; the token gets expanded to the page name.

For Foswiki and TWiki sites, both the web and the topic have to be specified: Foswiki:Webname/SomePage

Foswiki:Extensions/InterwikiPlugin or Foswiki:Extensions.InterwikiPlugin

For links with paranthesis you will need to write as [[Wikipedia:Fork_(software_development)]], or quoted, as Wikipedia:'Fork_(software_development)' as we assume that the closing paranthesis is not part of the link. For example, Wikipedia:Fork_(software_development) . InterwikiPlugin Settings

You can override the default settings using preferences. These preferences can be set in your SitePreferences, or in WebPreferences, or in individual topics.

Preference Use to Default The topic(s) containing the inter-wiki rules. Can be a INTERWIKIPLUGIN_RULESTOPIC comma separated list. See InterWikis InterWikis#AddingYourOwn for more details $label The INTERWIKIPLUGIN_INTERLINKFORMAT supports a number of formatting tokens: Token Meaning $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

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

• 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

Author:Foswiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny Copyright:© 2001-2007, Andrea Sterbini, Peter Thoeny (TWIKI.NET), 2007-2012 ProjectContributor License:GPL (GNU General Public License) Version:v1.1.6 Release:1.1.6 Change History: 12 Novupdate CPAN link to goto metacpan and remove some ancient links that have been broken 1012: (1.1.6)for years. Convert to perl version strings 05 Dec Release with Foswiki 1.1.4 - Minor code and documentation cleanup 2011: (1.1.2) Foswiki:Main.GeorgeClark - Add support for quoted page references from TimotheLitt 30 Oct 2011: (Foswikitask:Item10872) 10 Apr 2011:Foswiki:Main.AndrewJones - Links can now be formatted (Foswikitask:Item10619) Foswiki:Main.AndrewJones - Fix inter-wiki's with parentheses (Foswikitask:Item10151). 13 Dec Note, you will need to write as [[Wikipedia:Fork_(software_development)]], as 2010: we assume the closing parenthesis is not part of the link. 10 DecFoswiki:Main.AndrewJones - Allow the INTERWIKIPLUGIN_RULESTOPIC to be a comma 2010:separated list. Implements Foswiki:Development/InheritWikiLinksTopics 12 Jul 2010:Foswiki:Main.AndrewJones - Check access controls on InterWikis topic 10 Jul 2010:mod_perl and FastCGI compatible 20 Sep Version from 15 Apr now included with Foswiki 1.0.7 2009: 15 Apr 2009:Foswiki:Main.CrawfordCurrie - removed plugin preferences from this topic 16 Dec Foswiki:Main.KennethLavrsen - Foswiki version - no features changed 2008: 03 Aug TWiki 4.2.1 release version 2008: 22 Jan 2008:TWiki 4.2.0 release version 15752 - TWikibug:Item5006 - Renamed Bugs rule to TWikibug rule (PTh)

25 Nov 2007: 13 Aug 14545 - TWikibug:Item4451 - Added Bugs: rule (Foswiki:Main.CrawfordCurrie) 2007: 11 Aug 14538 - Fixed broken ISBN link (TWiki:Main.PeterThoeny) 2007: 08 Nov 11935 - Added css class="interwikiLink" (TWiki:Main.PeterThoeny) 2006: 07 Nov11924 - Added INTERLINKFORMAT; removed redundant SUPPRESSTOOLTIP; allow @ 2006:signs in page part of interwiki link; support single digit page part (TWiki:Main.PeterThoeny) 26 Feb 1.008 Foswiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready 2005: 25 Aug 1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change) 2004: 09 MarInternal changes: Use only official TWiki::Func Plugin API; for increased speed, moved 2004:Interwiki link handling from outsidePREHandler to startRenderingHandler 16 FebSupport [[Site:Page][label]] Interwiki links (PTh); use TWiki::Func interface for I18N 2004:regular expressions (Walter Mundt) 18 Jan 2003:Allow number sign # in Page name (PTh) 31 Aug Allow percent sign % in page name (PTh) 2002: 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 Added optional tool tips (IE only); added the link rules topic name variable; added flexible 12 Jun 2001: link patterns; optional $page in URL 10 Jun 2001:Changed rules topic to table-based syntax 20 Feb TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version 2001: Plugin http://foswiki.org/Extensions/InterwikiPlugin Home: Support:http://foswiki.org/Support/InterwikiPlugin

This topic: System > Plugins > InterwikiPlugin Topic revision: 10 Apr 2011, ProjectContributor