Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 517551

Summary: [aird editor] Improve the documentation displayed when a representation is displayed
Product: [Modeling] Sirius Reporter: Pierre-Charles David <pierre-charles.david>
Component: CoreAssignee: Project inbox <sirius.core-inbox>
Status: CLOSED FIXED QA Contact: Julien Dupont <julien.dupont>
Severity: enhancement    
Priority: P3 CC: julien.dupont, pierre.guilet
Version: 4.1.1Keywords: triaged
Target Milestone: 5.0.1   
Hardware: All   
OS: All   
See Also: https://git.eclipse.org/r/99034
https://git.eclipse.org/c/sirius/org.eclipse.sirius.git/commit/?id=b2117126f051d78ef337c309807a61e08ba78dbe
Whiteboard: aird_editor ux

Description Pierre-Charles David CLA 2017-05-31 09:58:23 EDT 
Currently, when a concrete representation is selected in the "Representations" block the documentation displayed is the one of the parent viewpoint, or a generic "no documentation for this viewpoint".

* The "no documentation for this viewpoint" is not very adapted to the case of a concrete representation.
* DRepresentations can has an actual user-provided documentation (can be seen and edited in the "Documentation" tab of the properties view when the representation itself is selected.

If a representation-specific documentation exists, it should be used. Otherwise, it's probably OK to display the doc from the parent viewpoint, but with a different wording (to avoid "for this viewpoint"), or maybe we can generate some usefule text which gives some concrete information on the representation. Ideally a thumbnail (for diagrams) if/when we support efficient thumbnails generation/retrieval.
Comment 1 Eclipse Genie CLA 2017-06-09 11:36:52 EDT 
New Gerrit change created: https://git.eclipse.org/r/99034
Comment 3 Pierre-Charles David CLA 2017-06-30 09:46:29 EDT 
Available in Sirius 5.0.1, see https://wiki.eclipse.org/Sirius/5.0.1 for details.