An open API service indexing awesome lists of open source software.

https://github.com/divvun/woodwing-divvungc

⛎ Speller & grammar checker plugin for Woodwing ContentStation 10
https://github.com/divvun/woodwing-divvungc

divvun grammar-checker spell-check spelling woodwing

Last synced: 3 months ago
JSON representation

⛎ Speller & grammar checker plugin for Woodwing ContentStation 10

Awesome Lists containing this project

README

          

#+TITLE: 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.

#+ATTR_HTML: :alt demo
[[file:demo.gif][file:demo.gif]]

* 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.

* 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

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

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.

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

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 [[file:release/bundle.js::this.hostname%20%3D%20"192.168.22.60"%3B][release/bundle.js]] and
change the lines

#+BEGIN_SRC js
this.hostname = "10.35.10.13";
this.port = "2737";
this.protocol = window.location.protocol;
this.subdir = "";
#+END_SRC

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

#+begin_src sh
docker run --name apy -p2737:2737 -it unhammer/divvun:woodwing-apy
#+end_src

* Updating data/tools

Use [[docker/build][docker/build]] to rebuild images. The one above is built for arm64,
e.g. M1 macs; the script will tag anything you build from now on with
the arch, e.g. =docker.io/unhammer/divvun:woodwing-apy-x86_64=.