Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] architecture additions #269

Merged
merged 16 commits into from
May 27, 2020
Merged

[DOC] architecture additions #269

merged 16 commits into from
May 27, 2020

Conversation

tbouffard
Copy link
Member

Closes #109
Closes #174

@tbouffard tbouffard added documentation Improvements or additions to documentation WIP 🚧 Pull request in progress and/or not ready for review. Used in addition to marking it as draft labels May 26, 2020
@tbouffard tbouffard force-pushed the doc_architecture_additions branch from 3c370df to 2b20232 Compare May 26, 2020 15:39
@tbouffard tbouffard force-pushed the doc_architecture_additions branch from 0331c6d to 8da305c Compare May 27, 2020 05:30
@tbouffard
Copy link
Member Author

The architecture overview schema should probably be improved, screenshot of commit 40a1cde

architecture overview schema commit 40a1cde

@tbouffard tbouffard removed the WIP 🚧 Pull request in progress and/or not ready for review. Used in addition to marking it as draft label May 27, 2020
@tbouffard tbouffard requested review from aibcmars and csouchet May 27, 2020 06:00
@tbouffard tbouffard marked this pull request as ready for review May 27, 2020 06:02

The bpmn input source coordinates are absolute whereas mxgraph uses coordinates in the referential of the parent cell.
As we define a parent-child relationship when inserting BPMN elements in the mxGraph model, a coordinate transformation
layer is required. See `MxGraphRenderer` for more details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
layer is required. See `MxGraphRenderer` for more details.
layer is required. See https://github.com/process-analytics/bpmn-visualization-js/blob/d812e36bca8dea8f9275161f2eb9a9a5173a9ca5/src/component/mxgraph/MxGraphRenderer.ts[MxGraphRenderer] for more details.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We previously decided to not link the doc to the source code. So I did the same as in the 'bpmn support how to' section: just refer to the class/file name

All BPMNShape elements are owned directly by a BPMNPlane (that is the root element in a BPMNDiagram), i.e., shapes
are not nested within each other in the BPMN DI model although they may appear that way when depicted. The bounds
of a BPMNShape are always relative to that plane’s origin point and are REQUIRED to be positive coordinates. Note that
the bounds’ x and y coordinates are the position of the upper left corner of the shape (relative to the upper left corner of
Copy link
Member

@csouchet csouchet May 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the bounds’ x and y coordinates are the position of the upper left corner of the shape (relative to the upper left corner of
the x and y coordinates of the bounds are the position of the upper left corner of the shape (relative to the upper left corner of

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would left it as it, it is the strict copy of the BPMN specification content

Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
Comment on lines +88 to +89
The bounds of BPMNLabel are always relative to the containing plane’s origin point. Note that the bounds’ x and y
coordinates are the position of the upper left corner of the label (relative to the upper left corner of the plane).
Copy link
Member

@csouchet csouchet May 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The bounds of BPMNLabel are always relative to the containing plane’s origin point. Note that the bounds’ x and y
coordinates are the position of the upper left corner of the label (relative to the upper left corner of the plane).
The bounds of BPMNLabel are always relative to the containing plane’s origin point. Note that the x and y coordinates
of the bounds are the position of the upper left corner of the label (relative to the upper left corner of the plane).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is the strict copy of the BPMN specification content (same remark as above)


|Call Activity
|
|
|===
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member Author

@tbouffard tbouffard May 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ I have seen the same kind of change in #271 and in #266, so merge conflicts will occur 😺

Copy link
Contributor

@aibcmars aibcmars left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

@tbouffard tbouffard merged commit ffb155a into master May 27, 2020
@tbouffard tbouffard deleted the doc_architecture_additions branch May 27, 2020 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants