Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editorial issue: change UML diagrams to SVG #1294

Closed
jakubklimek opened this issue Feb 12, 2021 · 8 comments · Fixed by #1382
Closed

Editorial issue: change UML diagrams to SVG #1294

jakubklimek opened this issue Feb 12, 2021 · 8 comments · Fixed by #1382
Labels
dcat Editorial feedback Issues stemming from external feedback to the WG
Milestone

Comments

@jakubklimek
Copy link
Contributor

The UML diagrams in DCAT on a modern high-res monitor look terrible, because they are low-resolution bitmap graphics in PNG format.

I suggest switching to SVG vector graphics.

@kvistgaard
Copy link

kvistgaard commented Feb 12, 2021 via email

@riccardoAlbertoni
Copy link
Contributor

The UML diagrams in DCAT on a modern high-res monitor look terrible, because they are low-resolution bitmap graphics in PNG format.

I suggest switching to SVG vector graphics.

Yes, @jakubklimek, It would be great to have it. Could you suggest a free UML editor saving/exporting in SVG? I haven't come up with anything quick and easy to use so far ...

@jakubklimek
Copy link
Contributor Author

jakubklimek commented Feb 12, 2021

I use https://www.diagrams.net/
It is not ideal, as it is more of a paint tool that allows you to paint UML Class Diagrams, meaning you create an image, not data representing the data model. But it gets the job done.

See a created example: Czech DCAT-AP

@kvistgaard
Copy link

kvistgaard commented Feb 12, 2021 via email

@agbeltran
Copy link
Member

I think this is a great idea and I had started work on a mermaid file, representing the class diagram in Markdown, which can be converted automatically to SVG.

See my current version in this live editor.

This means we can keep the Markdown file (see it on the left hand side of the live editor) in the folder and generate the figure automatically (we could combine it with Github actions for this to happen when the markdown file is updated).

If this is of interest, I could complete the Markdown.

@riccardoAlbertoni
Copy link
Contributor

riccardoAlbertoni commented Feb 19, 2021

If this is of interest, I could complete the Markdown.

I think that would be great!

Just a doubt before proceed.
I wonder how configurable is the layout of the classes. We might need to force a specific layout to make the diagram readable. For example, we might want to constraint Catalog on the top left part of the diagram, Resource placed on the top right part of the diagram, etc.

@agbeltran: Do you know if that is possible on "mermaid"?

@andrea-perego andrea-perego added Editorial feedback Issues stemming from external feedback to the WG labels Feb 19, 2021
@init-dcat-ap-de
Copy link

@riccardoAlbertoni I am afraid, that is probably not possible. Maybe someone knows a program that could import Mermaid files and allows to edit their layout? The same goes for PlantUML.

I decided to use PlantUML over Mermaid because of the problems with class names: mermaid-js/mermaid#1635

@agbeltran
Copy link
Member

Indeed, it is quite limited what can be done in terms of layout althought it looks that there are plans for enabling more configuration options according to the documentation.

Good to see the issue about colons in class names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dcat Editorial feedback Issues stemming from external feedback to the WG
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants