| Summary: | Searching in help does not work | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Riccardo Mising name <riccardo.nimser> | ||||||
| Component: | User Assistance | Assignee: | platform-ua-inbox <platform-ua-inbox> | ||||||
| Status: | CLOSED WONTFIX | QA Contact: | |||||||
| Severity: | major | ||||||||
| Priority: | P3 | CC: | cgold, remy.suen | ||||||
| Version: | 3.7.1 | ||||||||
| Target Milestone: | --- | ||||||||
| Hardware: | PC | ||||||||
| OS: | Windows XP | ||||||||
| Whiteboard: | stalebug | ||||||||
| Attachments: |
|
||||||||
Created attachment 205330 [details]
Bundles to reproduce the broken search
Created attachment 205331 [details]
The unexpected result of a seach
I can see the problem which is rooted in org.eclipse.help.internal.search.IndexingOperation.getAddedDocuments(SearchIndex).
The help system tracks the bundle versions of all bundles containing documentation and updates the search index only for those bundles that were not already in the index or whose bundle version has changed.
The problem is that the help system is assuming that documents only reside in bundles containing the org.eclipse.help extension point, or one of a handful of other extension points that indicate searchable content.
One workaround would be to add an empty toc entry to bundleA as follows.
<extension
point="org.eclipse.help.toc">
</extension>
Hallo Chris, thanks for the workaround. It works so far even if it is not a beautiful solution. I hope the bug will be fixed since the help system knows about the documents because they are in the toc which is contributed by my toc provider. Would the usage of a search participant also work instead of the empty toc entry? If yes, what is the better option in your opinion? I also got another question related to the search index. Is the index rebuilded, if my toc provider notifies the platform (via contentChanged) that the content has changed or is there another way to force the rebulding of the index? Currently I don't have a more long term fix scheduled as the UA team is short on resources right now. The only ways to force an update of the index are to increment the bundle version or to delete the help index from the configuration area, with a path of eclipse\configuration\org.eclipse.help.base. This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. -- The automated Eclipse Genie. |
Build Identifier: M20110909-1335 If a toc provider is used to build a toc dynamically with topics that reffer to xhtml content provided in the same plugin as well as xhtml content provided in other plugins the search does not find all matches for a given query. A simple example looks as follows: - bundleA with bundleA.xhtml - bundleB with bundleB.xhtml - bundelB also provides the toc provider, which is registerd via the extension point org.eclipse.help.toc The href to the content is allways /bundleId/path/to/content (eg. /bundleA/bundleA.xhtml and /bundleB/bundleB.xhtml). The toc and the content for both bundels is displayed correctly when the topics are clicked. The problem is, that only matches in bundelB are found, which is the bundel that also defines the toc provider, if you try to search the help. Reproducible: Always Steps to Reproduce: Use the attached bundles to reproduce the broken search. For the term "topic" booth topics ("Topic A" and "Topic B") should be found, but actually only for "Topic B" a match is displayed.