Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 [Feature] Explain Editor Icons with a hover/mouseover (Tooltip) #1950

Open
Tirokk opened this issue Oct 5, 2020 · 13 comments
Open

🚀 [Feature] Explain Editor Icons with a hover/mouseover (Tooltip) #1950

Tirokk opened this issue Oct 5, 2020 · 13 comments

Comments

@Tirokk
Copy link
Member

Tirokk commented Oct 5, 2020

datenbrei Authored by datenbrei
Oct 18, 2019


🚀 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.
editor

Additional context

The editor will also be explained in an FAQ.

@Tirokk
Copy link
Member Author

Tirokk commented Oct 7, 2020

smapets Authored by smapets
Dec 26, 2019


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

@Tirokk
Copy link
Member Author

Tirokk commented Oct 7, 2020

sushidave Authored by sushidave
Jun 11, 2020


@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:
hc-post-editor-toolbar-tooltip

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
Copy link
Member Author

Tirokk commented Oct 7, 2020

Tirokk Authored by Tirokk
Jun 17, 2020


Okidoki @sushidave !

@Tirokk
Copy link
Member Author

Tirokk commented Oct 7, 2020

sushidave Authored by sushidave
Jun 22, 2020


@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
Copy link
Member Author

Tirokk commented Oct 7, 2020

Tirokk Authored by Tirokk
Jun 24, 2020


Yes, @sushidave .
This sound suitable. 👍🏼

@Tirokk
Copy link
Member Author

Tirokk commented Oct 7, 2020

sushidave Authored by sushidave
Jun 24, 2020


@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
Copy link
Member Author

Tirokk commented Oct 7, 2020

Tirokk Authored by Tirokk
Jul 8, 2020


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

@Brandon-G-Tripp
Copy link
Contributor

@Tirokk Hey I am currently starting on the issue we discussed (Legend of post editor toolbar buttons #3673). Is it ok if I work on this one at the same time. Since I will be digging around in the same area of the code? If so I will assign this to myself also.

@Tirokk
Copy link
Member Author

Tirokk commented Nov 3, 2020

Cool!
I assigned this one as well to you @Brandon-G-Tripp .

@Brandon-G-Tripp
Copy link
Contributor

@Tirokk Hey I am diving back into this issue. Is there an easy place to find the shortcuts mentioned for the editor?

@Tirokk Tirokk pinned this issue Nov 16, 2022
@Tirokk Tirokk changed the title 🚀 [Feature] Explain Editor Icons with a hover/Mouseover 🚀 [Feature] Explain Editor Icons with a hover/mouseover (Tooltip) Mar 22, 2023
@Tirokk
Copy link
Member Author

Tirokk commented Mar 22, 2023

@sushidave I guess this is successfuly done by our help menu (?).
Or?

@sushidave
Copy link
Member

@Tirokk I understood that the goal was to implement both, tooltip and legend, see comments of Jun 22-24.
The legend part (issue #3673) was implemented by pull #4492 and #4556.
The tooltip part (this issue) is still open. The feature improves UX cause it makes the toolbar more intuitive. However, it's a nice to have feature for me.

@Tirokk
Copy link
Member Author

Tirokk commented Mar 24, 2023

@Tirokk I understood that the goal was to implement both, tooltip and legend, see comments of Jun 22-24. The legend part (issue #3673) was implemented by pull #4492 and #4556. The tooltip part (this issue) is still open. The feature improves UX cause it makes the toolbar more intuitive. However, it's a nice to have feature for me.

Okidoki and thanks for clarification of your understanding and your comment hint @sushidave 👍🏼

@mahula mahula unpinned this issue Jun 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants