Motivation
When writing texts for pages/events/…, a spell checker would be a very helpful tool.
While TinyMCE offers a proprietary, commercial spellcheck plugin with many options, it also allows just relying on the browsers own spellcheck implementation. Activating it is only a matter of setting one boolean and thus an extremely low hanging fruit.
Proposed Solution
- Set
browser_spellcheck: true in integreat_cms/static/src/js/forms/tinymce-init.ts
Screenshot
Firefox
Alternatives
- Don't add spellchecking
This is the current status quo. But municipalities are wishing for the feature and we have an easy solution that would get us 99% of the way there, so it seems well worth doing the change
- Use the proprietary plugin
There were previous discussions and investigations about this. The plugin is pretty expensive for us and goes against our mission of producing FLOSS software. It is also not necessary, as we have an easy solution that would get us 99% of the way there
- Develop our own implementation (potentially relying on another library with glue code as a TinyMCE plugin)
A good spell checker is a complex project in itself and not something we are experienced in. It would require major resource investments that likely exceed the value it would add for us
User Story
As an author I want spelling errors to be highlighted, just as in my text program, so that silly typing mistakes don't make it into released content.
As an author I want to select a correction to be applied from the internal dictionary without retyping so that I don't have to look up myself how words are spelled.
Additional Context
Most recent mattermost discussion: https://chat.tuerantuer.org/digitalfabrik/pl/wdgw6oo4ntd5fq8rzcfzeo438o
Previous mattermost discussion regarding proprietary TinyMCE plugins: https://chat.tuerantuer.org/digitalfabrik/pl/8fu1bbn7qpd35drj7mtwd7zrby
Design Requirements
Related Issues
Summary of discussion and updates to the description
Motivation
When writing texts for pages/events/…, a spell checker would be a very helpful tool.
While TinyMCE offers a proprietary, commercial spellcheck plugin with many options, it also allows just relying on the browsers own spellcheck implementation. Activating it is only a matter of setting one boolean and thus an extremely low hanging fruit.
Proposed Solution
browser_spellcheck: trueinintegreat_cms/static/src/js/forms/tinymce-init.tsScreenshot
Firefox
Alternatives
This is the current status quo. But municipalities are wishing for the feature and we have an easy solution that would get us 99% of the way there, so it seems well worth doing the change
There were previous discussions and investigations about this. The plugin is pretty expensive for us and goes against our mission of producing FLOSS software. It is also not necessary, as we have an easy solution that would get us 99% of the way there
A good spell checker is a complex project in itself and not something we are experienced in. It would require major resource investments that likely exceed the value it would add for us
User Story
As an author I want spelling errors to be highlighted, just as in my text program, so that silly typing mistakes don't make it into released content.
As an author I want to select a correction to be applied from the internal dictionary without retyping so that I don't have to look up myself how words are spelled.
Additional Context
Most recent mattermost discussion: https://chat.tuerantuer.org/digitalfabrik/pl/wdgw6oo4ntd5fq8rzcfzeo438o
Previous mattermost discussion regarding proprietary TinyMCE plugins: https://chat.tuerantuer.org/digitalfabrik/pl/8fu1bbn7qpd35drj7mtwd7zrby
Design Requirements
Related Issues
Summary of discussion and updates to the description