🚀 [Feature] Explain Editor Icons with a hover/Mouseover

[datenbrei]

🚀 Feature

Currently users don't know and have no explanation, what the menu items in the editor mean. Therefore it would be good, if the icons would be explained by a tooltip.

Design & Layout

Here is the current layout and nobody knows, what the single icons mean.

Additional context

The editor will also be explained in an FAQ.

[smapets]

Should I give it a go?? Beginner here..

[sushidave]

@drowvoloper @smapets Thank you very much for your offer to work on this issue and sorry for waiting. I just found this issue as stale and reopened it because the feature is will welcomed by the users. I hope you're still interested in it and ask @Tirokk to contact you and provide you with further info.

Ideally, the tooltip includes the respective keyboard shortcut keys (Win/Mac) and the markdown (?), plus the text should be shown in the respective language.

I see two versions for this in the UI:

a) Show this info in a separate tooltip for each toolbar button like GitHub does it:

b) Show a list of button icons, explanation (e.g. "bold"), keyboard shortcut, markdown - accessible by hovering/clicking a question mark aside of the toolbar.

First, we need to find answers to these questions:

• Which one is better or is there another solution?
• For version a: Should the markdown be included?

@Tirokk Let's discuss this at our next meeting.

[Tirokk]

Okidoki @sushidave !

[sushidave]

@Tirokk Regarding the question which one would be better, a tooltip for each button OR the list, and if the markdown code should be displayed:

What do you think of this solution...

1. Add a tooltip for each button showing the description and the keyboard shortcut (if existing), like on GitHub. Example: "Add italic text <Ctrl+i>" resp. "Add italic text <cmd+i>"), depending on the OS. Displaying the tooltips should be triggered by "click" or for touchscreens by "touch and hold".
2. Show an explanation of the function, keyboard shortcut and markdown in a popup, similar to the list in this FAQ. The popup should be displayed if the mouse pointer hovers over the question mark icon next to the toolbar. On touchscreens the popup should be triggered by "touch".

These two features can be implement independantly. If you are in favour of this solution I would create a new issue for the second feature.

[Tirokk]

Yes, @sushidave .
This sound suitable. 👍🏼

[sushidave]

@Tirokk Thank you. Issue #3673 created to cover the explanation (legend).

So, the markdown part won't be covered by this issue here. Please advise @drowvoloper and @smapets how to proceed. Thanks.

[Tirokk]

At the moment I haven’t the role or rights here to give anyone permissions.
Hope this will change soon … @sushidave

[heysivani]

Hi @Tirokk @sushidave! 🐨 I'm new to contributing to open source projects and really interested in your project. I'd love to take a crack at this issue if that's OK?

I'm going through the contribution guidelines, and noticed the discord invite links seem to be expired - is there an updated link somewhere?

[sushidave]

おはようございます @heysivani -san (-:
Welcome to this project and thanks very much for your readiness to contribute!
This repository has been discontinued and development goes on on its fork called Ocelot.Social. This issue has been copied there and it looks as if another contributor is working on it already. @Tirokk will provide you with an invitation to join the current communication channels of the developers, so that you can find a good alternative together.

[heysivani]

@sushidave おはよう again! Thank you for letting me know, I'll head over to the new fork and have a look at what I can do :)

[sushidave]

@heysivani どどうたしましまて and see you there (-: