84 lines
5.2 KiB
Plaintext
84 lines
5.2 KiB
Plaintext
%META:TOPICINFO{author="PeterThoeny" date="1163024618" format="1.1" reprev="1.4" version="10"}%
|
|
---+!! Interwiki Plugin
|
|
|
|
The <nop>%TOPIC% links ==ExternalSite:Page== text to external sites based on aliases defined in the %TWIKIWEB%.InterWikis topic. This plugin is inspired by <nop>UseMod Wiki's inter-wiki links, http://www.usemod.com/cgi-bin/wiki.pl?InterWiki.
|
|
|
|
%TOC%
|
|
|
|
---++ Syntax Rules
|
|
|
|
* Enter ==ExternalSite:Page== to create a link that points to the ==Page== on the ==ExternalSite== server.
|
|
* Enter ==[<nop>[ExternalSite:Page][any label]]== to specify a custom label.
|
|
* All ==ExternalSite== aliases are defined in the %TWIKIWEB%.InterWikis topic.
|
|
* Add and edit aliases in %TWIKIWEB%.InterWikis.
|
|
* Each entry must be of format: <br /> ==| 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.
|
|
* %H% For TWiki sites, both the *web* and the *topic* have to be specified: ==<nop>TWikisite:Webname/<nop>SomePage==
|
|
* TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin
|
|
|
|
---++ <nop>%TOPIC% Settings
|
|
|
|
Plugin settings are stored as Preferences variables. To reference
|
|
a plugin setting write ==%<nop><plugin>_<setting>%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
|
|
|
|
* One-line description, shown in the %TWIKIWEB%.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 %TWIKIWEB%.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 = <a href="$url" title="$tooltip" class="interwikiLink">$label</a>
|
|
|
|
---++ Plugin Installation Instructions
|
|
|
|
%X% *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* ==%TOPIC%.zip== in your TWiki installation directory. Content:
|
|
| *File:* | *Description:* |
|
|
| ==data/TWiki/%TOPIC%.txt== | Plugin topic |
|
|
| ==data/TWiki/InterWikis.txt== | Link rules topic for inter-site links |
|
|
| ==lib/TWiki/Plugins/%TOPIC%.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, [[http://www.structuredwikis.com/][Peter Thoeny]]|
|
|
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|
|
| Plugin Version: | 11935 |
|
|
| Change History: | <!-- versions below in reverse order --> |
|
|
| 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 =[<nop>[Site:Page][label]]= Interwiki links (PTh); use TWiki::Func interface for <nop>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 |
|
|
| [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle 100%, %TWIKIWEB%.FormattedSearch 98%, %TOPIC% 98% |
|
|
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|
|
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|
|
| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
|
|
|
|
__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.InterWikis
|
|
|
|
-- TWiki:Main.PeterThoeny - 08 Nov 2006
|