elk
elk copied to clipboard
eclipse
Add test to actions verifying that all example models are laid out correctly
These ones: https://rtsys.informatik.uni-kiel.de/elklive/examples.html
I discovered this page. It is great. Is it a project to have similar examples on each option in the reference documentation? For example for Comment Box, it will be interresting to have this example to illustrate it.
@lredor there are no clear plans. I created the basis and was hoping that "people" (including me) find time to add an example once in a while.
The examples are described in a single file in a simple text format, are added to the elk models repo and then automatically deployed to the website. See https://github.com/eclipse/elk-models/tree/master/examples Everyone is encouraged to add simple examples where sensible.
Regarding your suggestion to add the examples to the reference documentation. The documentation website is created via a static site generator and I wouldn't include the layouter and a rendering engine there (if at all possible given eclipse guidelines). I must admit that I have thought about somehow merging the two sides before, though.
We could add a list of links to available examples to the layout options in the reference documentation. The models repos is available during website construction. Given a base-url it should thus be possible to assemble the relevant links.
That's an excellent idea. We'll keep the idea around, although I'll better refrain from assigning it a milestone...