AbusePlugin

Introduction

This plugin obscures a list of abuse words in TWiki pages. Occurrences of these words are replaced in topic view mode by asterisks (*) except for the first character.

Examples

The following bullet contains banned words:

• Buy cheap Cialis and Viagra

Expected output:

• Buy cheap C***** and V*****

Plugin Settings

Overload plugin settings in Main.TWikiPreferences by prefixing the name of the setting with ABUSEPLUGIN_, such as ABUSEPLUGIN_ABUSEWORDS

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Obscure dirty words in TWiki topics

• Banned words list:
  • Set ABUSEWORDS = cialis, fuck, fucked, fucking, viagra

• Debug flag, see output in twiki/data/debug.txt:
  • Set DEBUG = 0

Plugin Installation & Configuration

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 AbusePlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/AbusePlugin.txt	Plugin topic
    lib/TWiki/Plugins/AbusePlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful: See example above.

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences