Chapter 27. Help

Another way of reducing the cost of service for your plug-ins is to provide on-line help. In Eclipse, help contents are structured as extensions to the help extension point. In this chapter we'll see how to

  • Add our own help contents

  • Link to our help contents from the user interface (context sensitive help)

There are several places we might want to integrate our help:

  • Stand-alone help

  • An “infopop” on the ResultView and the TestReportView

  • The auto-test property page

  • The run test action

Top-Level Help

All of the help contents in Eclipse follow the Contribution Rule. Every plug-in has the opportunity to contribute help. The help window is the only place you can see all the help together.

The basic unit of help is the table of contents, or toc. ...

Get Contributing to Eclipse: Principles, Patterns, and Plug-Ins now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial