WYSIWYG Documentation editor for Camunda Modeler

A Camunda Modeler plug-in based on the plug-in example.

About

This plug-in enables a WYSIWYG text editor for the Documentation field, allowing a user to create HTML presentational documentation embedded inside the bpmn file.

Install

Extract the release zip file to your camunda-modeler/resources/plugins folder. Super easy!

Development Setup

Use npm, the Node.js package manager to download and install required dependencies:

npm install

To make the Camunda Modeler aware of your plug-in you must link the plug-in to the Camunda Modeler plug-in directory via a symbolic link. Available utilities to do that are mklink /d on Windows and ln -s on MacOS / Linux.

Re-start the app in order to recognize the newly linked plug-in.

Building the Plug-in

You may spawn the development setup to watch source files and re-build the client plug-in on changes:

npm run dev

Given you've setup and linked your plug-in as explained above, you should be able to reload the modeler to pick up plug-in changes. To do so, open the app's built in development toos via F12. Then, within the development tools press the reload shortcuts CTRL + R or CMD + R to reload the app.

To prepare the plug-in for release, executing all necessary steps, run:

npm run all

Compatibility Notice

This plugin is currently compatible with the following Camunda Modeler versions.

Camunda Modeler	Documentation Editor Plugin
3.4 - 4.12	0.2.0
5.x	1.0 or newer

Additional Resources

• The Wysiwyg editor
• List of existing plug-ins
• Plug-ins documentation

Licence

MIT