Example - Help

Introduction

This example illustrates the use of the help system online documentation.
 

Running the example

To run the Help Example, pull down the Perspective menu, select the Other... menu item.  Select the Help Perspective from the list.  In the Help Perspective, select the Help System Example from the combo box.  Expand the books to reveal help topics.  Click on the various help topics to display the help content.
 

Details

The Help Example illustrates the following tasks that need to be done in order to create a simple, proper help contribution:
           - using the help contribution extension point
           - help documentation in doc.zip
           - defining an infoset with one view
           - defining top level topics (aka infotypes: tasks, concepts, references)
           - defining the navigation structure for help documents
           - strings externalized in doc.properties
           - defining the wiring actions to insert topics to specific infotypes

The name of the plugin directory that contains the help examples is org.eclipse.help.examples.ex1.

See the documentation for the org.eclipse.help.contributions extension point for more detail on how to contribute help content.

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.