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

Bug 95339

Summary: Help search returns obviously incomplete results
Product: [Eclipse Project] Platform Reporter: Maxime Daniel <maxime_daniel>
Component: User AssistanceAssignee: Platform-Help-Inbox <platform-help-inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P2 CC: sonia_dimitrov
Version: 3.1   
Target Milestone: 3.1 RC1   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Attachments:
Description Flags
Query 'export' finds 'Importing and Exporting Preferences'
none
Query 'Exporting Preferences' does not find 'Importing and Exporting Preferences' none

Description Maxime Daniel CLA 2005-05-16 04:30:17 EDT
See attached screen captures. The problem here is that the 'export" query
successfully returns an item 'Importing and Exporting Preferences' that should,
I believe, be returned by the query 'Exporting Preferences' but is not.
Test made against M7.
Comment 1 Maxime Daniel CLA 2005-05-16 04:33:38 EDT
Created attachment 21194 [details]
Query 'export' finds 'Importing and Exporting Preferences'
Comment 2 Maxime Daniel CLA 2005-05-16 04:35:00 EDT
Created attachment 21195 [details]
Query 'Exporting Preferences' does not find 'Importing and Exporting Preferences'

Note: using 'exporting preferences' yields the same results.
Comment 3 Konrad Kolosowski CLA 2005-05-16 10:14:59 EDT
Confirmed the problem.  It problem appears when running Eclipse in languages 
other than English and no translated documentation present.

The cause is using different analyzer to analyze text during indexing and 
during search.  The prebuilt index was created using stemming English analyzer 
and indexed token "export" for word "exporting".  When this prebuilt index is 
used on another locale, a different analyzer will return token "exporting" 
during search and it will not match anything in the index.

Providing French documentation with prebuilt index would give correct results, 
but we need to do something for case of searching just default documentation 
on non default language.
Comment 4 Konrad Kolosowski CLA 2005-05-16 17:31:47 EDT
There is no such thing as default index.  We create an index for default - 
English documentation and place it at the root of plug-in, at which point it 
is not known that English analyzer was used to create the index.  In the index 
we store and ID of the analyzer used to create the index but the ID was the 
same for all analyzers that help was providing.

I have released a fix to the AnalyzerDescriptor class in org.eclipse.help.base 
plug-in, to keep locale as part of analyzer ID.

The result will be that prebuilt index contains locale information.  All users 
running Eclipse on English locales will have prebuilt index used.  Non English 
users will have default prebuilt index ignored because the locale of the 
analyzer will not match, and they will only use prebuilt index from a fragment.

Sonia,
Since the change affects ID in the prebuilt index, the releng build will need 
to pick the fix.  Without the fix, not even English users will see benefit of 
prebuilt index in out of the box Eclipse.  How can I provide you with the 
updated help.base plug-ins?  I can backport the change to 3.1M7.
Comment 5 Sonia Dimitrov CLA 2005-05-16 18:00:21 EDT
I would like to run with a version that works in 3.1M7.  If the version in 
HEAD works, I will check it out and build in my workspace.  Alternately, you 
can attach a plug-in jar (if small enough) here.
Comment 6 Konrad Kolosowski CLA 2005-05-16 18:13:15 EDT
org.eclipse.help.base compiles against M7, but has some other changes 
dependent on by org.eclipse.help.ui.

Please check out org.eclipse.help.base v200050509_fix95339.  It is pure M7 
plus that fix.
Comment 7 Sonia Dimitrov CLA 2005-05-16 18:17:09 EDT
Thanks Konrad.   Please be aware that I will not be able to move to M7 until 
Wassim has investigated/knows how to fix 
https://bugs.eclipse.org/bugs/show_bug.cgi?id=95418.  I intend to move to M7 
early this week.
Comment 8 Konrad Kolosowski CLA 2005-05-16 18:20:01 EDT
No problem.  Everything still compiles, just that prebuilt indexes will be 
ignored for a few days, until prebuilt index IDs will match that help expects.
Comment 9 Konrad Kolosowski CLA 2005-05-26 15:14:03 EDT
Thansk Sonia.  Marking as fixed.