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 - Enter <code>**\[[ExternalSite:Page]\[any label]]**</code> to specify a custom label.
  18 - All <code>**ExternalSite**</code> aliases are defined in the [[InterWikis]] topic.
  19 - Add and edit aliases in [[InterWikis]].
  20 - Each entry must be of format: <br /><code>**| External site alias | URL | Tooltip help text |**</code>.
  21 - Site aliases must start with an upper case letter and may contain alphanumeric letters.
  22 - The URL and Tooltip Text may contain optional <code>**$page**</code> variables; the variable gets expanded to the page name.
  23 - %H% For TWiki sites, both the **web** and the **topic** have to be specified: <code>**TWikisite:Webname/SomePage**</code>
  24   - TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin
  25
  26 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
  27
  28 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>
  29
  30 - One-line description, shown in the [[TextFormattingRules]] topic:
  31   - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in a rules topic
  32
  33 - Link rules topic name: (default is [[InterWikis]])
  34   - Set RULESTOPIC =
  35
  36 - Inter-link format, with variables: <table border="1" cellpadding="0" cellspacing="0">
  37   <tr>
  38     <td> $site </td>
  39     <td> Site alias </td>
  40   </tr>
  41   <tr>
  42     <td> $page </td>
  43     <td> Page (part after colon) </td>
  44   </tr>
  45   <tr>
  46     <td> $url </td>
  47     <td> Site URL (might contain $page) </td>
  48   </tr>
  49   <tr>
  50     <td> $label </td>
  51     <td> Equal to $site:$page </td>
  52   </tr>
  53   <tr>
  54     <td> $tooltip </td>
  55     <td> Tooltip message </td>
  56   </tr>
  57 </table>
  58   - Set INTERLINKFORMAT = [$label]($url $tooltip)
  59
  60 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
  61
  62 %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.
  63
  64 - **Download** the ZIP file from the TWiki:Plugins web (see below)
  65 - **Unzip** <code>**%TOPIC%.zip**</code> in your TWiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
  66   <tr>
  67     <th bgcolor="#99CCCC"><strong> File: </strong></th>
  68     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  69   </tr>
  70   <tr>
  71     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
  72     <td> Plugin topic </td>
  73   </tr>
  74   <tr>
  75     <td><code><b>data/TWiki/InterWikis.txt</b></code></td>
  76     <td> Link rules topic for inter-site links </td>
  77   </tr>
  78   <tr>
  79     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
  80     <td> Plugin Perl module </td>
  81   </tr>
  82 </table>
  83 - **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to <http://c2.com/cgi/wiki?InterWiki> topic - try it out.
  84
  85 ## <a name="Plugin Info"></a> Plugin Info
  86
  87 <table border="1" cellpadding="0" cellspacing="0">
  88   <tr>
  89     <td align="right"> Plugin Author: </td>
  90     <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny </td>
  91   </tr>
  92   <tr>
  93     <td align="right"> Copyright: </td>
  94     <td> © 2006, TWiki:Main.AndreaSterbini, <a href="http://www.structuredwikis.com/" target="_top">Peter Thoeny</a></td>
  95   </tr>
  96   <tr>
  97     <td align="right"> License: </td>
  98     <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
  99   </tr>
 100   <tr>
 101     <td align="right"> Plugin Version: </td>
 102     <td> 11935 </td>
 103   </tr>
 104   <tr>
 105     <td align="right"> Change History: </td>
 106     <td>  </td>
 107   </tr>
 108   <tr>
 109     <td align="right"> 08 Nov 2006: </td>
 110     <td> 11935 - Added css <code></code> (TWiki:Main.PeterThoeny) </td>
 111   </tr>
 112   <tr>
 113     <td align="right"> 07 Nov 2006: </td>
 114     <td> 11924 - Added INTERLINKFORMAT; removed redundant SUPPRESSTOOLTIP; allow @ signs in page part of interwiki link; support single digit page part (TWiki:Main.PeterThoeny) </td>
 115   </tr>
 116   <tr>
 117     <td align="right"> 26 Feb 2005: </td>
 118     <td> 1.008 TWiki:Main.CrawfordCurrie cleaned up code and made Dakar-ready </td>
 119   </tr>
 120   <tr>
 121     <td align="right"> 25 Aug 2004: </td>
 122     <td> 1.005 TWiki:Main.PeterThoeny updated [[Main/InterWikis]] link rules (no code change) </td>
 123   </tr>
 124   <tr>
 125     <td align="right"> 09 Mar 2004: </td>
 126     <td> Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler </td>
 127   </tr>
 128   <tr>
 129     <td align="right"> 16 Feb 2004: </td>
 130     <td> Support <code>[[Site:Page][label]]</code> Interwiki links (PTh); use TWiki::Func interface for I18N regular expressions (Walter Mundt) </td>
 131   </tr>
 132   <tr>
 133     <td align="right"> 18 Jan 2003: </td>
 134     <td> Allow number sign <code>#</code> in Page name (PTh) </td>
 135   </tr>
 136   <tr>
 137     <td align="right"> 31 Aug 2002: </td>
 138     <td> Allow percent sign <code>%</code> in page name (PTh) </td>
 139   </tr>
 140   <tr>
 141     <td align="right"> 27 Jul 2001: </td>
 142     <td> Allow numbers <code>0-9</code> in site name </td>
 143   </tr>
 144   <tr>
 145     <td align="right"> 26 Jul 2001: </td>
 146     <td> Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) </td>
 147   </tr>
 148   <tr>
 149     <td align="right"> 14 Jul 2001: </td>
 150     <td> Changed to plug &amp; play </td>
 151   </tr>
 152   <tr>
 153     <td align="right"> 16 Jun 2001: </td>
 154     <td> Made tooltips optional; prevent <code><b>Module::Sub</b></code> type of link </td>
 155   </tr>
 156   <tr>
 157     <td align="right"> 12 Jun 2001: </td>
 158     <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>
 159   </tr>
 160   <tr>
 161     <td align="right"> 10 Jun 2001: </td>
 162     <td> Changed rules topic to table-based syntax </td>
 163   </tr>
 164   <tr>
 165     <td align="right"> 20 Feb 2001: </td>
 166     <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny - Initial version </td>
 167   </tr>
 168   <tr>
 169     <td align="right"> CPAN Dependencies: </td>
 170     <td> none </td>
 171   </tr>
 172   <tr>
 173     <td align="right"> Other Dependencies: </td>
 174     <td> none </td>
 175   </tr>
 176   <tr>
 177     <td align="right"> Perl Version: </td>
 178     <td> 5.0 </td>
 179   </tr>
 180   <tr>
 181     <td align="right">[[TWiki:Plugins/Benchmark]]: </td>
 182     <td>[[TWiki/GoodStyle]] 100%, [[TWiki/FormattedSearch]] 98%, %TOPIC% 98% </td>
 183   </tr>
 184   <tr>
 185     <td align="right"> Plugin Home: </td>
 186     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
 187   </tr>
 188   <tr>
 189     <td align="right"> Feedback: </td>
 190     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
 191   </tr>
 192   <tr>
 193     <td align="right"> Appraisal: </td>
 194     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
 195   </tr>
 196 </table>
 197
 198 **_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]], [[InterWikis]]
 199
 200 -- TWiki:Main.PeterThoeny - 08 Nov 2006