divvun/woodwing-divvungc

⛎ Speller & grammar checker plugin for Woodwing ContentStation 10

Divvun spelling and grammar checker plugin for WoodWing ContentStation 10

This is a plugin for WoodWing ContentStation 10 that provides spelling and grammar checking with Divvun’s proofing tools (see http://divvun.no/ and https://github.com/divvun/divvun-gramcheck).

Currently, we just do “batch” spelling. That is, after writing a text, you can open the plugin and let it check the text and show spelling suggestions in a separate window, you may then pick suggestions and apply them back to the original document.

Limitations

There is no on-the-fly spelling, only batch. The WoodWing API doesn’t yet provide a way to underline and put events on strings in their editor. When such an API arrives, we should be able to do spelling on-the-fly.

There is also no support yet for the digital editor (multichannel), only the print editor, since WoodWing doesn’t yet provide an API for the digital editor. The API is expected to come some time in the first quarter of 2018.

Installing

Frontend (this repo)

To install the frontend, put the contents of the release folder into a subdirectory named divvungc of the WoodWing config/plugins folder on the server. If this folder is e.g.

/Applications/MAMP/htdocs/Enterprise/config/plugins/divvungc/

then you can copy it from your machine with

rsync -avh release/ woodwingserver:/Applications/MAMP/htdocs/Enterprise/config/plugins/divvungc/
# The trailing / here is important

Then under the plugins object in /Applications/MAMP/htdocs/Enterprise/contentstation/config.js, add the path to the bundle under printEditor and contentStation, e.g.

plugins: {
  digitalEditor: [
    '../config/plugins/divvungc/bundle.js'
  ],
  printEditor: [
    '../config/plugins/divvungc/bundle.js'
  ]
}

if you have no other plugins there already.

Backend

URL to the backend is currently hardcoded in the JavaScript. If you need to change the URL/port/subdir, you can edit release/bundle.js and change the lines

this.hostname = "192.168.22.60";
this.port = "2737";
this.protocol = window.location.protocol;
this.subdir = "";

If you wish to run the backend from your own server:

docker run --name apy -p2737:2737 -it unhammer/divvun:woodwing-apy

Use docker/build to rebuild images (the one above is built for arm64, e.g. M1 macs).

woodwing-divvungc's Issues

wwEditor.replaceText sometimes silently fails

test article 950914, with text Den ser sáhkaá ja politihkkalaš. gives correct suggestions and underlines, but when we select the suggestion for politihkkalaš and click apply changes, nothing happens. Logs say

In component 1, replace substring from 26 to 27 with '' – with wwEditor {}

which seems correct, and the return value of wwEditor.replaceText must be true since there's no warning about not being able to replace text.

Docker

https://github.com/divvun/woodwing-divvungc/blob/master/scripts/avvir-build-backend should be converted to a docker image

• access to woodwing test server granted, vnc working
• Docker setup and running on test server
• apy branch updated to work with newest tornado
• docker image "working" – but sirupy slow because arm64 is emulating amd64 :-(
• try manually compiling dependencies – on arm64 – when making docker image and unpacking giella-sme to the right dirs
• install the js bundle + config needed on woodwing test server
  • various copies of bundle.js were lying around, with hostname hardcoded to 192.168.22.60 – now changed to …22.61
• check that spelling quality is still OK
  • Couldn't find sátnejođiheaddji in {"errs":[["jodiheaddji",5,16,"typo","Ii leat sátnelisttus",["jođiheaddji"],"Čállinmeattáhus"]],"text":"sátnejodiheaddji.\n"} (well, it corrects it, but should probably cover the whole word)
  • Couldn't find "hukset" in {"errs":[["husket",0,6,"typo","Ii leat sátnelisttus",["gusket","hutket","fusket","hásket","busket","čusket","usket","cusket","huiket","susket"],"Čállinmeattáhus"]],"text":"husket.\n"}
  • (the four other sanity-tests pass)

woodwingtest is an M1 server – so the docker image needs to be arm64. To build the image, cd docker && ./build on an arm64 machine and docker push. Can also just run the build script on woodwingtest itself.