Bug 364324 - [Help][Search] Model result categories ordering after TOC ordering
Summary: [Help][Search] Model result categories ordering after TOC ordering
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.7.1   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 4.5 M6   Edit
Assignee: Holger Voormann CLA
QA Contact:
URL:
Whiteboard:
Keywords: greatfix
Depends on:
Blocks:
 
Reported: 2011-11-21 08:28 EST by Holger Voormann CLA
Modified: 2015-02-26 16:02 EST (History)
1 user (show)

See Also:


Attachments
Proposed patch: use ProductPreferences.getTocOrder() to sort search result categories (3.76 KB, patch)
2011-11-21 13:08 EST, Holger Voormann CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Holger Voormann CLA 2011-11-21 08:28:46 EST
By default the search result categories are on a par with the top-level books (TOCs), but the order of the TOCs and the order of the result categories can differ. In the "Content" tab the TOC order can be configured (via HELP_DATA), in contrast in the "Search Results" tab the result categories are always alphabetically ordered.

This feature request is about modeling search result categories ordering after TOC ordering because this is what the user expects.

Example:
Searching for "What's New" -> Search Results tab: <http://help.eclipse.org/indigo/advanced/searchView.jsp?searchWord=What%27s%20New&showSearchCategories=true&scope=All%20topics>
"Workbench User Guide" containing "Eclipse Platform What's New in 3.7" should be at the top (like in the "Content" tab) but is somewhere at the middle/bottom.
Comment 1 Holger Voormann CLA 2011-11-21 13:08:10 EST
Created attachment 207322 [details]
Proposed patch: use ProductPreferences.getTocOrder() to sort search result categories
Comment 2 Holger Voormann CLA 2012-04-12 03:57:03 EDT
Any chance to get this in 3.8/4.2? Anything more I should supply?
Comment 3 Holger Voormann CLA 2014-02-07 08:24:04 EST
Gerrit patch set: https://git.eclipse.org/r/21670

Problem:
By default the search result categories are on a par with the top-level books (TOCs), but the order of the TOCs and the order of the result categories can differ. For example, if you search for "subsystem" (http://eclip.se/1r) and "Show result categories" is enabled, then the category "Workbench User Guide" is shown in the search result list at the bottom, in contrast to the table of contents where the "Workbench User Guide" book is shown at the top. From the user perspective this is confusing.

Caused by:
Both the books in the Contents tab and the categories in the Search Results tab are by default alphabetically ordered. The table of content book order can be changed via the Help Data file (see http://eclip.se/1s), for instance in the Eclipse IDE the "Workbench User Guide" is shown at the top. In contrast, the search results category order cannot be changed.

Solution:
The search results category order should follow the table of content book order.
Comment 4 Lars Vogel CLA 2015-01-30 11:19:41 EST
Thanks Holger for the Gerrit review, looks like I should try to start monitoring ua also for patches (not sure if I will find the time). 

I try to review during M6.
Comment 5 Eclipse Genie CLA 2015-02-09 08:40:42 EST
New Gerrit change created: https://git.eclipse.org/r/41365
Comment 7 Lars Vogel CLA 2015-02-26 16:02:36 EST
Sorry Holger for the long delay in review, eclipse.ua is unfortunately not my area of expertise. But this valuable contribution was long enough in our queue.

It looks good to me, so I merge it so that more people can test it. AFAIK we do not have an expert in help anymore active in the team so I commit this hoping not to break anything.

Thanks a bunch for the contribution and sorry again for the delay in the review.