diff options
| -rw-r--r-- | TWiki/InterwikiPlugin.mdwn | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/TWiki/InterwikiPlugin.mdwn b/TWiki/InterwikiPlugin.mdwn index e5bd2f8d..35d967eb 100644 --- a/TWiki/InterwikiPlugin.mdwn +++ b/TWiki/InterwikiPlugin.mdwn @@ -1,18 +1,22 @@ -## <a name="_TOPIC_"> %TOPIC% </a> +# <a name="_TOPIC_"> %TOPIC% </a> -The %TOPIC% links <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the %TWIKIWEB%.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 %TWIKIWEB%.InterWikis topic. This plugin is inspired by UseMod Wiki's inter-wiki links, <http://www.usemod.com/cgi-bin/wiki.pl?InterWiki>. + +%TOC% ## <a name="Syntax_Rules"> Syntax Rules </a> -* 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 %TWIKIWEB%.InterWikis topic. -* To add new aliases just follows the instructions in %TWIKIWEB%.InterWikis. +* Add and edit aliases in %TWIKIWEB%.InterWikis. +* %H% For TWiki sites, both the **web** and the **topic** have to be specified: <code>**TWikisite:Webname/SomePage**</code> + * TWiki:Plugins/InterwikiPlugin ## <a name="_TOPIC_Settings"> %TOPIC% Settings </a> -Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code> +Plugin settings are stored as Preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%INTERWIKIPLUGIN\_SHORTDESCRIPTION%**</code> -* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: +* One-line description is shown in the %TWIKIWEB%.TextFormattingRules topic: * Set SHORTDESCRIPTION = Link <code>**ExternalSite:Page**</code> text to external sites based on aliases defined in the [[InterWikis]] topic. * Link rules topic name: (default is %TWIKIWEB%.InterWikis) @@ -24,12 +28,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"> Plugin Installation Instructions </a> +## <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a> -**_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="1" 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="1" cellspacing="0"> <tr> <th bgcolor="#99CCCC"><strong>File:</strong></th> <th bgcolor="#99CCCC"><strong>Description:</strong></th> @@ -47,9 +51,9 @@ 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"> Plugin Info </a> +## <a name="Plugin_Info"> Plugin Info </a> <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -62,7 +66,7 @@ Plugin settings are stored as preferences variables. To reference a plugin setti </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> 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 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> </tr> <tr> <td align="right"> CPAN Dependencies: </td> @@ -88,4 +92,4 @@ Plugin settings are stored as preferences variables. To reference a plugin setti **_Related Topics:_** %TWIKIWEB%.InterWikis, %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins --- %TWIKIWEB%.AndreaSterbini - 20 Oct 2000 <br /> -- %TWIKIWEB%.PeterThoeny - 27 Jul 2001 <br /> +-- %TWIKIWEB%.AndreaSterbini - 20 Oct 2000 <br /> -- %TWIKIWEB%.PeterThoeny - 27 Jul 2001 <br /> -- %TWIKIWEB%.MikeMannix - 01 Oct 2001 <br /> |