Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 317613 - toc.xml: when there is a link_to= it ignores the topic=
Summary: toc.xml: when there is a link_to= it ignores the topic=
Status: RESOLVED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.6   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 normal (vote)
Target Milestone: 4.0   Edit
Assignee: platform-ua-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-22 12:14 EDT by Beth Tibbitts CLA
Modified: 2010-07-01 13:15 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Beth Tibbitts CLA 2010-06-22 12:14:15 EDT
if a toc.xml specifies a link_to attribute, meaning that this toc whould be listed under a higher level toc from another plugin, it then ignores the toc= attribute which specifies the html file that should be shown for this topic.

Version: 3.6.0
Build id: I20100603-1500

For example,

<toc label="Parallel Language Development Tools (PLDT)"  topic="html/toc.html">
   <topic href="html/overview.html" label="Overview"/>
    ...etc
</toc>

The above points to html/toc.html when you select the PLDT title in the TOC on the left side of info center.

If you change it to 
<toc label="Parallel Language Development Tools (PLDT)" link_to="../org.eclipse.ptp.help/toc.xml#ptpPLDT" topic="html/toc.html">
   <topic href="html/overview.html" label="Overview"/>
   ...etc
</toc>

Then the default toc file is generated and the html/toc.html file is bypassed.

I like the link_to because it allows us to consolidate all our help topics, from disparate plug-ins (some of which are optionally installed) under a single heading in the toc navigation on the left side.
Comment 1 Chris Goldthorpe CLA 2010-07-01 13:15:23 EDT
The way link_to works is to add all of the children of the toc as children of the target anchor. In the process if the toc has a topic attribute that will get lost because only the children are moved to the anchor and multiple tocs can be linked to the same anchor.

I don't see how it would be possible to get the behavior you are requesting without creating an additional topic in the tree, and making the children appear one level deeper, this would be undesirable for existing toc files which were written based on the current behavior.


Because I believe it is not possible to fix this without negatively impacting existing documentation there is no plan to fix this.