feat: Add support for embedded images #464
Conversation
Currently, embedded images are not handled properly. An embedded image link contains the name of the Capella project as first element of the path in the `src` attribute, but the path doesn't exist on the file system. To resolve the issue, we remove the project name as prefix.
There was a problem hiding this comment.
Thanks for looking into this!
An embedded image link contains the name of the Capella project as first element of the path in the
srcattribute
I think this first element here is the name of the "Eclipse-level" project, which is recorded in the .project file (and usually also used for the model itself, which is why model.info.title works - most of the time). This might be useful to figure out which resource to load from if there are multiple.
| def _from_xml( | ||
| self, value: str, model: capellambse.MelodyModel, / | ||
| ) -> U: ... |
There was a problem hiding this comment.
Minor thing: Please change the order to be self, model, value instead of self, value, model, for more consistency overall. (Almost) All functions that require a model expect it as first non-self argument.
It's an API break anyways, as old methods only expect a single argument.
| def _resolve_embedded_images( | ||
| self, value: str, model: capellambse.MelodyModel, / | ||
| ) -> markupsafe.Markup: |
There was a problem hiding this comment.
Same here, please use self, model, value.
Currently, embedded images are not handled properly. An embedded image link contains the name of the Capella project as first element of the path in the
srcattribute, but the path doesn't exist on the file system.To resolve the issue, we remove the project name as prefix.
Open issues:
_to_xmlmethod. However, I don't have a stable solution how to identify embedded image links yet.Alternative solution could be to provide a description postprocessing helper function, which is used for the HTML rendering. This would solve the issue with broken image references in Jupyter.