data/TWiki/InterwikiPlugin.txt
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 %META:TOPICINFO{author="PeterThoeny" date="1186881349" format="1.1" version="11"}%
       
     2 ---+!! Interwiki Plugin
       
     3 
       
     4 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.
       
     5 
       
     6 %TOC%
       
     7 
       
     8 ---++ Syntax Rules
       
     9 
       
    10    * Enter ==ExternalSite:Page== to create a link that points to the ==Page== on the ==ExternalSite== server.
       
    11    * Enter ==[<nop>[ExternalSite:Page][any label]]== to specify a custom label.
       
    12    * All ==ExternalSite== aliases are defined in the %TWIKIWEB%.InterWikis topic.
       
    13    * Add and edit aliases in %TWIKIWEB%.InterWikis.
       
    14    * Each entry must be of format: <br /> ==| External site alias | URL | Tooltip help text |==.
       
    15    * Site aliases must start with an upper case letter and may contain alphanumeric letters.
       
    16    * The URL and Tooltip Text may contain optional ==$page== variables; the variable gets expanded to the page name.
       
    17    * %H% For TWiki sites, both the *web* and the *topic* have to be specified: ==<nop>TWikisite:Webname/<nop>SomePage==
       
    18       * TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin
       
    19 
       
    20 ---++ <nop>%TOPIC% Settings
       
    21 
       
    22 Plugin settings are stored as Preferences variables. To reference
       
    23 a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
       
    24 
       
    25    * One-line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
       
    26       * Set SHORTDESCRIPTION = Link ==ExternalSite:Page== text to external sites based on aliases defined in a rules topic
       
    27 
       
    28    * Link rules topic name: (default is %TWIKIWEB%.InterWikis)
       
    29       * Set RULESTOPIC = 
       
    30 
       
    31    * Inter-link format, with variables:
       
    32      | $site | Site alias |
       
    33      | $page | Page (part after colon) |
       
    34      | $url | Site URL (might contain $page) |
       
    35      | $label | Equal to $site:$page |
       
    36      | $tooltip | Tooltip message |
       
    37       * Set INTERLINKFORMAT = <a href="$url" title="$tooltip" class="interwikiLink"><noautolink>$label</noautolink></a>
       
    38 
       
    39 ---++ Plugin Installation Instructions
       
    40 
       
    41 %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.
       
    42 
       
    43    * *Download* the ZIP file from the TWiki:Plugins web (see below)
       
    44    * *Unzip* ==%TOPIC%.zip== in your TWiki installation directory. Content:
       
    45      | *File:* | *Description:* |
       
    46      | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
       
    47      | ==data/TWiki/InterWikis.txt== | Link rules topic for inter-site links |
       
    48      | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
       
    49    * *Test:* If the Plugin is correctly installed, this Wiki:InterWiki link should point to http://c2.com/cgi/wiki?InterWiki topic - try it out.
       
    50 
       
    51 ---++ Plugin Info
       
    52 
       
    53 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
       
    54 |  Copyright: | &copy; 2001-2007, Andrea Sterbini, Peter Thoeny ([[http://www.twiki.net/][TWIKI.NET]]), %TWIKIWEB%.TWikiContributor |
       
    55 |  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
       
    56 |  Plugin Version: | 16052 (22 Jan 2008) |
       
    57 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
       
    58 |  25 Nov 2007: | 15752 - TWikibug:Item5006 - Renamed Bugs rule to TWikibug rule (PTh) |
       
    59 |  13 Aug 2007: | 14545 - TWikibug:Item4451 - Added Bugs: rule (TWiki:Main.CrawfordCurrie) |
       
    60 |  11 Aug 2007: | 14538 - Fixed broken ISBN link (TWiki:Main.PeterThoeny) |
       
    61 |  08 Nov 2006: | 11935 - Added css =class="interwikiLink"= (TWiki:Main.PeterThoeny) |
       
    62 |  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) |
       
    63 |  26 Feb 2005: | 1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready |
       
    64 |  25 Aug 2004: | 1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change) |
       
    65 |  09 Mar 2004: | Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler |
       
    66 |  16 Feb 2004: | Support =[<nop>[Site:Page][label]]= Interwiki links (PTh); use TWiki::Func interface for <nop>I18N regular expressions (Walter Mundt) |
       
    67 |  18 Jan 2003: | Allow number sign =#= in Page name (PTh) |
       
    68 |  31 Aug 2002: | Allow percent sign =%= in page name (PTh) |
       
    69 |  27 Jul 2001: | Allow numbers =0-9= in site name |
       
    70 |  26 Jul 2001: | Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) |
       
    71 |  14 Jul 2001: | Changed to plug & play |
       
    72 |  16 Jun 2001: | Made tooltips optional; prevent ==Module::Sub== type of link |
       
    73 |  12 Jun 2001: | Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional ==$page== in URL |
       
    74 |  10 Jun 2001: | Changed rules topic to table-based syntax |
       
    75 |  20 Feb 2001: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version |
       
    76 |  CPAN Dependencies: | none |
       
    77 |  Other Dependencies: | none |
       
    78 |  Perl Version: | 5.0 |
       
    79 |  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle 100%, %TWIKIWEB%.FormattedSearch 98%, %TOPIC% 98% |
       
    80 |  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
       
    81 |  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
       
    82 |  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
       
    83 
       
    84 __Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.InterWikis
       
    85 
       
    86 -- TWiki:Main.PeterThoeny - 25 Nov 2007