From 46109376c5c82201fe0bdd3dc69c6ba35397eee5 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Tue, 2 Oct 2001 06:35:17 +0000 Subject: none --- TWiki/InterwikiPlugin.mdwn | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) (limited to 'TWiki/InterwikiPlugin.mdwn') 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 @@ -## %TOPIC% +# %TOPIC% -The %TOPIC% links **ExternalSite:Page** text to external sites based on aliases defined in the %TWIKIWEB%.InterWikis topic. This plugin is inspired by UseMod Wiki's inter-wiki links, . +The %TOPIC% links **ExternalSite:Page** text to external sites based on aliases defined in the %TWIKIWEB%.InterWikis topic. This plugin is inspired by UseMod Wiki's inter-wiki links, . + +%TOC% ## Syntax Rules -* Write **ExternalSite:Page** to create automatically a link that points to the **Page** on the **ExternalSite** server. +* Enter **ExternalSite:Page** to create a link that points to the **Page** on the **ExternalSite** server. * All **ExternalSite** 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: **TWikisite:Webname/SomePage** + * TWiki:Plugins/InterwikiPlugin ## %TOPIC% Settings -Plugin settings are stored as preferences variables. To reference a plugin setting write **%<plugin>\_<setting>%**, i.e. **%INTERWIKIPLUGIN\_SHORTDESCRIPTION%** +Plugin settings are stored as Preferences variables. To reference a plugin setting write **%<plugin>\_<setting>%**, i.e. **%INTERWIKIPLUGIN\_SHORTDESCRIPTION%** -* One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: +* One-line description is shown in the %TWIKIWEB%.TextFormattingRules topic: * Set SHORTDESCRIPTION = Link **ExternalSite:Page** 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 -### Plugin Installation Instructions +## 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 **%TOPIC%.zip** in your twiki installation directory. Content: +* **Download** the ZIP file from the TWiki:Plugins web (see below) +* **Unzip** **%TOPIC%.zip** in your TWiki installation directory. Content:
@@ -47,9 +51,9 @@ Plugin settings are stored as preferences variables. To reference a plugin setti
File: Description: Plugin Perl module
-* Test if the plugin is correctly installed: Wiki:InterWiki should point to Wiki's topic. +* **Test:** If the Plugin is correctly installed, this Wiki:InterWiki link should point to topic - try it out. -### Plugin Info +## Plugin Info @@ -62,7 +66,7 @@ Plugin settings are stored as preferences variables. To reference a plugin setti - + @@ -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
-- %TWIKIWEB%.PeterThoeny - 27 Jul 2001
+-- %TWIKIWEB%.AndreaSterbini - 20 Oct 2000
-- %TWIKIWEB%.PeterThoeny - 27 Jul 2001
-- %TWIKIWEB%.MikeMannix - 01 Oct 2001
-- cgit v1.2.3
Change History: 27 Jul 2001 Allow numbers in site name
26 Jul 2001 Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin)
14 Jul 2001 Changed to plug &amp; play
16 Jun 2001: Made tool tips optional; prevent Module::Sub type of link
12 Jun 2001: Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional $page in URL
10 Jun 2001: Changed rules topic to table based syntax
20 Feb 2001: Initial version 		27 Jul 2001 Allow numbers in site name
26 Jul 2001 Fixed alternating missed link bug due to greedy $postfixPattern (fix by Richard Donkin)
14 Jul 2001 Changed to plug &amp; play
16 Jun 2001: Made tooltips optional; prevent Module::Sub type of link
12 Jun 2001: Added optional tool tips (IE only); added the link rules topic name variable; added flexible link patterns; optional $page in URL
10 Jun 2001: Changed rules topic to table-based syntax
20 Feb 2001: Initial version
CPAN Dependencies: