StopWikiWordLinkPlugin

This Plugin prevents automatic linking of selected WikiWords such as LinuxWorld or MacDonald.

Usage

WikiWords that should not be automatically linked are listed in a STOPWIKIWORDLINK preferences setting or Plugin setting. This is typically done in the Main.TWikiPreferences, but can be done also in any web (in WebPreferences), or in a single topic. See sample entry in the Plugin settings.

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Prevents automatic linking of selected WikiWords

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

• List of WikiWords excluded from auto-linking:
  • Set STOPWIKIWORDLINK = LinuxWorld, MacDonald

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 web (see below)
• Unzip StopWikiWordLinkPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/StopWikiWordLinkPlugin.txt	Plugin topic
  data/TWiki/StopWikiWordLinkPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/StopWikiWordLinkPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Add a STOPWIKIWORDLINK setting to the Main.TWikiPreferences topic, listing all WikiWords to exclude from auto-linking. Example:
    • Set STOPWIKIWORDLINK = LinuxWorld, MacDonald
• Test if the installation was successful. The following words should not be linked when above example is used:
  • LinuxWorld? , MacDonald?

Limitations

• This Plugin is not internationalized, that is at this time only A-Z, a-z, and 0-9 are supported for WikiWords

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.PeterThoeny - 10 Aug 2006