GoogieSpell TWiki Plugin

This plugin uses Amir's Googie Spell (http://orangoo.com/labs/GoogieSpell/Download/) to provide spell checking functionality when editing content with TWiki.

Syntax Rules

(none)

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Spell checking plugin.

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

Plugin Installation Instructions

• To install GoogieSpellPlugin:
  • Unzip the archive in your twiki folder.
  • Set permissions on the new files as appropriate for your installation.
  • Make the following changes to the edit template for your skin of choice:
    • Add the following to the definition for 'templatejavascript':

      • <script type="text/javascript" src="%PUBURLPATH%/%TWIKIWEB%/GoogieSpellPlugin/AJS.js"></script>
        <script type="text/javascript" src="%PUBURLPATH%/%TWIKIWEB%/GoogieSpellPlugin/googiespell.js"></script>
        <style type="text/css" media="all">
                @import url("%PUBURLPATH%/%TWIKIWEB%/GoogieSpellPlugin/googiespell.css");
        </style>

    • Add the following to the bottom of the definition for textarea:

      • <script type="text/javascript">
          var googie1 = new GoogieSpell("%PUBURLPATH%/%TWIKIWEB%/GoogieSpellPlugin/", " %SCRIPTURL{"spell"}%?lang=");
          googie1.decorateTextarea("topic");
        </script>

Plugin Info

Plugin Author:	TWiki:Main.StephenGordon
Copyright:	© 2006, TWiki:Main.StephenGordon
License:	GPL (GNU General Public License)
Plugin Version:	09 Nov 2006
Change History:
09 Nov 2006:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	LWP::UserAgent, HTTP::Request::Common
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/GoogieSpellPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/GoogieSpellPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/GoogieSpellPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.StephenGordon - 09 Nov 2006