https://github.com/oxygenxml/web-author-learn-words-plugin
Plugin for adding learned/forbidden words functionality to Web Author spellchecking.
https://github.com/oxygenxml/web-author-learn-words-plugin
oxygen-web-author-plugin
Last synced: 5 months ago
JSON representation
Plugin for adding learned/forbidden words functionality to Web Author spellchecking.
- Host: GitHub
- URL: https://github.com/oxygenxml/web-author-learn-words-plugin
- Owner: oxygenxml
- License: apache-2.0
- Created: 2018-10-08T11:55:22.000Z (over 7 years ago)
- Default Branch: BRANCH_OXYGEN_RELEASE_27_1
- Last Pushed: 2025-11-14T10:36:33.000Z (7 months ago)
- Last Synced: 2025-11-14T12:23:59.243Z (7 months ago)
- Topics: oxygen-web-author-plugin
- Language: Java
- Size: 212 KB
- Stars: 0
- Watchers: 24
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Notice: NOTICE
Awesome Lists containing this project
README
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:
```
wordexample
worda
longword
learned word
worta
wortb
some
forbidden
words
verboten
```
The file is loaded either from a the server's local file system, or from an external HTTP server (GET request).
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 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](https://github.com/oxygenxml/web-author-learn-words-plugin/releases)) and [upload it in your Web Author deployment](https://www.oxygenxml.com/doc/ug-webauthor/topics/webapp-configure-plugins.html).
Configuration through Administration page.
-------------
The plugin can be configured from the [Web Author Administration Page](https://www.oxygenxml.com/doc/ug-waCustom/topics/webapp-admin-page.html).
You can set:
- the number of suggestions to be shown from the learned words list. They will always be shown at the top of the list of suggestions.
- the read-only mode, enabled by default. If turned off, a "Learn word" action is added to the contextual menu and any user can add words to the learned words list.
- the dictionary. It may be a local file, or an HTTP server able to serve the list of learned words(GET) and add new learn words(POST).
Configuration through options.xml file
-------------
The plugin can also be configured by [customizing options](https://www.oxygenxml.com/doc/ug-waCustom/topics/customizing-options.html) in Web Author's options.xml:
- the number of suggestions to be shown from the learned words list
```
PLUGIN_CUSTOM_OPTIONS.suggestions-no.name
2
```
- the read-only mode
```
PLUGIN_CUSTOM_OPTIONS.lw.read-only-mode
off
```
- use a local dictionary file
```
PLUGIN_CUSTOM_OPTIONS.file-selected.name
on
PLUGIN_CUSTOM_OPTIONS.file-path.name
PATH_TO_FILE
```
- OR use an HTTP server
```
PLUGIN_CUSTOM_OPTIONS.url-selected.name
on
PLUGIN_CUSTOM_OPTIONS.url.name
http://EXAMPLEURL
```
Copyright and License
---------------------
Copyright 2021 Syncro Soft SRL.
This project is licensed under [Apache License 2.0](https://github.com/oxygenxml/web-author-learn-words-plugin/blob/master/LICENSE)