TWiki/InterwikiPlugin.mdwn

   1 # <a name="Interwiki Plugin"></a><a name=" Interwiki Plugin"></a> Interwiki Plugin
   2
   3 The %TOPIC% links <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic. This plugin is inspired by UseMod Wiki's inter-wiki links, <http://www.usemod.com/cgi-bin/wiki.pl?InterWiki>.
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Syntax Rules"> Syntax Rules</a></li>
   8     <li><a href="#%TOPIC% Settings"> %TOPIC% Settings</a></li>
   9     <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
  10     <li><a href="#Plugin Info"> Plugin Info</a></li>
  11   </ul>
  12 </div>
  13
  14 ## <a name="Syntax Rules"></a> Syntax Rules
  15
  16 - Enter <code>**ExternalSite:Page**</code> to create a link that points to the <code>**Page**</code> on the <code>**ExternalSite**</code> server.
  17 - All <code>**ExternalSite**</code> aliases are defined in the [[InterWikis]] topic.
  18 - Add and edit aliases in [[InterWikis]].
  19 - %H% For TWiki sites, both the **web** and the **topic** have to be specified: <code>**TWikisite:Webname/SomePage**</code>
  20   - TWiki:Plugins/InterwikiPlugin
  21
  22 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
  23
  24 Plugin settings are stored as Preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
  25
  26 - One-line description, shown in the [[TextFormattingRules]] topic:
  27   - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic.
  28
  29 - Link rules topic name: (default is [[InterWikis]])
  30   - Set RULESTOPIC =
  31
  32 - Suppress tooltip help for links: (<code>****</code> or <code>**1**</code>, default is <code>****</code>)
  33   - Set SUPPRESSTOOLTIP = 0
  34
  35 - Debug plugin: (See output in `data/debug.txt`)
  36   - Set DEBUG = 0
  37
  38 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
  39
  40 %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.
  41
  42 - **Download** the ZIP file from the TWiki:Plugins web (see below)
  43 - **Unzip** <code>**%TOPIC%.zip**</code> in your TWiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
  44   <tr>
  45     <th bgcolor="#99CCCC"><strong> File: </strong></th>
  46     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  47   </tr>
  48   <tr>
  49     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
  50     <td> Plugin topic </td>
  51   </tr>
  52   <tr>
  53     <td><code><b>data/TWiki/InterWikis.txt</b></code></td>
  54     <td> Link rules topic for inter-site links </td>
  55   </tr>
  56   <tr>
  57     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
  58     <td> Plugin Perl module </td>
  59   </tr>
  60 </table>
  61 - **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to <http://c2.com/cgi/wiki?InterWiki> topic - try it out.
  62
  63 ## <a name="Plugin Info"></a> Plugin Info
  64
  65 <table border="1" cellpadding="0" cellspacing="0">
  66   <tr>
  67     <td align="right"> Plugin Author: </td>
  68     <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
  69   </tr>
  70   <tr>
  71     <td align="right"> Plugin Version: </td>
  72     <td> 18 Jan 2003, 1.0.3 </td>
  73   </tr>
  74   <tr>
  75     <td align="right"> Change History: </td>
  76     <td>  </td>
  77   </tr>
  78   <tr>
  79     <td align="right"> 18 Jan 2003: </td>
  80     <td> Allow number sign <code>#</code> in Page name </td>
  81   </tr>
  82   <tr>
  83     <td align="right"> 31 Aug 2002: </td>
  84     <td> Allow percent sign <code>%</code> in page name </td>
  85   </tr>
  86   <tr>
  87     <td align="right"> 27 Jul 2001: </td>
  88     <td> Allow numbers <code>0-9</code> in site name </td>
  89   </tr>
  90   <tr>
  91     <td align="right"> 26 Jul 2001: </td>
  92     <td> Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) </td>
  93   </tr>
  94   <tr>
  95     <td align="right"> 14 Jul 2001: </td>
  96     <td> Changed to plug &amp; play </td>
  97   </tr>
  98   <tr>
  99     <td align="right"> 16 Jun 2001: </td>
 100     <td> Made tooltips optional; prevent <code><b>Module::Sub</b></code> type of link </td>
 101   </tr>
 102   <tr>
 103     <td align="right"> 12 Jun 2001: </td>
 104     <td> Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional <code><b>$page</b></code> in URL </td>
 105   </tr>
 106   <tr>
 107     <td align="right"> 10 Jun 2001: </td>
 108     <td> Changed rules topic to table-based syntax </td>
 109   </tr>
 110   <tr>
 111     <td align="right"> 20 Feb 2001: </td>
 112     <td> Initial version </td>
 113   </tr>
 114   <tr>
 115     <td align="right"> CPAN Dependencies: </td>
 116     <td> none </td>
 117   </tr>
 118   <tr>
 119     <td align="right"> Other Dependencies: </td>
 120     <td> none </td>
 121   </tr>
 122   <tr>
 123     <td align="right"> Perl Version: </td>
 124     <td> 5.0 </td>
 125   </tr>
 126   <tr>
 127     <td align="right"> Plugin Home: </td>
 128     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a> (TWiki:Plugins/%TOPIC%) </td>
 129   </tr>
 130   <tr>
 131     <td align="right"> Feedback: </td>
 132     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a> (TWiki:Plugins/%TOPIC%Dev) </td>
 133   </tr>
 134 </table>
 135
 136 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
 137
 138 -- [[AndreaSterbini]] - 20 Oct 2000 <br /> -- [[PeterThoeny]] - 18 Jan 2003 <br /> -- [[MikeMannix]] - 01 Oct 2001 <br />