TWiki/InterwikiPlugin.mdwn

   1 ## <a name="%TOPIC%"></a> %TOPIC%
   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 ## <a name="Syntax Rules"></a> Syntax Rules
   6
   7 - Write <code>**ExternalSite:Page**</code> to create automatically a link that points to the <code>**Page**</code> on the <code>**ExternalSite**</code> server.
   8 - All <code>**ExternalSite**</code> aliases are defined in the [[InterWikis]] topic.
   9 - To add new aliases just follows the instructions in [[InterWikis]].
  10
  11 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
  12
  13 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
  14
  15 - One line description, is shown in the [[TextFormattingRules]] topic:
  16   - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic.
  17
  18 - Link rules topic name: (default is [[InterWikis]])
  19   - Set RULESTOPIC =
  20
  21 - Suppress tooltip help for links: (<code>****</code> or <code>**1**</code>, default is <code>****</code>)
  22   - Set SUPPRESSTOOLTIP = 0
  23
  24 - Debug plugin: (See output in `data/debug.txt`)
  25   - Set DEBUG = 0
  26
  27 ### <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
  28
  29 **_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.
  30
  31 - Download the ZIP file from the Plugin web (see below)
  32 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
  33   <tr>
  34     <th bgcolor="#99CCCC"><strong> File: </strong></th>
  35     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  36   </tr>
  37   <tr>
  38     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
  39     <td> Plugin topic </td>
  40   </tr>
  41   <tr>
  42     <td><code><b>data/TWiki/InterWikis.txt</b></code></td>
  43     <td> Link rules topic for inter-site links </td>
  44   </tr>
  45   <tr>
  46     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
  47     <td> Plugin Perl module </td>
  48   </tr>
  49 </table>
  50 - Test if the plugin is correctly installed: Wiki:InterWiki should point to Wiki's <http://c2.com/cgi/wiki?InterWiki> topic.
  51
  52 ### <a name="Plugin Info"></a> Plugin Info
  53
  54 <table border="1" cellpadding="0" cellspacing="0">
  55   <tr>
  56     <td align="right"> Plugin Author: </td>
  57     <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
  58   </tr>
  59   <tr>
  60     <td align="right"> Plugin Version: </td>
  61     <td> 1.0.2 </td>
  62   </tr>
  63   <tr>
  64     <td align="right"> Change History: </td>
  65     <td> 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 &amp; play <br /> 16 Jun 2001: Made tool tips optional; prevent <code><b>Module::Sub</b></code> 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 <code><b>$page</b></code> in URL <br /> 10 Jun 2001: Changed rules topic to table based syntax <br /> 20 Feb 2001: Initial version </td>
  66   </tr>
  67   <tr>
  68     <td align="right"> CPAN Dependencies: </td>
  69     <td> none </td>
  70   </tr>
  71   <tr>
  72     <td align="right"> Other Dependencies: </td>
  73     <td> none </td>
  74   </tr>
  75   <tr>
  76     <td align="right"> Perl Version: </td>
  77     <td> 5.0 </td>
  78   </tr>
  79   <tr>
  80     <td align="right"> Plugin Home: </td>
  81     <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>
  82   </tr>
  83   <tr>
  84     <td align="right"> Feedback: </td>
  85     <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>
  86   </tr>
  87 </table>
  88
  89 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
  90
  91 -- [[AndreaSterbini]] - 20 Oct 2000 <br /> -- [[PeterThoeny]] - 27 Jul 2001 <br />