StopWikiWordLinkPlugin < TWiki

Tags: , view all tags
---+!! <nop>%TOPIC%
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/ImgPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/ImgPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

This Plugin prevents automatic linking of selected [[%SYSTEMWEB%.WikiWord][WikiWords]] such as <nop>LinuxWorld or <nop>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 [[%LOCALSITEPREFS%]], but can be done also in any web (in %WEBPREFSTOPIC%), 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 ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>STOPWIKIWORDLINKPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Prevents automatic linking of selected <nop>WikiWords

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

<noautolink>
   * List of WikiWords excluded from auto-linking:
      * Set STOPWIKIWORDLINK = RedHat, VxWorks
</noautolink>

---++ 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 [[%SCRIPTURL{configure}%][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 ==%TOPIC%.zip== in your twiki installation directory. Content:
        | *File:* | *Description:* |
        | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
        | ==lib/TWiki/Plugins/%TOPIC%.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 [[%SCRIPTURL{configure}%][configure]] script, enable the plugin in the __Plugins__ section
      * Add a STOPWIKIWORDLINK setting to the [[%LOCALSITEPREFS%]] topic, listing all !WikiWords to exclude from auto-linking. Example:
         * =Set STOPWIKIWORDLINK = <nop>RedHat, <nop>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: | &copy; 2006-2012 Peter Thoeny, [[http://twiki.org/][TWiki.org]], <br /> &copy; 2006-2012 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2012-09-08 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  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 |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle 100%, %SYSTEMWEB%.FormattedSearch 100%, %TOPIC% 99% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
Topic revision: r0 - 2012-09-09 - TWikiContributor
Account
- Log In
Edit
Attach
Copyright © 1999-2025 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.
antalya escort bursa escort eskisehir escort istanbul escort izmir escort