Eclipse icon

In the Providing Help lecture you learned how to integrate online documentation with the Eclipse online documentation. This example presents a sample set of XML and HTML files to demonstrate the set of files you will need to write for your integrated online documentation.

Running the Solution

Please verify that you have installed the code from the CD-ROM and have a project in your workspace named, com.ibm.soln.help. To run the example, launch the run-time instance of Eclipse (Run > Run As > Run-time Workbench).

  1. Select Help > Help Contents
  2. In the table of contents on the left, select SOLN: Eclipse Lab TOC. Notice that this entry is integrated along with the rest of the Eclipse online documentation. You can then select the various help topics under this heading to view sample help files.

Roadmap of the Solution

This example uses the help extension point org.eclipse.help.toc and requires no Java code. You can view the plugin.xml file and the various XML files to see how the table of contents, topics and sub-topics are linked together.

© Copyright International Business Machines Corporation, 2003.
All rights reserved.