| [news.eclipse.platform.rcp] Re: Need help with the eclipse standalone help |
Hi Lee Anne,
Thanks for all... u are my hero ;) Your suggestion #2 sounds good. I try it
Jenny
Lee Anne wrote:
Hi Jenny,
Thanks for explaining more. In this case that you described:
a. You put the same href in two different toc files.
b. The help window shows the right page and opens the tree at the right position.
c. The HTML path that's in the top of the HTML is wrong.
Do you mean that the HTML path is not showing the right order of titles for one of the hrefs, while it does show the right order for the other?
That HTML path is sometimes called a "bread crumb trail" or "bread crumbs". It was added in 3.3 under this Bugzilla entry:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=166391
If you read comment #7 and comment #8 at that Bugzilla URL, you'll see metioned "non-unique hrefs". That is the situation that you have: two hrefs that are not unique.
In comment #8, it states that the Eclipse team recommends avoiding that type of duplication in the table of contents, because it leads to this problem with the bread crumbs and trying to fix it in the code seems to be extremely difficult to do:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=166391#c8
Two suggestions to work around this situation are:
1. If you think your users won't care about the bread crumbs (HTML path) in the help page, you can disable them. In Eclipse 3.4, there is a help preference to disable them from appearing.
2. If you want to keep the bread crumb path, the suggestion in comment #8 is to use the "include" capability of the help system, and have something like a wrapper topic file for the second, unique, href, and then include the text from the first topic file into the second file.
With suggestion 2, you'd have an extra HTML file for the second instance of the topic, but you wouldn't have to duplicate all of the text. That file would use the <include> mechanism to get the text from the first file.
Includes are described in this page of the Eclipse help system:
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm
Best regards, Lee Anne