From ad772cdfc0275039f64edf1cd07111798a10c472 Mon Sep 17 00:00:00 2001 From: MikeBarton Date: Tue, 29 Jan 2002 19:37:00 +0000 Subject: none --- TWiki/FindElsewherePlugin.mdwn | 98 ++++++++++++++++++++---------------------- 1 file changed, 46 insertions(+), 52 deletions(-) (limited to 'TWiki/FindElsewherePlugin.mdwn') diff --git a/TWiki/FindElsewherePlugin.mdwn b/TWiki/FindElsewherePlugin.mdwn index bafa6134..832606d4 100644 --- a/TWiki/FindElsewherePlugin.mdwn +++ b/TWiki/FindElsewherePlugin.mdwn @@ -1,18 +1,20 @@ -## Empty TWiki Plugin +## Find Elsewhere Plugin -This is an empty plugin you can use as a template to build your own %TWIKIWEB%.TWikiPlugins. This plugin does nothing, but is ready to be used. +This plugin will automatically link to another web(s) if a topic isn't found in the current web. -To create your own plugin: +This is useful for a TWiki site that wants to implement a glossar/dictionary web where common terms are defined and stored. Without this plugin: -* Copy file **TWiki/Plugins/EmptyPlugin.pm** to **<name>Plugin.pm** and customize the plugin. -* Create a **<name>Plugin** topic in the %TWIKIWEB% web. Do so by visiting and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs. -* See details in %TWIKIWEB%.TWikiPlugins. +* Each web would need to create their own topic for a common term +* Link to or INCLUDE the topic from where it is defined +* Authors need to remember to put the Web name in front of the topic name, such as [[TWiki/WikiWord]] + +Without this kind of plugin, it's likely that common terms used within an organization will be defined in multiple webs or the common terms will be unlinked wiki words (as if they didn't exist). ### Syntax Rules (none) -## Test of the new functionality +New Functionality @@ -23,37 +25,31 @@ To create your own plugin: - - - - - - - - - - - - - - - + + + - - - + + + - + + + + + + +
found TestTopic1 Test Topic 1?TestTopic1
found singular SingularTopics Singular Topics?SingularTopic
found other web CodingStandard Coding Standard?Digi.CodingStandard WebHome Web Home?WebHome
found singular CodingStandards Coding Standards?Digi.CodingStandards WebHomes Web Homes?WebHomes
found singular found elsewhere WikiWord Wiki Word? TWiki.WikiWord
found singular elsewhere WikiWords Wiki Words?TWiki.WikiWords
-## Don't break other types of wiki words +Don't break other types of wiki words @@ -61,36 +57,36 @@ To create your own plugin: - - + + - - + + - - + + - - + + - - + + - - + + - - + +
output
TestFindElsewhere#TopicAnchor Test Find Elsewhere#Topic Anchor?%TOPIC%#TopicAnchor %TOPIC%#TopicAnchor
Test.WebHome Web Home?TWiki.WebHome Web Home?
WebHome Web Home?
[[Test.WebHome]] Test.Web Home? [[TWiki.WebHome]] TWiki.Web Home?
[[Digi.CodingStandard]] Digi.Coding Standard? [[TWiki.WikiWord]] TWiki.Wiki Word?
[[Digi.CodingStandards]] Digi.Coding Standards? [[TWiki.WikiWords]] TWiki.Wiki Words?
Digi.CodingStandard Coding Standard?TWiki.WikiWord Wiki Word?
Digi.CodingStandards Coding Standards?TWiki.WikiWords Wiki Words?
@@ -101,14 +97,10 @@ To create your own plugin: Plugin settings are stored as preferences variables. To reference a plugin setting write **%<plugin>\_<setting>%**, i.e. **%EMPTYPLUGIN\_SHORTDESCRIPTION%** * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: - * Set SHORTDESCRIPTION = This plugin does nothing, but can be used as a template for your own plugins. - -* Your own setting, i.e.: - * Set EXAMPLE = Digi + * 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 LOOKHERE = Digi - * Set LOOKHEREMULTI = Digi, TWiki + * Set LOOKELSEWHERE = TWiki, Test * If the [[TWiki/WikiWord]] is plural but doesn't exist, also look for the singular word * Set PLURALTOSINGULAR = 1 @@ -118,22 +110,24 @@ Plugin settings are stored as preferences variables. To reference a plugin setti ### Plugin Installation Instructions -* This plugin is preinstalled, you do not need to install it. +### Plugin Deficiencies + +1. Does not function in preview? ### Plugin Info - + - + - + @@ -159,4 +153,4 @@ Plugin settings are stored as preferences variables. To reference a plugin setti **_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, [[DefaultPlugin]] --- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001
-- %TWIKIWEB%.PeterThoeny - 14 Jul 2001
+-- [[Main/MikeBarton]] - 1 Feb 2002
-- cgit v1.2.3
Plugin Author: %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny Mike Barton?
Plugin Version: 14 Jul 2001 1 Feb 2002
Change History: 14 Jul 2001: Changed to plug&amp;play
27 Feb 2001: Initial version 		1 Feb 2002: Initial version
CPAN Dependencies: