Eclipse Community Forums: Platform - User Assistance (UA) » Context Help View

Help

Home

Home » Eclipse Projects » Platform - User Assistance (UA) » Context Help View - how is its content gathered ?

Show: Today's Messages :: Show Polls :: Message Navigator

Context Help View - how is its content gathered ? [message #474317]

Fri, 05 September 2008 09:38

Edoardo Comar

Messages: 102
Registered: July 2009

Senior Member

As developing a fully internationalized RCP,
I am still not 100% sure about what searches are performed to display
the links in the Help View (I mean the one that gets displayed when
pressing F1/CTRL-F1).

As I understand it, for example for a view XYZ:

1) the top part has the 'About XYZ' - and the link(s) is/are determined
statically by what I placed in the help context file.

2) the bottom part 'Dynamic Help' shows the results of a search query
tha in English is
"'XYZ view' OR 'ZYX Perspective'" for Eclipse 3.3
but it is just
"'XYZ view''" for Eclipse 3.4

the search string is fully nationalized, it would become "Vue
XYZ_in_French" if starting eclipse with -nl fr.

Final doubt: the string searched for must appear in the body of the html
pages as the help indexer ignores meta tags in the <head> of the document.

can a subject expert please confirm/correct me :-)
thanks :-)

Edoardo

Report message to a moderator

Re: Context Help View - how is its content gathered ? [message #474320 is a reply to message #474317]

Fri, 05 September 2008 16:47

Chris Goldthorpe

Messages: 815
Registered: July 2009

Senior Member

There was indeed a change between Eclipse 3.3 and 3.4 in the way the
search string is constructed and we now no longer use the perspective as
a search term since it usually contributed low value results which
reduced the quality of the result set. If you specify a title in your
context it will use that title as the search term, otherwise it will try
to determine the name of the view/dialog etc. Which meta tags were you
hoping to search? You are correct in that they are ignored when building
the search index except that "description" will override the title of
the search result.

Edoardo Comar wrote:
> As developing a fully internationalized RCP,
> I am still not 100% sure about what searches are performed to display
> the links in the Help View (I mean the one that gets displayed when
> pressing F1/CTRL-F1).
>
> As I understand it, for example for a view XYZ:
>
> 1) the top part has the 'About XYZ' - and the link(s) is/are determined
> statically by what I placed in the help context file.
>
> 2) the bottom part 'Dynamic Help' shows the results of a search query
> tha in English is
> "'XYZ view' OR 'ZYX Perspective'" for Eclipse 3.3
> but it is just
> "'XYZ view''" for Eclipse 3.4
>
> the search string is fully nationalized, it would become "Vue
> XYZ_in_French" if starting eclipse with -nl fr.
>
> Final doubt: the string searched for must appear in the body of the html
> pages as the help indexer ignores meta tags in the <head> of the document.
>
>
> can a subject expert please confirm/correct me :-)
> thanks :-)
>
> Edoardo

Report message to a moderator

Re: Context Help View - how is its content gathered ? [message #474323 is a reply to message #474320]

Mon, 08 September 2008 10:56

Edoardo Comar

Messages: 102
Registered: July 2009

Senior Member

Thanks Chris
I've shown your reply to my doc people - encouraging them to post here
:-) and this will help them!

Chris Goldthorpe wrote:
> There was indeed a change between Eclipse 3.3 and 3.4 in the way the
> search string is constructed and we now no longer use the perspective as
> a search term since it usually contributed low value results which
> reduced the quality of the result set. If you specify a title in your
> context it will use that title as the search term, otherwise it will try
> to determine the name of the view/dialog etc. Which meta tags were you
> hoping to search? You are correct in that they are ignored when building
> the search index except that "description" will override the title of
> the search result.
>
> Edoardo Comar wrote:
>> As developing a fully internationalized RCP,
>> I am still not 100% sure about what searches are performed to display
>> the links in the Help View (I mean the one that gets displayed when
>> pressing F1/CTRL-F1).
>>
>> As I understand it, for example for a view XYZ:
>>
>> 1) the top part has the 'About XYZ' - and the link(s) is/are
>> determined statically by what I placed in the help context file.
>>
>> 2) the bottom part 'Dynamic Help' shows the results of a search query
>> tha in English is
>> "'XYZ view' OR 'ZYX Perspective'" for Eclipse 3.3
>> but it is just
>> "'XYZ view''" for Eclipse 3.4
>>
>> the search string is fully nationalized, it would become "Vue
>> XYZ_in_French" if starting eclipse with -nl fr.
>>
>> Final doubt: the string searched for must appear in the body of the
>> html pages as the help indexer ignores meta tags in the <head> of the
>> document.
>>
>>
>> can a subject expert please confirm/correct me :-)
>> thanks :-)
>>
>> Edoardo

Report message to a moderator