| 1 | %META:TOPICINFO{author="ProjectContributor" date="1186881349" format="1.1" version="$Rev$"}% |
|---|
| 2 | %META:TOPICPARENT{name="Plugins"}% |
|---|
| 3 | ---+!! Interwiki Plugin |
|---|
| 4 | <!-- |
|---|
| 5 | * Set SHORTDESCRIPTION = %$SHORTDESCRIPTION% |
|---|
| 6 | --> |
|---|
| 7 | |
|---|
| 8 | The <nop>%TOPIC% links ==ExternalSite:Page== text to external sites based on aliases defined in the %SYSTEMWEB%.InterWikis topic. This plugin is inspired by <nop>UseMod Wiki's inter-wiki links, http://www.usemod.com/cgi-bin/wiki.pl?InterWiki. |
|---|
| 9 | |
|---|
| 10 | %TOC% |
|---|
| 11 | |
|---|
| 12 | ---++ Syntax Rules |
|---|
| 13 | |
|---|
| 14 | * Enter ==ExternalSite:Page== to create a link that points to the ==Page== on the ==ExternalSite== server. |
|---|
| 15 | * Enter ==[<nop>[ExternalSite:Page][any label]]== to specify a custom label. |
|---|
| 16 | * All ==ExternalSite== aliases are defined in the %SYSTEMWEB%.InterWikis topic. |
|---|
| 17 | * Add and edit aliases in %SYSTEMWEB%.InterWikis. |
|---|
| 18 | * Each entry must be of format: <br /> ==| External site alias | URL | Tooltip help text |==. |
|---|
| 19 | * Site aliases must start with an upper case letter and may contain alphanumeric letters. |
|---|
| 20 | * The URL and Tooltip Text may contain optional ==$page== fromatting tokens; the token gets expanded to the page name. |
|---|
| 21 | * %H% For Foswiki and TWiki sites, both the *web* and the *topic* have to be specified: ==<nop>Foswikisite:Webname/<nop>SomePage== |
|---|
| 22 | * Foswiki:Extensions/InterwikiPlugin or Foswiki:Extensions.InterwikiPlugin |
|---|
| 23 | |
|---|
| 24 | ---++ <nop>%TOPIC% Settings |
|---|
| 25 | |
|---|
| 26 | You can override the default settings using [[%SYSTEMWEB%.PreferenceSettings][preferences]]. These preferences can be set in your %USERSWEB%.SitePreferences, or in !WebPreferences, or in individual topics. |
|---|
| 27 | |
|---|
| 28 | | *Preference* | *Use to* | *Default* | |
|---|
| 29 | | =INTERWIKIPLUGIN_RULESTOPIC= | Change the link rules topic name | %SYSTEMWEB%.InterWikis | |
|---|
| 30 | | =INTERWIKIPLUGIN_INTERLINKFORMAT= | Set the interlink format | =<a href="$url" title="$tooltip" class="interwikiLink"><noautolink>$label</noautolink></a>= | |
|---|
| 31 | The =INTERWIKIPLUGIN_INTERLINKFORMAT= supports a number of formatting tokens: |
|---|
| 32 | | *Token* | *Meaning* | |
|---|
| 33 | | $site | Site alias | |
|---|
| 34 | | $page | Page (part after colon) | |
|---|
| 35 | | $url | Site URL (might contain $page) | |
|---|
| 36 | | $label | Equal to $site:$page | |
|---|
| 37 | | $tooltip | Tooltip message | |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | ---++ Plugin Installation Instructions |
|---|
| 41 | |
|---|
| 42 | %$INSTALL_INSTRUCTIONS% |
|---|
| 43 | |
|---|
| 44 | * *Test:* If the Plugin is correctly installed, this Wiki:InterWiki link should point to http://c2.com/cgi/wiki?InterWiki topic - try it out. |
|---|
| 45 | |
|---|
| 46 | ---++ Plugin Info |
|---|
| 47 | |
|---|
| 48 | | Author: | Foswiki:%USERSWEB%.AndreaSterbini, TWiki:Main.PeterThoeny | |
|---|
| 49 | | Copyright: | © 2001-2007, Andrea Sterbini, Peter Thoeny ([[http://www.twiki.net/][TWIKI.NET]]), %SYSTEMWEB%.ProjectContributor | |
|---|
| 50 | | License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | |
|---|
| 51 | | Version: | %$VERSION% | |
|---|
| 52 | | Release: | %$RELEASE% | |
|---|
| 53 | | Change History: | <!-- versions below in reverse order --> | |
|---|
| 54 | | 10 Jul 2010: | =mod_perl= and =FastCGI= compatible | |
|---|
| 55 | | 20 Sep 2009: | Version from 15 Apr now included with Foswiki 1.0.7. | |
|---|
| 56 | | 15 Apr 2009: | Foswiki:Main.CrawfordCurrie - removed plugin preferences from this topic | |
|---|
| 57 | | 16 Dec 2008: | Foswiki:Main.KennethLavrsen - Foswiki version - no features changed | |
|---|
| 58 | | 03 Aug 2008: | TWiki 4.2.1 release version | |
|---|
| 59 | | 22 Jan 2008: | TWiki 4.2.0 release version | |
|---|
| 60 | | 25 Nov 2007: | 15752 - TWikibug:Item5006 - Renamed Bugs rule to TWikibug rule (PTh) | |
|---|
| 61 | | 13 Aug 2007: | 14545 - TWikibug:Item4451 - Added Bugs: rule (TWiki:Main.CrawfordCurrie) | |
|---|
| 62 | | 11 Aug 2007: | 14538 - Fixed broken ISBN link (TWiki:Main.PeterThoeny) | |
|---|
| 63 | | 08 Nov 2006: | 11935 - Added css =class="interwikiLink"= (TWiki:Main.PeterThoeny) | |
|---|
| 64 | | 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) | |
|---|
| 65 | | 26 Feb 2005: | 1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready | |
|---|
| 66 | | 25 Aug 2004: | 1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change) | |
|---|
| 67 | | 09 Mar 2004: | Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler | |
|---|
| 68 | | 16 Feb 2004: | Support =[<nop>[Site:Page][label]]= Interwiki links (PTh); use TWiki::Func interface for <nop>I18N regular expressions (Walter Mundt) | |
|---|
| 69 | | 18 Jan 2003: | Allow number sign =#= in Page name (PTh) | |
|---|
| 70 | | 31 Aug 2002: | Allow percent sign =%= in page name (PTh) | |
|---|
| 71 | | 27 Jul 2001: | Allow numbers =0-9= in site name | |
|---|
| 72 | | 26 Jul 2001: | Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) | |
|---|
| 73 | | 14 Jul 2001: | Changed to plug & play | |
|---|
| 74 | | 16 Jun 2001: | Made tooltips optional; prevent ==Module::Sub== type of link | |
|---|
| 75 | | 12 Jun 2001: | Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional ==$page== in URL | |
|---|
| 76 | | 10 Jun 2001: | Changed rules topic to table-based syntax | |
|---|
| 77 | | 20 Feb 2001: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version | |
|---|
| 78 | | Plugin Home: | http://foswiki.org/Extensions/%TOPIC% | |
|---|
| 79 | | Support: | http://foswiki.org/Support/%TOPIC% | |
|---|
| 80 | |
|---|
| 81 | |
|---|
