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

[UI] Overall object description and help rework #1566

Open
HugoGenillier opened this issue Aug 8, 2024 · 0 comments
Open

[UI] Overall object description and help rework #1566

HugoGenillier opened this issue Aug 8, 2024 · 0 comments

Comments

@HugoGenillier
Copy link
Contributor

Object description and help has to be improve to bring more clarity for the user and to greatly ease the user experience.
We can identify 3 elements in the UI that can give user information about objects in score :

  • 1 The inspector's description
  • 2 The process information
  • 3 The tooltip

image

Inspector's description

The inspector description text also called status tip has to be reworked, completed of modified. This text is used to describe element to the user while working on his project
We'll have to check for setStatusTip() functions :

image

  • The length should be limited so that the text fully displays with default panel size's parameters.
  • Also, for processes, this status tip should no longer display the irrelevant name of inputs, outputs but rather the type of inputs or outputs expected like audio for red cable, multimedia for white etc... This will explain the cable system more efficiently.

Process information

This text is used to describe element to the user while searching for elements that he can use for his project.

The structure of this informative piece has to be redifined :

  • The order of information pieces should change to display the name followed by the description and then in and out numbers and authors at the end.
  • The length should be limited so that the text fully displays with default panel size's parameters.
  • Adding direct links to documentation page under a "more info" or "help" clickable link.

Note that some inspector's description and process information have the same description element, for plugin made with avendish for instance.

image

  • For recent processes and plugins made with avendish
    image

  • For older processes and plugins
    image

Tooltip

image

The tooltip can't be very long but should display the name of the element hovered and the possible shortcuts associated with it between parenthesis, like "Create (C)" even tho this one needs a more explicit name (create... what ?).
To achieve this, we'll have to know every existing shortcuts to be able to indicate them. For most element we'll have to look for setToolTip() function.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: TODO
Development

No branches or pull requests

2 participants