Bug 561068

Summary: Document how to open/create diagrams programmatically
Product: [Modeling] Sirius Reporter: Emmanuel Chebbi <emmanuel.chebbi>
Component: DocumentationAssignee: Projet Inbox <sirius.doc-inbox>
Status: NEW --- QA Contact:
Severity: enhancement    
Priority: P3 CC: maxime.porhel
Version: unspecifiedKeywords: triaged
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:

Description Emmanuel Chebbi CLA 2020-03-12 12:00:44 EDT
The opening/creation of diagrams with Java code is a recurring topic in the Sirius forum:

 - https://www.eclipse.org/forums/index.php/t/1102818/
 - https://www.eclipse.org/forums/index.php/t/1102698/
 - https://www.eclipse.org/forums/index.php/m/1815630/
 - https://www.eclipse.org/forums/index.php/t/1093940/
 - https://www.eclipse.org/forums/index.php/t/1074382/
 - https://www.eclipse.org/forums/index.php/t/633830/

However there's still no clear documentation / step-by-step guide on how to do it properly. This is upsetting because:
 
 - users may have to fumble around trying to find the right classes/methods to use,
 - when facing issues it is hard to tell whether it's caused by a bug in Sirius or merely by a wrong usage of the API,
 - even if the code seems to work it's hard to tell whether it has been done properly,
 - it may cost a lot of time to figure out how to merely create a representation for a given model.

As a matter of fact, I recently had to deal with strange issues and had to tinker with the code to make it work. I still don't know if I encountered bugs or badly used the API:

 - https://www.eclipse.org/forums/index.php?t=msg&th=1100864&goto=1822134&#msg_1822134
 - https://www.eclipse.org/forums/index.php?t=msg&th=1102818&goto=1822734&#msg_1822734

Hence, I believe that enhancing the existing Developer Manuel or providing new tutorials on the subject could benefit to a lot of Sirius users.
Comment 1 Maxime Porhel CLA 2020-03-13 09:56:59 EDT
Hi Emmanuel, 

Thanks for the enhancement proposal. 
It is very interesting but has not been added to the scope of a future release yet.

Regards