https://github.com/bpmn-io/bpmn-js-embedded-comments

Simple comments for bpmn-js
https://github.com/bpmn-io/bpmn-js-embedded-comments

bpmn-js commenting

Last synced: 3 months ago
JSON representation

Simple comments for bpmn-js

• Host: GitHub
• URL: https://github.com/bpmn-io/bpmn-js-embedded-comments
• Owner: bpmn-io
• License: mit
• Created: 2014-09-22T10:14:23.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2023-12-13T17:34:05.000Z (11 months ago)
• Last Synced: 2024-04-14T11:10:10.133Z (7 months ago)
• Topics: bpmn-js, commenting
• Language: JavaScript
• Homepage:
• Size: 288 KB
• Stars: 14
• Watchers: 12
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bpmn-io - bpmn-js-embedded-comments - Add, edit, and persist comments on BPMN diagrams (Extensions)

README

        
# bpmn-js-embedded-comments

An extension for [bpmn-js](https://github.com/bpmn-io/bpmn-js) that allows you to comment on a BPMN 2.0 diagram. 

Stores the comments within the BPMN 2.0 XML file.

![A screenshot of a comments integration](https://raw.githubusercontent.com/bpmn-io/bpmn-js-embedded-comments/master/docs/screenshot.png)

## How comments are stored

Comments are read, added and written to an elements `` tag.

The format for comments is assumed to be

```

author:comment;

;other-author:other comment

canbe multiline, too

```

## License

MIT