MindTouch Community Portal
Logged in: Logged in as: Log in
Register
Search:
Page last modified 15:53, 1 Oct 2010 by Guerric
User:dev > Specs > ATD Spellchecking
Page Notifications Off

ATD Spellchecking

    Introduction

    This specification describes necessary changes to use AtD plugin with a MindTouch spellchecker server.

    Intended Audience

    In order to be a successful platform for documentation, spellchecking should be integrated into every MindTouch install. Editors will be empowered with more professional documentation enabling them to succeed.

    Additional information

    Status

    Scoped and ready for implementation

    Functional Specification

    Use Cases

    User wants to spellcheck documents

    Default MindTouch installations should have ATD enabled. New installations which have upgraded will also have ATD enabled by default.

    User wants to spellcheck in other languages

    Pages already have language information provided. These details should be shipped off to the ATD server to support spellchecking in multiple languages.

    Admin wants to disable spellchecking of documents

    Admins can login to the control panel and disable spellchecking site wide.

    Non-goals

    Ignoring terms will not be supported

    Grammatical errors & corrections will not be highlighted

    Technical Specification

    The plugin consists of editor plugin.js file and proxy.php file to communicate with After the Deadline server.

    Probably we can send requests directly to server and remove proxy.php file (in this case API key will be always public).

    We should extend editor API to showing/hiding toolbar buttons. So we'll have ability to show/hide AtD button depending on user preferences.

    • Add spellcheck in all supported languages (English, French, German, Portuguese, and Spanish)
      • Include the language to spellcheck in with the request
    • Add proxy script to store ignore strings
      • Rewrite proxy.php to use HttpPlug
    • Generate AtD API key automatically using hash of domain and username

    UI requirements

    Enable/disable editor plugin via basic configuration UI

    Create a new section on the basic configuration page which has the ATD spellchecker as an option. The only option we will expose here will be enabling/disabling the spellchecker.

    API requirements

    • Store ATD spellchecker setting (enabled/disabled)
      • ui/editor/atd-enabled: true/false
    • Generate the ATD ignore types list
      • ui/editor/atd-ignore-types: comma separated list
      • have defaults set in proxy.php
    • Is the ATD apikey required?
    Tag page
    What links here

    Files 0

    Attach file or image
     
    You must login to post a comment.
    MindTouch Social Knowledge Base

    Copyright © 2011 MindTouch, Inc. Powered by