Bug 305895 - [Webapp] Need an indication that a filter has been applied
Summary: [Webapp] Need an indication that a filter has been applied
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.6   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.7 M3   Edit
Assignee: Chris Goldthorpe CLA
QA Contact:
URL:
Whiteboard:
Keywords: polish
: 248070 (view as bug list)
Depends on:
Blocks:
 
Reported: 2010-03-15 13:07 EDT by Chris Goldthorpe CLA
Modified: 2010-10-11 19:09 EDT (History)
3 users (show)

See Also:


Attachments
Initial idea (24.75 KB, image/png)
2010-03-17 19:14 EDT, Chris Goldthorpe CLA
no flags Details
Patch (6.79 KB, patch)
2010-08-25 13:37 EDT, Chris Goldthorpe CLA
no flags Details | Diff
Patch which adds "show all" (9.42 KB, patch)
2010-10-11 15:59 EDT, Chris Goldthorpe CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Goldthorpe CLA 2010-03-15 13:07:26 EDT
3.6M6

From Bug 303105

1) In the Results view (TOC or search results or index), there needs to be
   clear indication whether it's currently filtered or not, along with a UI
   control to influence the filter. It's too easy to forget that some filter
   had been applied and then be surprised that some expected content is not
   there.
   Consider Google Picasa for instance: When I apply a filter like "Starred
   Photos only" then (1) that filter pushbutton remains pushed, and (2) 
   I get a big green banner with a "Back to Show All" button in the search  
   results view. The "Show All" metaphor is much more important than all 
   other filtering capabilities.
Comment 1 Chris Goldthorpe CLA 2010-03-16 13:52:29 EDT
Vivian, do you agree that this is a good idea and do you have time to add this in M7?
Comment 2 Hao Zhang CLA 2010-03-16 22:17:56 EDT
Yes, I think so. It is obviously useful. I'll take this item.

But I wonder how this UI will be like. In each view(toc/index/search), add such banner to indicate user that filtering is on?

Chris, do you have any idea? If so, can you make some mock up?
Comment 3 Chris Goldthorpe CLA 2010-03-17 19:14:35 EDT
Created attachment 162370 [details]
Initial idea

Here is my initial idea about how it would look but I'm open to any ideas to improve the appearance or wording. Here is what I think is important

1. The message should be short and not take up much space. This is why I have a hyperlink instead of a button.
2. It does not visually distract from the body of the view.
3. The same text appears in toc, search results and index.
4. If the scope is "all" the message is hidden

I've copied Martin for his ideas on this
Comment 4 Hao Zhang CLA 2010-04-21 01:06:18 EDT
This item will be moved to the next release.
Comment 5 Chris Goldthorpe CLA 2010-08-24 17:29:49 EDT
Vivian, have you looked at this at all recently? If not I will assign it to myself - I think I can get this implemented for this milestone.
Comment 6 Hao Zhang CLA 2010-08-24 21:46:23 EDT
Not yet. Chris, you can help to take it.
Comment 7 Chris Goldthorpe CLA 2010-08-25 13:37:30 EDT
Created attachment 177450 [details]
Patch

After experimenting with having both a message indicating that a scope is applied and a button or hyperlink to show all topics I concluded that the message was important, the button far less so since you can change scope by clicking on the "Scope" link, which the user has already just done. Given the limited space available in these views I decided to implement the message but not the button.
Comment 8 Chris Goldthorpe CLA 2010-08-25 13:39:14 EDT
Patch committed to HEAD, Fixed.
Comment 9 Chris Goldthorpe CLA 2010-09-20 14:35:21 EDT
*** Bug 248070 has been marked as a duplicate of this bug. ***
Comment 10 Martin Oberhuber CLA 2010-09-21 05:50:55 EDT
(In reply to comment #7)
> since you can change scope by clicking on the "Scope" link, which the user
> has already just done. 

Is it really guaranteed that the user has restricted the scope herself? No chance the scope restriction has been applied programmatically (by the app trying to be smart auto-detecting the best scope), or in an earlier session, or just long ago?

I think that in terms of usability, the "return to show all" metaphor is much more important than changing the scope to something else. By not having the "Show all" hyperlink, this metaphor is much harder to find and requires more clicks (open the scope dialog, select show all, press OK).

If lack of screen real estate is the problem, then looking at the original proposal from attachment 162370 [details] I'd rather shorten the text but keep the "Show All" hyperlink. For instance, instead of:

    Results are filtered by scope "jdt"

use any of:

    Filtered by scope "jdt"    Show All
    Active scope: "jdt"        Show All
    Active filter: "jdt"       Show All
Comment 11 Chris Goldthorpe CLA 2010-09-21 11:30:08 EDT
I agree that the show all button/hyperlink is useful, reopening the bug so I can add that.
Comment 12 Holger Voormann CLA 2010-09-21 13:31:08 EDT
(In reply to comment #10 and comment #11)
+1 for "Show all" feature

I like to propose following enhancements/polishing (see mockup
https://bugs.eclipse.org/bugs/attachment.cgi?id=179263):

1. Skip prefix like "Result for scope" because the scope name only is sufficient and clear (Google does also not use such prefix)

2. Instead of the "Show all" link use a "Close" button because it's easier to understand and it is smaller (see mockup)
Comment 13 Chris Goldthorpe CLA 2010-10-11 15:59:14 EDT
Created attachment 180616 [details]
Patch which adds "show all"

This patch implements the show all hyperlink. I think that this is more obvious to the user than showing an 'x' next to the name of the scope.
Comment 14 Holger Voormann CLA 2010-10-11 17:26:05 EDT
(In reply to comment #13)

Thanks for implementing this feature. About 10 technical writers told me that they are looking forward for this feature because in our customized Infocenter a default scope is set which can be easy overlooked.

I would prefer "x" instead of "Show all" because:
- "Show all" can be misleading: Show all scopes; Show everything in selected scope...
- Symmetry: set scope - close scope; but "show all" is less intuitive to undo set scope
- Internal consistency: "x" often used in Eclipse for close/unset/cancel
- External consistency: Google
- Shorter: icon instead of text
- Icon is faster to recognize than reading text

If you like, I could ask some technical writers what they prefer or I could start a poll in my blog.
Comment 15 Chris Goldthorpe CLA 2010-10-11 19:07:36 EDT
Patch which adds "show all" has been applied to HEAD
Comment 16 Chris Goldthorpe CLA 2010-10-11 19:09:48 EDT
(In reply to comment #14)

If you feel strongly about using an 'x' instead of close all please open a new bug and we can see what responses we get there.