Tags:
create new tag
, view all tags

SynonymPlugin

set synonyms for a topic name, so that all of them link to one topic

This plugin allows the user to define a list of Synonyms for a topic name, Virtally creating a TWikiTopic for each Synonym that then links to that one topic. This should be more effective than attempting to add plural endings to a Topic name, and provide true linking for non-trivial plurals, slang, TLA's, and even actross multiple languages.

(not released yet, this is an idea given to me by 'allie' on irc today)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = set synonyms for a topic name, so that all of them link to one topic

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • My own setting:
    • Set HOWTO = got it!

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

  • Download the ZIP file from the Plugin Home (see below)
  • Unzip SynonymPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/SynonymPlugin.txt Plugin topic
    data/TWiki/SynonymPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/SynonymPlugin.pm Plugin Perl module
  • Configure the Plugin:
    • TWiki 4.0 and up: Run the configure script to enable the Plugin
    • Change the Plugin settings as needed
  • Test if the installation was successful:
    • enter samples here

Plugin Info

Plugin Author: TWiki:Main.SvenDowideit
Copyright: © 2007, TWiki:Main.SvenDowideit
License: GPL (GNU General Public License)
Plugin Version: 30 Nov 2007 (V1.000)
Change History:  
30 Nov 2007: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle nn%, FormattedSearch nn%, SynonymPlugin nn%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/SynonymPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/SynonymPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/SynonymPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.SvenDowideit - 30 Nov 2007

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 2007-12-02 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.