jarchi-single-page-html-export icon indicating copy to clipboard operation
jarchi-single-page-html-export copied to clipboard

Show Element Documentation and Properties on mouse click/hover

Open n0vi opened this issue 4 years ago • 4 comments

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.

n0vi avatar Apr 02 '20 09:04 n0vi

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.

jbsarrodie avatar Apr 02 '20 11:04 jbsarrodie

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

n0vi avatar Apr 03 '20 05:04 n0vi

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.

jbsarrodie avatar Apr 03 '20 06:04 jbsarrodie

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

evlibra avatar Nov 30 '20 04:11 evlibra