archi-contribs / jarchi-single-page-html-export

Generate a single-page HTML export from Archi
22 stars 6 forks source link

Show Element Documentation and Properties on mouse click/hover #9

Open n0vi opened 4 years ago

n0vi commented 4 years ago

Currently Element properties are not exported.

Being able to see them as a table or list after a click on the element on a diagram would make the export more useful and complete.

My workflow relies on using element properties a lot to describe common things like implementation language, api endpoint address, urls to logging, source code repository, etc. Actually, a diagram picture and the stuff around in the element properties is the most valuable piece for that kind of workflow when exploring documentation.

jbsarrodie commented 4 years ago

That's something I'm thinking about. My main issue is related to user experience because that's easy to add another main tab (between Documentation and Elements) for view's properties, but that's harder to integrate for elements' and relationships' properties.

One option (easy to implement) I though about is to add properties as a collapsible section behing each documentation (for view but also elements and relationships). This section would exist only if there is at least one property and would be collapsed by default.

Ideas and suggestions are welcome.

n0vi commented 4 years ago

I see, how about css onhover tooltip that shows properties? Something similar to codepen css tooltip sample.

jbsarrodie commented 4 years ago

how about css onhover tooltip that shows properties?

I though about it too. I don't think it would be useful for view's properties (a tab or a section would be better IMHO) but that could make it for elements and relationships.

evlibra commented 3 years ago

Implementing this (or at least description) would really make the html export usable.