After the Deadline for CKEditor - README

After the Deadline is an open source software service that checks spelling, style, and grammar. This package contains an AtD CKEditor Plugin and instructions on how to use AtD with CKEditor.

Installation

1. Extract this archive into your ckeditor/plugins directory.
2. You'll need an API key from www.afterthedeadline.com. Registering is quick and painless (email address and password).
3. Modify contents.css in your ckeditor/ directory and add the styles from atd.css to it.
4. Modify config.js in your ckeditor/ directory (or where ever you're calling CKEditor from) to load the AtD plugin:

   CKEDITOR.editorConfig = function( config )
   {
           config.extraPlugins = "atd-ckeditor";
           config.toolbar = 'MyToolbarSet';
   
           /* you can omit config.atd_rpc and it will default to the proxy.php in the same dir as the plugin */
           config.atd_rpc = '/path/to/proxy.php?url='; 
           config.atd_api_key = '1234567';
   
           config.toolbar_MyToolbarSet =
           [
               ['Bold','Italic','StrikeThrough','-','Subscript','Superscript'],
               ['atd-ckeditor'],
               ['NumberedList','BulletedList','Outdent','Indent','Blockquote','RemoveFormat','Source'],
               ['Link','Unlink'],
               '/',
               ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
               ['Format','FontSize'],
               ['FitWindow','ShowBlocks']
           ]
   };

5. As a final note, make sure your webpage is encoded in UTF-8 format. AJAX requests use the encoding of the parent website and AtD expects UTF-8. This is important as AtD supports accented characters and we're working to support more languages.

Using your own AtD Server

You can download the After the Deadline server from open.afterthedeadline.com and serve your own requests. If you go this route, modify server/proxy.php to connect to your AtD host. All the other steps are the same.

Development Status

This plugin was developed as a proof-of-concept for the AtD core UI module. It lacks the polish of the other AtD plugins and needs a maintainer. Patches are very welcome.

Here is a list of things that need to be done:

• Test and fix bugs with Internet Explorer (there may not be any for all I know)
• Need to use something other than CKEditor Context Menu plugin for errors or fix CKEditor Context Menu. Here are the issues:
  • Context menu is fixed width and doesn't resize for longer errors
  • Context menu doesn't honor Ctrl+Click for single button mice
  • Context menu uses cursor placement to determine which element the context menu was clicked on--makes using the menu awkward, user has to click the spelling error and then right click to bring up the context menu.
• Need to find a way to get CKEditor to load AtD CSS on its own. I tried a few different ways, you may do better than I did.
• Need to add "explain" menu for errors that have explanations
• Should update plugin to use editor.config.atd_show_types and editor.config.atd_ignore_strings values to set preferences in Core UI Module

Demo

A demo this extension is at: http://www.polishmywriting.com/ckeditor/

Get Involved

• Subversion repository
• Open Tickets (TRAC)
• Mailing List

License

LGPL

Contact

Raphael Mudge

Get support from the atd-developers mailing list.