diff options
Diffstat (limited to 'TWiki/FindElsewherePlugin.mdwn')
-rw-r--r-- | TWiki/FindElsewherePlugin.mdwn | 32 |
1 files changed, 25 insertions, 7 deletions
diff --git a/TWiki/FindElsewherePlugin.mdwn b/TWiki/FindElsewherePlugin.mdwn index 832606d4..16dee620 100644 --- a/TWiki/FindElsewherePlugin.mdwn +++ b/TWiki/FindElsewherePlugin.mdwn @@ -14,7 +14,7 @@ Without this kind of plugin, it's likely that common terms used within an organi (none) -New Functionality +<a name="NewFunctionalityTest"></a> New Functionality <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -94,25 +94,43 @@ Don't break other types of wiki words ### <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>**%EMPTYPLUGIN\_SHORTDESCRIPTION%**</code> - * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: * Set SHORTDESCRIPTION = If a topic isn't found in this web it will look in a predefined list of other webs and attempt to find it there. * List other webs in which to look for topics that don't exist * Set LOOKELSEWHERE = TWiki, Test -* If the [[TWiki/WikiWord]] is plural but doesn't exist, also look for the singular word +* If the [[TWiki/WikiWord]] is plural but doesn't exist, also look for the singular word. Note this setting is for looking in **other** webs only (plural to singular is still automatically done in the current web). * Set PLURALTOSINGULAR = 1 * Debug plugin: (See output in `data/debug.txt`) - * Set DEBUG = 1 + * Set DEBUG = 0 ### <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a> -### <a name="Plugin_Deficiencies"> Plugin Deficiencies </a> +* 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"> + <tr> + <th bgcolor="#99CCCC"><strong>File:</strong></th> + <th bgcolor="#99CCCC"><strong>Description:</strong></th> + </tr> + <tr> + <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td> + <td> Plugin topic </td> + </tr> + <tr> + <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td> + <td> Plugin topic repository </td> + </tr> + <tr> + <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td> + <td> Plugin Perl module </td> + </tr> +</table> -1. Does not function in preview? +* Test if the plugin is correctly installed, by viewing %TOPIC%#NewFunctionalityTest ### <a name="Plugin_Info"> Plugin Info </a> |