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

Bug 321438

Summary: Workbench User Guide > Tasks > Accessing help > Searching help > Query Syntax - incorrect explanations of examples
Product: [Eclipse Project] Platform Reporter: John Franzini <JF.spam.address>
Component: User AssistanceAssignee: Hao Zhang <zhhaohh>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: cgold, zhhaohh
Version: 3.5   
Target Milestone: 3.7 M2   
Hardware: All   
OS: All   
Whiteboard:
Attachments:
Description Flags
Patch V1 none

Description John Franzini CLA 2010-07-31 17:05:57 EDT 
Build Identifier: Galileo and Helios

> Use double quotation marks around terms you want treated as a phrase. For example:
> 
> "creating projects"
> 
> returns topics that contain the entire phrase creating projects, and not creating or project on its own.

This explanation is incorrect.  "creating projects" without the double quotation marks will not return creating or projects on its own because there is an implied AND between all search terms as described in the first bullet of this section.

> Punctuation acts as term delimiters. For example:
> 
> plugin.xml
> 
> returns hits on topics that contain plugin.xml, plugin, and xml, which is likely broader than you want. If you want to find just those topics containing plugin.xml, use double quotes, as in:
> 
> "plugin.xml"

Same comment for this bullet.

Reproducible: Always
Comment 1 Chris Goldthorpe CLA 2010-08-23 15:10:26 EDT 
Vivian, can you make this change to the documentation?
Comment 2 Hao Zhang CLA 2010-08-23 21:59:04 EDT 
OK, Chris, I'll take it.
Comment 3 Hao Zhang CLA 2010-08-24 02:52:43 EDT 
Hi Chris,

1. For the 1st item,

> Use double quotation marks around terms you want treated as a phrase. For example:
> 
> "creating projects"
> 
> returns topics that contain the entire phrase creating projects, and not creating or project on its own.

I think it should be modified like this:

> Use double quotation marks around terms you want treated as a phrase. For example:
> 
> "creating projects"
> 
> returns topics that contain the entire phrase creating projects, not topics containing creating and project on its own.

2. For the 2nd item,
> Punctuation acts as term delimiters. For example:
> 
> plugin.xml
> 
> returns hits on topics that contain plugin.xml, plugin, and xml, which is likely broader than you want. If you want to find just those topics containing plugin.xml, use double quotes, as in:
> 
> "plugin.xml"

According to my understanding, it should be modified like this:

> Punctuation acts as term delimiters. For example:
> 
> plugin.xml
> 
> returns hits on topics that contain plugin and xml, which is likely broader than you want. If you want to find just those topics containing plugin.xml, use double quotes, as in:
> 
> "plugin.xml"

Do I have the right understanding of this issue, Chris, can you have a review on that? If it is ok, I'll make the changes to documentation.
Comment 4 Chris Goldthorpe CLA 2010-08-24 12:45:40 EDT 
Looks good but I would suggest that this wording would be more clear for the first change.

> returns topics that contain the entire phrase creating projects. Topics where the words creating and projects are not consecutive are not returned.
Comment 5 Hao Zhang CLA 2010-08-24 22:09:19 EDT 
Created attachment 177380 [details]
Patch V1

Patch
Comment 6 Hao Zhang CLA 2010-08-24 23:03:13 EDT 
Patch applied to HEAD, Fixed
Comment 7 Hao Zhang CLA 2010-08-24 23:04:58 EDT 
Patch applied to HEAD, Fixed