Skip to content

Plugin for adding learned/forbidden words functionality to Web Author spellchecking.

License

Notifications You must be signed in to change notification settings

bogdangoreci/web-author-learn-words-plugin

 
 

Repository files navigation

Web Author Learn Words Plugin

Plugin for adding learned/forbidden words functionality to Web Author spellchecking.

How it works

The list of words is stored in a file with the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<Dictionary>
    <Learned>
        <Language code="en">
            <w>worda</w>
            <w>wordb</w>
            <w>wordc</w>
        </Language>
        <Language code="fr">
            <w>worta</w>
            <w>wortb</w>
        </Language>
    </Learned>
    <Forbidden>
        <Language code="en">
            <w>some</w>
            <w>forbidden</w>
            <w>words</w>
        </Language>
        <Language code="de">
            <w>verboten</w>
        </Language>
    </Forbidden>
</Dictionary>

The file is loaded either from a the server's local file system, or from an external HTTP server. When a user chooses to learn a word the following action happens:

  1. If the plugin is configured to use a local file, the new word is added to that file.
  2. If the plugin is configured to use load the file from an HTTP server, a POST request is sent to the URL of the file with the following form parameters:
Parameter name Parameter value
mode One of learned or forbidden
lang The language for which the word is added, e.g. en
word The word to be added

Installation

To install this plugin, download one of the releases (link) and upload it in your Web Author deployment.

Configuration

The location of the dictionary file and other options can be configured from the Web Author Administration Page.

Copyright and License

Copyright 2018 Syncro Soft SRL.

This project is licensed under Apache License 2.0

About

Plugin for adding learned/forbidden words functionality to Web Author spellchecking.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 83.5%
  • JavaScript 9.3%
  • HTML 7.2%