1 # <a name="Interwiki Plugin"></a><a name=" Interwiki Plugin"></a> Interwiki Plugin
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="#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>
14 ## <a name="Syntax Rules"></a> Syntax Rules
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, or
21 - TWiki:Plugins.InterwikiPlugin
23 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
25 Plugin settings are stored as Preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, for example, <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code>
27 - One-line description, shown in the [[TextFormattingRules]] topic:
28 - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic.
30 - Link rules topic name: (default is [[InterWikis]])
33 - Suppress tooltip help for links: (<code>****</code> or <code>**1**</code>, default is <code>****</code>)
34 - Set SUPPRESSTOOLTIP = 0
36 - Debug plugin: (See output in `data/debug.txt`)
39 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
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.
43 - **Download** the ZIP file from the TWiki:Plugins web (see below)
44 - **Unzip** <code>**%TOPIC%.zip**</code> in your TWiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
46 <th bgcolor="#99CCCC"><strong> File: </strong></th>
47 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
50 <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
51 <td> Plugin topic </td>
54 <td><code><b>data/TWiki/InterWikis.txt</b></code></td>
55 <td> Link rules topic for inter-site links </td>
58 <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
59 <td> Plugin Perl module </td>
62 - **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to <http://c2.com/cgi/wiki?InterWiki> topic - try it out.
64 ## <a name="Plugin Info"></a> Plugin Info
66 <table border="1" cellpadding="0" cellspacing="0">
68 <td align="right"> Plugin Author: </td>
69 <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
72 <td align="right"> Plugin Version: </td>
73 <td> 18 Jan 2003, 1.0.3 </td>
76 <td align="right"> Change History: </td>
80 <td align="right"> 18 Jan 2003: </td>
81 <td> Allow number sign <code>#</code> in Page name </td>
84 <td align="right"> 31 Aug 2002: </td>
85 <td> Allow percent sign <code>%</code> in page name </td>
88 <td align="right"> 27 Jul 2001: </td>
89 <td> Allow numbers <code>0-9</code> in site name </td>
92 <td align="right"> 26 Jul 2001: </td>
93 <td> Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) </td>
96 <td align="right"> 14 Jul 2001: </td>
97 <td> Changed to plug & play </td>
100 <td align="right"> 16 Jun 2001: </td>
101 <td> Made tooltips optional; prevent <code><b>Module::Sub</b></code> type of link </td>
104 <td align="right"> 12 Jun 2001: </td>
105 <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>
108 <td align="right"> 10 Jun 2001: </td>
109 <td> Changed rules topic to table-based syntax </td>
112 <td align="right"> 20 Feb 2001: </td>
113 <td> Initial version </td>
116 <td align="right"> CPAN Dependencies: </td>
120 <td align="right"> Other Dependencies: </td>
124 <td align="right"> Perl Version: </td>
128 <td align="right"> Plugin Home: </td>
129 <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>
132 <td align="right"> Feedback: </td>
133 <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>
137 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
139 -- [[AndreaSterbini]] - 20 Oct 2000 <br /> -- [[PeterThoeny]] - 18 Jan 2003 <br /> -- [[MikeMannix]] - 01 Oct 2001 <br />