Bug 820 - Welcome: Workbench User Guide does not show anything by default (1GEUWHF)
Summary: Welcome: Workbench User Guide does not show anything by default (1GEUWHF)
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 2.0   Edit
Hardware: All Windows 2000
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Dorian Birsan CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2001-10-10 21:48 EDT by Nick Edgar CLA
Modified: 2002-04-16 10:02 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Nick Edgar CLA 2001-10-10 21:48:26 EDT
- from Welcome view, hit Workbench User Guide
- it comes up, but nothing interesting is shown
- likewise for Java Development User Guide

NOTES:
	RG (6/5/01 2:51:27 PM)
	The current help api does not allow us to request anything finer than an info set.
	We have requested better api.

	KH (9/19/2001 2:30:17 PM)
		Pls adise when/if better API is available.
Comment 1 DJ Houghton CLA 2001-10-24 06:26:01 EDT
PRODUCT VERSION:
118

Comment 2 Dorian Birsan CLA 2002-04-16 10:02:22 EDT
As of next nightly build (20020417) there should be support for a <toc> (like 
the Workbench User Guide) to have an optional  attribute "topic" that is the 
location of the description topic for the TOC.

<toc label="Workbench User Guide" topic="path/to/descriptionTopic.html">
   ....
</toc>

There is also (in the current builds) support for opening a TOC to a specific 
topic

IHelp.displayHelpResource("toc=/pluginid/toc.xml&topic=/pluginid/topic.html")

Preferably, you would just use the first option, i.e. make sure the TOC has a 
topic attribute and just call IHelp.displayHelpResource("/pluginid/toc.xml"), 
where toc.xml is the help contribution file for the desired TOC.
For Workbench User Guide this will be:

displayHelpResource("/org.eclipse.platform.doc.user/toc.xml")

and toc.xml would be 
....
<toc label="Workbench User Guide" topic="define/some/topic/here.html">
	<topic label="Getting Started">
		<link toc="topics_GettingStarted.xml" />
	</topic>
.....
</toc>