1 # <a name="%TOPIC%"></a> %TOPIC%
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>.
7 <li><a href="#%TOPIC%">%TOPIC%</a><ul>
8 <li><a href="#Syntax Rules"> Syntax Rules</a></li>
9 <li><a href="#%TOPIC% Settings"> %TOPIC% Settings</a></li>
10 <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
11 <li><a href="#Plugin Info"> Plugin Info</a></li>
17 ## <a name="Syntax Rules"></a> Syntax Rules
19 - Enter <code>**ExternalSite:Page**</code> to create a link that points to the <code>**Page**</code> on the <code>**ExternalSite**</code> server.
20 - All <code>**ExternalSite**</code> aliases are defined in the [[InterWikis]] topic.
21 - Add and edit aliases in [[InterWikis]].
22 - %H% For TWiki sites, both the **web** and the **topic** have to be specified: <code>**TWikisite:Webname/SomePage**</code>
23 - TWiki:Plugins/InterwikiPlugin
25 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
27 Plugin settings are stored as Preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
29 - One-line description, shown in the [[TextFormattingRules]] topic:
30 - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic.
32 - Link rules topic name: (default is [[InterWikis]])
35 - Suppress tooltip help for links: (<code>****</code> or <code>**1**</code>, default is <code>****</code>)
36 - Set SUPPRESSTOOLTIP = 0
38 - Debug plugin: (See output in `data/debug.txt`)
41 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
43 %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.
45 - **Download** the ZIP file from the TWiki:Plugins web (see below)
46 - **Unzip** <code>**%TOPIC%.zip**</code> in your TWiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
48 <th bgcolor="#99CCCC"><strong> File: </strong></th>
49 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
52 <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
53 <td> Plugin topic </td>
56 <td><code><b>data/TWiki/InterWikis.txt</b></code></td>
57 <td> Link rules topic for inter-site links </td>
60 <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
61 <td> Plugin Perl module </td>
64 - **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to <http://c2.com/cgi/wiki?InterWiki> topic - try it out.
66 ## <a name="Plugin Info"></a> Plugin Info
68 <table border="1" cellpadding="0" cellspacing="0">
70 <td align="right"> Plugin Author: </td>
71 <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
74 <td align="right"> Plugin Version: </td>
78 <td align="right"> Change History: </td>
79 <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 & play <br /> 16 Jun 2001: Made tooltips 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>
82 <td align="right"> CPAN Dependencies: </td>
86 <td align="right"> Other Dependencies: </td>
90 <td align="right"> Perl Version: </td>
94 <td align="right"> Plugin Home: </td>
95 <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>
98 <td align="right"> Feedback: </td>
99 <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>
103 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
105 -- [[AndreaSterbini]] - 20 Oct 2000 <br /> -- [[PeterThoeny]] - 27 Jul 2001 <br /> -- [[MikeMannix]] - 01 Oct 2001 <br />