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

Bug 351272

Summary: [Help][Index] Keyword Index: Blank line after parent nodes that link a help page
Product: [Eclipse Project] Platform Reporter: Andreas eißner <nospam>
Component: User AssistanceAssignee: Chris Goldthorpe <cgold>
Status: VERIFIED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: cgold, ChrisAustin
Version: 3.7Flags: cgold: review+
ChrisAustin: review+
Target Milestone: 3.7.1   
Hardware: All   
OS: All   
Whiteboard:
Attachments:
Description Flags
Patch that fixes the described bug by modifiying the method IndexPart.getChildren(IIndexEntry) cgold: iplog+

Description Andreas eißner CLA 2011-07-06 03:30:59 EDT
Build Identifier: 20110615-0604

The keyword index (extension point "org.eclipse.help.index") has problems how links in parent nodes of the keyword tree are displayed.

There is inserted after each parent node that links a help page a blank line that also links the defined help page.

For example, a keyword index defined as follows in the index.html:

<index>
    <entry keyword="topic_1">
        <topic href="doc/topic1.html"/>
        <entry keyword="topic_1_1">
            <topic href="doc/topic_1_1.html"/>
        </entry>
        <entry keyword="topic_1_2">
            <topic href="doc/topic_1_2.html"/>
        </entry>
    </entry>
    <entry keyword="topic_2">
        <entry keyword="topic_2_1">
            <topic href="doc/topic_2_1.html"/>
        </entry>
    </entry>
</index>

.. will be shown in the Help View this way:

topic_1 (links to "doc/topic1.html")
    <blank line> (links to "doc/topic1.html" as well)
    topic_1_1 (links to "doc/topic1_1.html")
    topic_1_2 (links to "doc/topic1_1.html")
topic_2 (mouse click opens/closes underlying tree structure)
    topic_2_1 (links to "doc/topic2_1.html")


Reproducible: Always
Comment 1 Andreas eißner CLA 2011-07-06 08:06:26 EDT
Created attachment 199181 [details]
Patch that fixes the described bug by modifiying the method IndexPart.getChildren(IIndexEntry)

Added patch for project "org.eclipse.help.ui" that modifies the method IndexPart.getChildren(IIndexEntry).
Comment 2 Chris Goldthorpe CLA 2011-07-06 18:35:22 EDT
I can see the problem, I need to review your patch but at first glance it looks good.
Comment 3 Chris Goldthorpe CLA 2011-08-16 13:00:24 EDT
Patch committed to HEAD.
Comment 4 Chris Goldthorpe CLA 2011-08-17 12:28:17 EDT
Chris A, can you review this one also?
Comment 5 Chris Goldthorpe CLA 2011-08-17 16:20:00 EDT
Patch committed to 3.7 maintenance stream, Fixed
Comment 6 Chris Goldthorpe CLA 2011-08-24 16:55:49 EDT
Verified in M20110824-0800