StopWikiWordLinkPlugin

Prevents automatic linking of selected WikiWords

Introduction

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 = RedHat, VxWorks, DAQ

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.

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.

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the Plugins home (see below).
    • Unzip StopWikiWordLinkPlugin.zip in your twiki installation directory. Content:
      File: Description:
      data/TWiki/StopWikiWordLinkPlugin.txt Plugin topic
      lib/TWiki/Plugins/StopWikiWordLinkPlugin.pm Plugin Perl module
    • Set the ownership of the extracted directories and files to the webserver user.
    • Make sure the dependencies listed in the table below are resolved. None

  • Plugin configuration and testing:
    • Run the configure script, enable the plugin in the Plugins section
    • Add a STOPWIKIWORDLINK setting to the Main.TWikiPreferences topic, listing all WikiWords to exclude from auto-linking. Example:
      • Set STOPWIKIWORDLINK = RedHat, VxWorks
    • Test if the installation was successful. The following words should not be linked when above example is used:
      • RedHat, VxWorks

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

Plugin Author: TWiki:Main.PeterThoeny
Copyright: © 2006-2012 Peter Thoeny, TWiki.org,
© 2006-2012 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2012-09-08
Change History:  
2012-09-08: TWikibug:Item6837: Doc enhancements
2011-07-10: TWikibug:Item6725: Change global package variables from "use vars" to "our"
2010-11-09: Doc improvements
2006-08-10: Fixed issue where WikiWord at the beginning of line was still linked
2006-08-09: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle 100%, FormattedSearch 100%, StopWikiWordLinkPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/StopWikiWordLinkPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/StopWikiWordLinkPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/StopWikiWordLinkPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r3 - 2018-11-12 - PeterJones
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    TWiki All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.StopWikiWordLinkPlugin