Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 358162 - showing a command's tooltip in the UI
Summary: showing a command's tooltip in the UI
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: Client (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 0.3 M2   Edit
Assignee: Susan McCourt CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 359974
  Show dependency tree
 
Reported: 2011-09-19 17:59 EDT by Susan McCourt CLA
Modified: 2011-10-05 12:02 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2011-09-19 17:59:39 EDT
Commands have a description, but we don't use them.  It would be useful to have a way to get a description of a command before invoking it.  For example, on the git log page, I was wondering what the difference between "Push All" and "Force Push All" was....A small description would help.

We could implement a hover, or  by gesture/keystroke.
Comment 1 Susan McCourt CLA 2011-09-19 22:43:19 EDT
The simple fix is to set a title on the anchor tag for a command so that we get free hover.  However I don't like the current "if no tooltip, use the name" behavior, there's no need to have hovers that repeat the text.  So I just need to ensure that we aren't relying on that behavior anywhere else.

Then we need to get various command declarations to use the command.tooltip property.  (I said "description" in the bug but the property is called "tooltip") which I think is more precise.
Comment 2 John Arthorne CLA 2011-09-20 12:02:44 EDT
See also bug 349976. It seems we are showing the command name rather than the tooltip, at least in some cases.
Comment 3 Susan McCourt CLA 2011-09-20 12:15:04 EDT
(In reply to comment #2)
> See also bug 349976. It seems we are showing the command name rather than the
> tooltip, at least in some cases.

We do show the name when the command is rendered as an icon.  The problem in that bug is that the name is not set to a human readable name.  It needs to be, as this is the text used not only in the tooltip for icons, but as the link text itself when the command appears as text.

(In reply to comment #1)
> The simple fix is to set a title on the anchor tag for a command so that we get
> free hover.  However I don't like the current "if no tooltip, use the name"
> behavior, there's no need to have hovers that repeat the text.  So I just need
> to ensure that we aren't relying on that behavior anywhere else.

We weren't relying on the "use the name if no tooltip" behavior anywhere else, so I tried an implementation where we only hovered text links if there was a tooltip.  While it sounded good, it is actually confusing, because then the user doesn't know when to expect a tooltip.  So we are going to continue showing the name if no tooltip is defined, so that all commands, text or image, have a tooltip, and the user isn't hovering, wondering why some have them and some don't.  

> 
> Then we need to get various command declarations to use the command.tooltip
> property.  (I said "description" in the bug but the property is called
> "tooltip") which I think is more precise.

I'll open individual bugs for these.
Comment 4 Susan McCourt CLA 2011-09-20 12:17:02 EDT
fixed in 34278b625d7af91d8688df0127e52247757a8f44
Comment 5 Szymon Brandys CLA 2011-10-05 08:50:44 EDT
(In reply to comment #3)
> > Then we need to get various command declarations to use the command.tooltip
> > property.  (I said "description" in the bug but the property is called
> > "tooltip") which I think is more precise.
> 
> I'll open individual bugs for these.

I added tooltips for most of our Git commands. Since most of them are images, these tooltips are not useful for users. Can we do something about it? Moreover I raised bug 359974 for not rendering tooltips for commands in 'More' submenus.
Comment 6 Susan McCourt CLA 2011-10-05 12:02:20 EDT
(In reply to comment #5)
> (In reply to comment #3)
> > > Then we need to get various command declarations to use the command.tooltip
> > > property.  (I said "description" in the bug but the property is called
> > > "tooltip") which I think is more precise.
> > 
> > I'll open individual bugs for these.
> 
> I added tooltips for most of our Git commands. Since most of them are images,
> these tooltips are not useful for users. Can we do something about it? 

Yes, I've been on the fence about this one, but the current implementation was kind of weird (you could actually hover a few pixels off the image and see the tooltip because it was set on the containing anchor tag).  Image commands will now use the real tooltip and fall back to name if there is no tooltip.

> Moreover
> I raised bug 359974 for not rendering tooltips for commands in 'More' submenus.

I want to wait for 0.4 for this because i'm worried about the performance implications.  See bug 358296