eclipse / elk

Eclipse Layout Kernel - Automatic layout for Java applications.
https://www.eclipse.org/elk/
Other
258 stars 86 forks source link

Add test to actions verifying that all example models are laid out correctly #673

Closed uruuru closed 2 months ago

le-cds commented 4 years ago

What do you mean by "example methods"?

uruuru commented 4 years ago

Sorry, misstyped that one ...

le-cds commented 4 years ago

Still not sure what you're referring to here, though. 😄

uruuru commented 4 years ago

These ones: https://rtsys.informatik.uni-kiel.de/elklive/examples.html

le-cds commented 4 years ago

Ah! Makes sense.

lredor commented 4 years ago

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.

uruuru commented 4 years ago

@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.

uruuru commented 4 years ago

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.

le-cds commented 4 years ago

That's an excellent idea. We'll keep the idea around, although I'll better refrain from assigning it a milestone...