[DOC] Choose a convenient id for html elements displaying the BPMN diagrams - Githubissues

process-analytics / bpmn-visualization-js

A TypeScript library for visualizing process execution data on BPMN diagrams

https://process-analytics.github.io/bpmn-visualization-js/

Apache License 2.0

224 stars 31 forks source link

[DOC] Choose a convenient id for html elements displaying the BPMN diagrams #866

Closed tbouffard closed 3 years ago

tbouffard commented 4 years ago

Current status

The goal of this decision is to be consistent in both documentation, code and examples. It is part of the work engaged with #864

Over the time, we have introduced various ids and none is satisfying

graph and maybe graph-container: this is the id used in mxgraph, but we aren't a mxgraph lib, we should find something related to the BPMN domain (we are not displaying graphs)
viewport, view-port or bpmn-viewport: viewport is a term already used in the browser glossary and may be confusing

Note: other libs use

bpmn-js: canvas
ProcessMaker/modeler: paper-container

Proposals

bpmn-container
bpmn-viewport
....

Tasks

[x] choose an id of a family of ids: bpmn-container
[x] update the documentation - #892
[x] update the demo - #893
[x] update the test pages (the lib-integration page may use a completely different id to test that there is no impact of the demo on the integration) - #891 and #893
[x] update the examples: https://github.com/process-analytics/bpmn-visualization-examples/pull/93

tbouffard commented 3 years ago

Closing as all tasks are completed.