none
[openafs-wiki.git] / TWiki / InterwikiPlugin.mdwn
index 816215e..5f04a75 100644 (file)
@@ -1,19 +1,30 @@
-## <a name="%TOPIC%"></a> %TOPIC%
+# <a name="Interwiki Plugin"></a><a name=" Interwiki Plugin"></a> Interwiki Plugin
 
-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> .
+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>.
+
+<div>
+  <ul>
+    <li><a href="#Syntax Rules"> Syntax Rules</a></li>
+    <li><a href="#%TOPIC% Settings"> %TOPIC% Settings</a></li>
+    <li><a href="#Plugin Installation Instructions"> Plugin Installation Instructions</a></li>
+    <li><a href="#Plugin Info"> Plugin Info</a></li>
+  </ul>
+</div>
 
 ## <a name="Syntax Rules"></a> Syntax Rules
 
-- Write <code>**ExternalSite:Page**</code> to create automatically a link that points to the <code>**Page**</code> on the <code>**ExternalSite**</code> server.
+- Enter <code>**ExternalSite:Page**</code> to create a link that points to the <code>**Page**</code> on the <code>**ExternalSite**</code> server.
 - All <code>**ExternalSite**</code> aliases are defined in the [[InterWikis]] topic.
-- To add new aliases just follows the instructions in [[InterWikis]].
+- Add and edit aliases in [[InterWikis]].
+- %H% For TWiki sites, both the **web** and the **topic** have to be specified: <code>**TWikisite:Webname/SomePage**</code>
+  - TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin
 
 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
 
-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>
+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>
 
-- One line description, is shown in the [[TextFormattingRules]] topic:
-  - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic.
+- One-line description, shown in the [[TextFormattingRules]] topic:
+  - Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the %WEB%.InterWikis topic
 
 - Link rules topic name: (default is [[InterWikis]])
   - Set RULESTOPIC =
@@ -24,12 +35,12 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
 - Debug plugin: (See output in `data/debug.txt`)
   - Set DEBUG = 0
 
-### <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
+## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
 
-**_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.
+%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.
 
-- Download the ZIP file from the Plugin web (see below)
-- Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
+- **Download** the ZIP file from the TWiki:Plugins web (see below)
+- **Unzip** <code>**%TOPIC%.zip**</code> in your TWiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <th bgcolor="#99CCCC"><strong> File: </strong></th>
     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
@@ -47,22 +58,66 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
     <td> Plugin Perl module </td>
   </tr>
 </table>
-- Test if the plugin is correctly installed: Wiki:InterWiki should point to Wiki's <http://c2.com/cgi/wiki?InterWiki> topic.
+- **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to <http://c2.com/cgi/wiki?InterWiki> topic - try it out.
 
-### <a name="Plugin Info"></a> Plugin Info
+## <a name="Plugin Info"></a> Plugin Info
 
 <table border="1" cellpadding="0" cellspacing="0">
   <tr>
     <td align="right"> Plugin Author: </td>
-    <td>[[TWiki/AndreaSterbini]], [[TWiki/PeterThoeny]]</td>
+    <td> TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny </td>
   </tr>
   <tr>
     <td align="right"> Plugin Version: </td>
-    <td> 1.0.2 </td>
+    <td> 09 Mar 2004, 1.005 </td>
   </tr>
   <tr>
     <td align="right"> Change History: </td>
-    <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>
+    <td>  </td>
+  </tr>
+  <tr>
+    <td align="right"> 09 Mar 2004: </td>
+    <td> Internal changes: Use only official TWiki::Func Plugin API; for increased speed, moved Interwiki link handling from outsidePREHandler to startRenderingHandler </td>
+  </tr>
+  <tr>
+    <td align="right"> 16 Feb 2004: </td>
+    <td> Support <code>[[Site:Page][label]]</code> Interwiki links (PTh); use TWiki::Func interface for [[Main/I18N]] regular expressions (Walter Mundt) </td>
+  </tr>
+  <tr>
+    <td align="right"> 18 Jan 2003: </td>
+    <td> Allow number sign <code>#</code> in Page name (PTh) </td>
+  </tr>
+  <tr>
+    <td align="right"> 31 Aug 2002: </td>
+    <td> Allow percent sign <code>%</code> in page name (PTh) </td>
+  </tr>
+  <tr>
+    <td align="right"> 27 Jul 2001: </td>
+    <td> Allow numbers <code>0-9</code> in site name </td>
+  </tr>
+  <tr>
+    <td align="right"> 26 Jul 2001: </td>
+    <td> Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin) </td>
+  </tr>
+  <tr>
+    <td align="right"> 14 Jul 2001: </td>
+    <td> Changed to plug &amp; play </td>
+  </tr>
+  <tr>
+    <td align="right"> 16 Jun 2001: </td>
+    <td> Made tooltips optional; prevent <code><b>Module::Sub</b></code> type of link </td>
+  </tr>
+  <tr>
+    <td align="right"> 12 Jun 2001: </td>
+    <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>
+  </tr>
+  <tr>
+    <td align="right"> 10 Jun 2001: </td>
+    <td> Changed rules topic to table-based syntax </td>
+  </tr>
+  <tr>
+    <td align="right"> 20 Feb 2001: </td>
+    <td> Initial version </td>
   </tr>
   <tr>
     <td align="right"> CPAN Dependencies: </td>
@@ -88,4 +143,4 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
 
 **_Related Topics:_** [[InterWikis]], [[TWikiPreferences]], [[TWikiPlugins]]
 
--- [[AndreaSterbini]] - 20 Oct 2000 <br /> -- [[PeterThoeny]] - 27 Jul 2001 <br />
+-- TWiki:Main.AndreaSterbini - 20 Oct 2000 <br /> -- TWiki:Main.PeterThoeny - 09 Mar 2004 <br /> -- TWiki:Main.MikeMannix - 01 Oct 2001 <br />