data/TWiki/InterwikiPlugin.txt
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/InterwikiPlugin.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,86 @@
     1.4 +%META:TOPICINFO{author="PeterThoeny" date="1186881349" format="1.1" version="11"}%
     1.5 +---+!! Interwiki Plugin
     1.6 +
     1.7 +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.
     1.8 +
     1.9 +%TOC%
    1.10 +
    1.11 +---++ Syntax Rules
    1.12 +
    1.13 +   * Enter ==ExternalSite:Page== to create a link that points to the ==Page== on the ==ExternalSite== server.
    1.14 +   * Enter ==[<nop>[ExternalSite:Page][any label]]== to specify a custom label.
    1.15 +   * All ==ExternalSite== aliases are defined in the %TWIKIWEB%.InterWikis topic.
    1.16 +   * Add and edit aliases in %TWIKIWEB%.InterWikis.
    1.17 +   * Each entry must be of format: <br /> ==| External site alias | URL | Tooltip help text |==.
    1.18 +   * Site aliases must start with an upper case letter and may contain alphanumeric letters.
    1.19 +   * The URL and Tooltip Text may contain optional ==$page== variables; the variable gets expanded to the page name.
    1.20 +   * %H% For TWiki sites, both the *web* and the *topic* have to be specified: ==<nop>TWikisite:Webname/<nop>SomePage==
    1.21 +      * TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin
    1.22 +
    1.23 +---++ <nop>%TOPIC% Settings
    1.24 +
    1.25 +Plugin settings are stored as Preferences variables. To reference
    1.26 +a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==
    1.27 +
    1.28 +   * One-line description, shown in the %TWIKIWEB%.TextFormattingRules topic:
    1.29 +      * Set SHORTDESCRIPTION = Link ==ExternalSite:Page== text to external sites based on aliases defined in a rules topic
    1.30 +
    1.31 +   * Link rules topic name: (default is %TWIKIWEB%.InterWikis)
    1.32 +      * Set RULESTOPIC = 
    1.33 +
    1.34 +   * Inter-link format, with variables:
    1.35 +     | $site | Site alias |
    1.36 +     | $page | Page (part after colon) |
    1.37 +     | $url | Site URL (might contain $page) |
    1.38 +     | $label | Equal to $site:$page |
    1.39 +     | $tooltip | Tooltip message |
    1.40 +      * Set INTERLINKFORMAT = <a href="$url" title="$tooltip" class="interwikiLink"><noautolink>$label</noautolink></a>
    1.41 +
    1.42 +---++ Plugin Installation Instructions
    1.43 +
    1.44 +%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.
    1.45 +
    1.46 +   * *Download* the ZIP file from the TWiki:Plugins web (see below)
    1.47 +   * *Unzip* ==%TOPIC%.zip== in your TWiki installation directory. Content:
    1.48 +     | *File:* | *Description:* |
    1.49 +     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
    1.50 +     | ==data/TWiki/InterWikis.txt== | Link rules topic for inter-site links |
    1.51 +     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
    1.52 +   * *Test:* If the Plugin is correctly installed, this Wiki:InterWiki link should point to http://c2.com/cgi/wiki?InterWiki topic - try it out.
    1.53 +
    1.54 +---++ Plugin Info
    1.55 +
    1.56 +|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
    1.57 +|  Copyright: | &copy; 2001-2007, Andrea Sterbini, Peter Thoeny ([[http://www.twiki.net/][TWIKI.NET]]), %TWIKIWEB%.TWikiContributor |
    1.58 +|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
    1.59 +|  Plugin Version: | 16052 (22 Jan 2008) |
    1.60 +|  Change History: | <!-- versions below in reverse order -->&nbsp; |
    1.61 +|  25 Nov 2007: | 15752 - TWikibug:Item5006 - Renamed Bugs rule to TWikibug rule (PTh) |
    1.62 +|  13 Aug 2007: | 14545 - TWikibug:Item4451 - Added Bugs: rule (TWiki:Main.CrawfordCurrie) |
    1.63 +|  11 Aug 2007: | 14538 - Fixed broken ISBN link (TWiki:Main.PeterThoeny) |
    1.64 +|  08 Nov 2006: | 11935 - Added css =class="interwikiLink"= (TWiki:Main.PeterThoeny) |
    1.65 +|  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) |
    1.66 +|  26 Feb 2005: | 1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready |
    1.67 +|  25 Aug 2004: | 1.005 TWiki:Main.PeterThoeny updated InterWikis link rules (no code change) |
    1.68 +|  09 Mar 2004: | Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler |
    1.69 +|  16 Feb 2004: | Support =[<nop>[Site:Page][label]]= Interwiki links (PTh); use TWiki::Func interface for <nop>I18N regular expressions (Walter Mundt) |
    1.70 +|  18 Jan 2003: | Allow number sign =#= in Page name (PTh) |
    1.71 +|  31 Aug 2002: | Allow percent sign =%= in page name (PTh) |
    1.72 +|  27 Jul 2001: | Allow numbers =0-9= in site name |
    1.73 +|  26 Jul 2001: | Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) |
    1.74 +|  14 Jul 2001: | Changed to plug & play |
    1.75 +|  16 Jun 2001: | Made tooltips optional; prevent ==Module::Sub== type of link |
    1.76 +|  12 Jun 2001: | Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional ==$page== in URL |
    1.77 +|  10 Jun 2001: | Changed rules topic to table-based syntax |
    1.78 +|  20 Feb 2001: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version |
    1.79 +|  CPAN Dependencies: | none |
    1.80 +|  Other Dependencies: | none |
    1.81 +|  Perl Version: | 5.0 |
    1.82 +|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle 100%, %TWIKIWEB%.FormattedSearch 98%, %TOPIC% 98% |
    1.83 +|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
    1.84 +|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
    1.85 +|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
    1.86 +
    1.87 +__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.InterWikis
    1.88 +
    1.89 +-- TWiki:Main.PeterThoeny - 25 Nov 2007