%META:TOPICINFO{author="TWikiContributor" date="1288508366" format="1.1" version="$Rev$"}%
---+!! <nop>%TOPIC%
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/EmailObfuscationPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/EmailObfuscationPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
%SHORTDESCRIPTION%

---++ Introduction

This plugin replaces characters in email address with their appropriate HTML entity references. This is intended to help prevent email harvesters from recognizing addresses.

---++ Syntax Rules

   * N/A

---++ Examples

   * user@example.com (If you view source you should see that the string is encoded).

---++ 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>EMAILOBFUSCATIONPLUGIN_SHORTDESCRIPTION%==

   * Short description:
      * Set SHORTDESCRIPTION = Obfuscates e-mail addresses by characters to their HTML character entity references

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

   * Range of characters to encode (*NOTE:* Setting a bad range here can result in your TWiki not displaying content, please ensure that a correct range is used and that the Plugin topic is locked to %USERSWEB%.TWikiAdminGroup):
      * Set ESCAPELIST = \000-\056\072-\100\133-\140\173-\177

   * Restrict access: (remove the # to enable the access control)
      * #Set ALLOWTOPICCHANGE = %MAINWEB%.TWikiAdminGroup

---++ 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. 

   * Ensure you have the HTML::Entities module installed from CPAN.
   * Download the ZIP file from the Plugin web (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 |
   * Configure the Plugin:
      * Run the [[%SCRIPTURL{configure}%][configure]] script to enable the plugin
      * Change the plugin settings as needed. Enable the access control by removing the # from the Set ALLOWTOPICCHANGE

---++ Plugin Info

|  Plugin Author: | TWiki:Main.StephenGordon |
|  Copyright: | &copy; 2006, TWiki:Main.StephenGordon %BR% &copy; 2006-2010 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2010-10-30 (V1.001) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2010-10-30: | TWikibug:Item6530: Doc fixes |
|  2006-05-17: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | CPAN:HTML::Entities |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle 98%, %SYSTEMWEB%.FormattedSearch 99%, %TOPIC% 98% |
|  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
