#3665 closed enhancement (fixed)
Add display of the description string of instantiated component
| Reported by: | Dietmar Winkler | Owned by: | Adeel Asghar |
|---|---|---|---|
| Priority: | high | Milestone: | 1.9.4 |
| Component: | OMEdit | Version: | |
| Keywords: | Cc: | fcasella |
Description
Currently when one looks at the parameter of an instantiated component only the name and the path are displayed. But not the original description string.
It would be nice to also display that one.
See also https://github.com/itesla/ipsl/pull/95 for an example where this feature comes in handy.
Change History (15)
comment:1 by , 9 years ago
| Status: | new → accepted |
|---|
comment:2 by , 9 years ago
Both actually. The component description you would want to be able to edit just like the name and the class description should be displayed in addition. Similar to how Dymola is doing it ;-)
comment:3 by , 9 years ago
I can display component description but it would only be read-only. We already have it editable in Component Attributes dialog. In my opinion description is an attribute of the component and should be only shown in attributes window. Lets just only keep parameters in the parameters window.
I think for this ticket I should only add class description because if I show component's description then it will be confusing.
comment:4 by , 9 years ago
OK I was not aware of the component attributes.
Though for this ticket the most important feature is to display the class description. So that should be fine if you can implement that.
However I wonder where a user would actually get to see the component description. It seems to be missing in the "mouse-over" on the component in the diagram layer. Perhaps it should be added there.
comment:6 by , 9 years ago
| Resolution: | → fixed |
|---|---|
| Status: | accepted → closed |
7cd899b/OMEdit includes component comment to the tool-tip shown on mouse-over.
comment:8 by , 9 years ago
One question, I noticed though the comment is rendered correctly as HTML including coloured links. The links are not clickable. If this is a bug then I will report a new ticket on this. But maybe it was by design?
comment:9 by , 9 years ago
Are the links clickable in Dymola? I think they are just for display purpose.
comment:11 by , 9 years ago
| Summary: | Add display of the description string of instansiated component → Add display of the description string of instantiated component |
|---|
comment:12 by , 9 years ago
Yeah you are right. Forget Dymola. e3b00ab/OMEdit shows the description in html format including images and clickable links, it also handles modelica://.
You mean display the component description string or component's class description string?