tooltip revision project

Post here if you have re-based and finalised code to integrate into master, which was discussed, agreed to and tested in other forums. You can also submit your PR directly on github.
Post Reply
User avatar
uwestoehr
Posts: 587
Joined: Sun Jan 27, 2019 3:21 am

tooltip revision project

Post by uwestoehr » Tue Jul 16, 2019 9:57 am

While documenting preferences settings I noted that many tooltips are missing, are unprecise, have typos and/or are or too long. I therefore announced months ago i will have a look and come up with PRs. Now I found time and made 4 PRs.

https://github.com/FreeCAD/FreeCAD/pull/2345
https://github.com/FreeCAD/FreeCAD/pull/2347
https://github.com/FreeCAD/FreeCAD/pull/2348
https://github.com/FreeCAD/FreeCAD/pull/2349

They all follow these objectives:
- inform users as best as possible using the info we collected as team in the forum and that I put into the Wiki
- keep them as short as possible (without loosing information)
- use linebreaks for too long tooltips (some do so already; reason is that on smaller screens it is currently a mess)
- don't use HTML (not necessary, keep it simple for the translators)

wmayer
Site Admin
Posts: 14473
Joined: Thu Feb 19, 2009 10:32 am

Re: tooltip revision project

Post by wmayer » Thu Jul 18, 2019 10:56 pm

One remark about tool tips:
The application name "FreeCAD" shouldn't be hard-coded in strings shown to the GUI because this breaks the branding quite heavily. Instead the function getExecutableName() of App::Application must be used. So, this means that those tool tips where FreeCAD is hard-coded either should be changed using the word "application" instead of "FreeCAD" or if the latter is mandatory the tool tip must be moved from the .ui file to the .cpp file.

It's seems you add a tool tip to almost every control element of the dialogs. Honestly, I don't see its usefulness in cases where the tool tip text is almost identical to the label text next to the control.

User avatar
uwestoehr
Posts: 587
Joined: Sun Jan 27, 2019 3:21 am

Re: tooltip revision project

Post by uwestoehr » Thu Jul 18, 2019 11:58 pm

wmayer wrote:
Thu Jul 18, 2019 10:56 pm
either should be changed using the word "application" instead of "FreeCAD"
Good to know. I saw there several existing occurrences of hardcoded 'FreeCAD' in existing tooltips thus I did not thought it needs to be avoided.
wmayer wrote:
Thu Jul 18, 2019 10:56 pm
It's seems you add a tool tip to almost every control element of the dialogs. Honestly, I don't see its usefulness in cases where the tool tip text is almost identical to the label text next to the control.
I don't add tooltips for every element, e.g. not for labels or most group boxes. Yes, in few cases the tooltip did not reveal additional information but since the vast majority does I added them anyway to have some uniformity. If you want me to omit them, I will do so.

Post Reply