Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 332916

Summary:

[Help][Search] Topic associated with book should be queried

Product:

[Eclipse Project] Platform

Reporter:

Holger Voormann <eclipse>

Component:

User Assistance

Assignee:

Chris Goldthorpe <cgold>

Status:

CLOSED FIXED

QA Contact:

Severity:

normal

Priority:

CC:

cgold

Version:

3.6

Target Milestone:

3.7 M5

Hardware:

OS:

Windows XP

Whiteboard:

Attachments:

Description	Flags
Screenshot	none
Patch	none

Description Holger Voormann

2010-12-19 21:34:33 EST

A book (the topmost TOC item) can optional refer to a HTML file: (in toc.xml the "topic" attribute of the "toc" element refers to it: <toc label="..." topic="book_topic.html">). In Eclipse 3.6.0 and 3.7 M4 in contrast to older versions of Eclipse this book topic is not queried when performing a normal search. If a search scope is set which contains the book or if searching "selected topic (and all subtopics)" then the book topic is queried (expected behavior).

Steps to reproduce:
1. Install a documentation package which contains a topic associated with the book only (e.g. Cross-Link_Example.zip at http://sourceforge.net/projects/helpaddons/files/)
2. Open help: Help > Help Contents
3. Make sure that no scope is set
4. Enter a word of the book topic as query into the "Search:" field (e.g. if using Cross-Link_Example.zip: "cross-link")
5. Hit "Go"

Is: "Search Results" do not list the book topic
Should: "Search Results" should list the book topic

Comment 1 Chris Goldthorpe

2011-01-05 16:42:38 EST

I just tried this using N20110104-2000 and could not reproduce the problem. I imported both bundles from http://sourceforge.net/projects/helpaddons/files/, started Eclipse, opened Help/Contents and searched for "cross-link" with a scope of "All Topics". Topic A and Topic B both showed up as hits.

Comment 2 Holger Voormann

2011-01-05 21:38:16 EST

Created attachment 186140 [details]
Screenshot

(In reply to comment #1)
Did you use the normal search field at the top or the "Search topics" icon? With "Search (selected) topics" it works but the "normal" search (searching all books) does not. I reproduced this bug also with eclipse-SDK-N20110104-2000-win32 (Windows XP) and an empty workspace (see attached screenshot).

Comment 3 Pierre Candela

2011-01-06 13:34:54 EST

I can reproduce the problem in Eclipse 3.6 & 3.7 M4, but only if the search index is created (or updated) by the webapp.
If it's done by the help view, the "book topic" gets indexed and is returned if you run subsequent searches from the the help view or the webapp.

In Eclipse 3.4.2 & 3.5.2, the book topic was always indexed.

Comment 4 Chris Goldthorpe

2011-01-06 14:23:38 EST

I can now reproduce the problem following Pierre's directions. I don't exactly understand the circumstances under which it reproduces since another example bundle I created myself is still working fine but I should be able to investigate from here.

Comment 5 Chris Goldthorpe

2011-01-06 18:49:11 EST

Created attachment 186235 [details]
Patch

Comment 6 Chris Goldthorpe

2011-01-06 18:51:32 EST

Patch committed to HEAD, fixed in Eclipse 3.7. Do you need this backported for inclusion in 3.6.2 also?

Comment 7 Holger Voormann

2011-01-06 22:29:50 EST

(In reply to comment #6)

Thank you for fixing this bug!

> Do you need this backported for inclusion in 3.6.2 also?
>
Because the book topic page is optional and probably contains in most instances only a summary I can live with this bug in 3.6.x.

Comment 8 Holger Voormann

2011-01-12 07:17:08 EST

Verified in N20110109-2000.

Thanks again for fixing this issue. Good work. :-)