steve
/
wiki-archive
mirror of https://github.com/tdwg/wiki-archive.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
wiki-archive/twiki/data/TWiki/InterwikiPlugin.txt,v

480 lines
17 KiB
Plaintext
Raw Blame History

head 1.10;
access;
symbols;
locks; strict;
comment @# @;
1.10
date 2007.01.16.04.11.59; author TWikiContributor; state Exp;
branches;
next 1.9;
1.9
date 2006.02.01.12.01.22; author TWikiContributor; state Exp;
branches;
next 1.8;
1.8
date 2004.08.25.07.40.03; author PeterThoeny; state Exp;
branches;
next 1.7;
1.7
date 2004.03.10.06.20.04; author PeterThoeny; state Exp;
branches;
next 1.6;
1.6
date 2003.01.27.07.41.14; author PeterThoeny; state Exp;
branches;
next 1.5;
1.5
date 2003.01.19.07.43.00; author PeterThoeny; state Exp;
branches;
next 1.4;
1.4
date 2003.01.12.09.06.25; author PeterThoeny; state Exp;
branches;
next 1.3;
1.3
date 2002.01.05.08.33.00; author PeterThoeny; state Exp;
branches;
next 1.2;
1.2
date 2001.10.02.06.35.17; author MikeMannix; state Exp;
branches;
next 1.1;
1.1
date 2001.07.27.06.43.32; author PeterThoeny; state Exp;
branches;
next ;
desc
@none
@
1.10
log
@buildrelease
@
text
@%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>&lt;plugin&gt;_&lt;setting&gt;%==, 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: | &copy; 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 -->&nbsp; |
| 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
@
1.9
log
@buildrelease
@
text
@d1 1
a1 3
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="9"}%
d10 9
a18 5
* Enter ==ExternalSite:Page== to create a link that points to the ==Page== on the ==ExternalSite== server.
* All ==ExternalSite== aliases are defined in the %TWIKIWEB%.InterWikis topic.
* Add and edit aliases in %TWIKIWEB%.InterWikis.
* %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
d25 2
a26 2
* 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
d28 2
a29 2
* Link rules topic name: (default is %TWIKIWEB%.InterWikis)
* Set RULESTOPIC =
d31 7
a37 2
* Suppress tooltip help for links: (==0== or ==1==, default is ==0==)
* Set SUPPRESSTOOLTIP = 0
d43 7
a49 7
* *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.
d54 3
a56 1
| Plugin Version: | 1.008 |
d58 2
d63 1
a63 1
| 16 Feb 2004: | Support =[<nop>[Site:Page][label]]= Interwiki links (PTh); use TWiki::Func interface for I18N regular expressions (Walter Mundt) |
d76 4
a79 4
| Plugin Home: | TWiki:Plugins/%TOPIC% (TWiki:Plugins/%TOPIC%) |
| Feedback: | TWiki:Plugins/%TOPIC%Dev (TWiki:Plugins/%TOPIC%Dev) |
__Related Topics:__ %TWIKIWEB%.InterWikis, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
d81 1
d83 1
@
1.8
log
@none
@
text
@d1 3
a3 1
%META:TOPICINFO{author="PeterThoeny" date="1093419603" format="1.0" version="1.8"}%
d24 1
a24 1
* Set SHORTDESCRIPTION = Link ==ExternalSite:Page== text to external sites based on aliases defined in the %WEB%.InterWikis topic
a31 3
* Debug plugin: (See output in =data/debug.txt=)
* Set DEBUG = 0
d47 1
a47 1
| Plugin Version: | 25 Aug 2004, 1.005 |
d49 2
a50 1
| 25 Aug 2004: | Updated InterWikis link rules (no code change) |
d61 1
a61 1
| 20 Feb 2001: | Initial version |
d65 2
a66 2
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% (TWiki:Plugins/%TOPIC%) |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev (TWiki:Plugins/%TOPIC%Dev) |
a69 3
-- TWiki:Main.AndreaSterbini - 20 Oct 2000 <br />
-- TWiki:Main.MikeMannix - 01 Oct 2001 <br />
-- TWiki:Main.PeterThoeny - 25 Aug 2004 <br />
@
1.7
log
@none
@
text
@d1 73
a73 71
%META:TOPICINFO{author="PeterThoeny" date="1078899604" format="1.0" version="1.7"}%
---+!! 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.
* All ==ExternalSite== aliases are defined in the %TWIKIWEB%.InterWikis topic.
* Add and edit aliases in %TWIKIWEB%.InterWikis.
* %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>&lt;plugin&gt;_&lt;setting&gt;%==, 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 the %WEB%.InterWikis topic
* Link rules topic name: (default is %TWIKIWEB%.InterWikis)
* Set RULESTOPIC =
* Suppress tooltip help for links: (==0== or ==1==, default is ==0==)
* Set SUPPRESSTOOLTIP = 0
* Debug plugin: (See output in =data/debug.txt=)
* Set DEBUG = 0
---++ 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 |
| Plugin Version: | 09 Mar 2004, 1.005 |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
| 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 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: | Initial version |
| CPAN Dependencies: | none |
| Other Dependencies: | none |
| Perl Version: | 5.0 |
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% (TWiki:Plugins/%TOPIC%) |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev (TWiki:Plugins/%TOPIC%Dev) |
__Related Topics:__ %TWIKIWEB%.InterWikis, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
-- TWiki:Main.AndreaSterbini - 20 Oct 2000 <br />
-- TWiki:Main.PeterThoeny - 09 Mar 2004 <br />
-- TWiki:Main.MikeMannix - 01 Oct 2001 <br />
@
1.6
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1043653274" format="1.0" version="1.6"}%
d14 1
a14 2
* TWiki:Plugins/InterwikiPlugin, or
* TWiki:Plugins.InterwikiPlugin
d22 1
a22 1
* Set SHORTDESCRIPTION = Link ==ExternalSite:Page== text to external sites based on aliases defined in the InterWikis topic.
d47 2
a48 2
| Plugin Author: | %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny |
| Plugin Version: | 18 Jan 2003, 1.0.3 |
d50 4
a53 2
| 18 Jan 2003: | Allow number sign =#= in Page name |
| 31 Aug 2002: | Allow percent sign =%= in page name |
d69 3
a71 3
-- %TWIKIWEB%.AndreaSterbini - 20 Oct 2000 <br />
-- %TWIKIWEB%.PeterThoeny - 18 Jan 2003 <br />
-- %TWIKIWEB%.MikeMannix - 01 Oct 2001 <br />
@
1.5
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1042962180" format="1.0" version="1.5"}%
d14 2
a15 1
* TWiki:Plugins/InterwikiPlugin
@
1.4
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="PeterThoeny" date="1042362385" format="1.0" version="1.4"}%
<nop><h1>Interwiki Plugin</h1>
d48 1
a48 1
| Plugin Version: | 31 Aug 2002, 1.0.2 |
d50 3
a52 2
| 31 Aug 2002: | Allow percent sign in site name |
| 27 Jul 2001: | Allow numbers in site name |
d68 1
a68 1
-- %TWIKIWEB%.PeterThoeny - 31 Aug 2002 <br />
@
1.3
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="PeterThoeny" date="1010219580" format="1.0" version="1.3"}%
<H1><nop>%TOPIC%</H1>
d48 10
a57 2
| Plugin Version: | 1.0.2 |
| Change History: | 27 Jul 2001 Allow numbers in site name <br /> 26 Jul 2001 Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) <br /> 14 Jul 2001 Changed to plug & play <br /> 16 Jun 2001: Made tooltips optional; prevent ==Module::Sub== type of link <br /> 12 Jun 2001: Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional ==$page== in URL <br /> 10 Jun 2001: Changed rules topic to table-based syntax <br /> 20 Feb 2001: Initial version |
d67 1
a67 1
-- %TWIKIWEB%.PeterThoeny - 27 Jul 2001 <br />
@
1.2
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1002006038" format="1.0" version="1.2"}%
d19 1
a19 1
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
d21 1
a21 1
* One-line description is shown in the %TWIKIWEB%.TextFormattingRules topic:
d58 2
a59 2
-- %TWIKIWEB%.AndreaSterbini - 20 Oct 2000 <br>
-- %TWIKIWEB%.PeterThoeny - 27 Jul 2001 <br>
@
1.1
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="PeterThoeny" date="996216650" format="1.0beta2" version="1.1"}%
---++ <nop>%TOPIC%
d4 3
a6 1
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 .
d10 1
a10 1
* Write ==ExternalSite:Page== to create automatically a link that points to the ==Page== on the ==ExternalSite== server.
d12 3
a14 1
* To add new aliases just follows the instructions in %TWIKIWEB%.InterWikis.
d18 1
a18 1
Plugin settings are stored as preferences variables. To reference
d21 1
a21 1
* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
d33 1
a33 1
---+++ Plugin Installation Instructions
d35 1
a35 1
__Note:__ This plugin is pre-installed in the TWiki distribution package. You do not need to install it unless you want to upgrade to a newer version.
d37 2
a38 2
* Download the ZIP file from the Plugin web (see below)
* Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
d43 1
a43 2
* Test if the plugin is correctly installed: Wiki:InterWiki should point to Wiki's http://c2.com/cgi/wiki?InterWiki topic.
d45 1
a45 1
---+++ Plugin Info
d49 1
a49 1
| Change History: | 27 Jul 2001 Allow numbers in site name <br /> 26 Jul 2001 Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) <br /> 14 Jul 2001 Changed to plug & play <br /> 16 Jun 2001: Made tool tips optional; prevent ==Module::Sub== type of link <br /> 12 Jun 2001: Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional ==$page== in URL <br /> 10 Jun 2001: Changed rules topic to table based syntax <br /> 20 Feb 2001: Initial version |
d60 1
@
Reference in New Issue View Git Blame Copy Permalink