Spell Checker Plugin

This plugin is underdevelopment, see SpellCheckerPluginDev for development discussions.

This plugin is based on WBOSS "Web Based Open Source Spell Checker" ( http://www.dontpokebadgers.com/spellchecker/ ) by Joshua Cantara (jcantara@grapponePLEASENOSPAM.com)

About the latest version

The version 0.1 of this plugin is the first prototype.

The WBOSS spell checker should function. It has not however been integrated with TWiki or packaged as a plugin. See more info in SpellCheckerPluginDev.

This version has not been thoroughly tested. It has not been checked on many browsers or server platforms. Users running a browser than handles JavaScript. IE5/6 or NS6 recommended.

Syntax Rules

• No new syntax rules are introduced

SpellCheckerPlugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Provides a spell check capability when editing a topic. (Prototype)

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

System requirements

• Requires either Aspell or Ispell.
• Source code has incorporated code from the Lignua::Ispell module.
• Uses IPC::Open3 to communicate with the spell check program.

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
  • Unzip SpellCheckerPlugin.zip in your twiki installation directory.
• Check that Open3 and either Ispell or Aspell is installed
• Edit settings in the spell.pl and the edit.spellcheck.tmpl as necessary
• Currently there is no need to enable this plugin in TWikiPreferences
• Check to see if the installation was successful
  1. Edit any topic
  2. Change the URL to use the spell check skin: twiki/bin/edit/Web/TopicName?skin=spellcheck
  3. Click the "spell check" button. A smaller browser window should open and spelling errors should have a drop down list.
  4. Add the spell check code to your installation's edit.tmpl file(s).

File content

Plugin Info

Plugin Author:	MikeBarton
Plugin Version:	0.1
Change History:	27 Mar 2002: Added initial version
CPAN Dependencies:	IPC::Open3
Other Dependencies:	Unix aspell or ispell
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SpellCheckerPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SpellCheckerPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

• SpellCheckerPlugin.zip: Ver 0.1 - prototype

-- MikeBarton - 27 Mar 2002