bpmn-js-plugin-embedded-comments conflict with documentation element about camunda-modeler-plugins HOT 6 CLOSED

Please link to the resources you're quoting and add screenshots that make your case. It is otherwise hard to follow your line of thought.

Even better, create a small screencast that records a broken interaction.

from camunda-modeler-plugins.

Thanks for providing additional details.

From what I can see this is an issue with the fact that the Camunda Modeler drops the textFormat attribute, while it

a) Should ignore the documentation, unknown to her entirely or
b) keep the textFormat attribute

I've opened camunda/camunda-modeler#1682 to track this as a bug. Please cross read it to see if it captures your issue.

Closing this issue, as it is really a modeler bug that needs to be fixed.

from camunda-modeler-plugins.

Sorry, I missed, that the issue isn't placed at the folder I opened it, but it placed at the project root...
I named the plugin already, here is the link
https://github.com/camunda/camunda-modeler-plugins/tree/master/bpmn-js-plugin-embedded-comments

I add some screenshots, because a screencast is a bit difficult here. Also I builded a little dummy process. The scenarios I will divide...

from camunda-modeler-plugins.

scenario 1, first comments
adding some comments...

element documentation

XML (btw: modeler 3.6.0 and plugin embedded comments master from last week -> saving comments is only possilbe when modifying the model... ah, sorry, I forgot: no btw ;) )
<bpmn:serviceTask id="Task_1laa02j" name="überprüfe Daten"> <bpmn:documentation textFormat="text/x-comments">:Dies ist ein Kommentar; ;:Es gehen auch mehrere Kommentare...; ;:noch eine Zeile; ;:noch eine Zeile mehr</bpmn:documentation> <bpmn:incoming>SequenceFlow_0av8imw</bpmn:incoming> <bpmn:outgoing>SequenceFlow_0p2xcqe</bpmn:outgoing> </bpmn:serviceTask>

OK.
Now adding some description (where to add else?)

XML (now the comments are destroyed and used as description):
<bpmn:serviceTask id="Task_1laa02j" name="überprüfe Daten"> <bpmn:documentation>:Dies ist ein Kommentar; ;:Es gehen auch mehrere Kommentare...; ;:noch eine Zeile; ;:noch eine Zeile mehr Meine eigene Dokumentation</bpmn:documentation>

The comments are still cached and shown as comments, until the next reload. Then they are gone...

from camunda-modeler-plugins.

scenario 2, first documentation
adding some documentation

Now adding some comments

XML (again, comment changes are only saved after editing something others in the bpmn)
<bpmn:serviceTask id="Task_1laa02j" name="überprüfe Daten"> <bpmn:documentation>Meine eigene Dokumentation</bpmn:documentation> <bpmn:documentation textFormat="text/x-comments">:Ein Kommentar; ;:gern auch mehrzeilig</bpmn:documentation> <bpmn:incoming>SequenceFlow_0av8imw</bpmn:incoming> <bpmn:outgoing>SequenceFlow_0p2xcqe</bpmn:outgoing> </bpmn:serviceTask>

Looks great, comments and documentation properly separated 👍

But now I delete the documentation!

XML
<bpmn:serviceTask id="Task_1laa02j" name="überprüfe Daten"> <bpmn:incoming>SequenceFlow_0av8imw</bpmn:incoming> <bpmn:outgoing>SequenceFlow_0p2xcqe</bpmn:outgoing> </bpmn:serviceTask>

Where are the comments gone? Why are all documentation elements removed from the task?

from camunda-modeler-plugins.

I hope it's now more clear what the strange behaviors are.
Both ways run in into other mistakes, both are a combination of unwanted cross-editing from Camunda Modeler an embedded-comments-plugin. I think, the plugin itself can't fix this problem without some changes in the Modeler. The Modeler should respect special documentation elements. Maybe a fix in the Modeler only will fix all these problems. Only show simple documentation entries and ignore special documentation elements as well as leaving them untouched. It's a bit like scenario 2, but without deleting all documentation elements when removing the simple documentation :)

Regards,
Frank

from camunda-modeler-plugins.