Providing help for your plug-in (How to extend Rodin Tutorial)

From Event-B
Revision as of 10:03, 23 August 2010 by imported>Pascal (→‎Providing help contents)
Jump to navigationJump to search

Providing Help Contents

Each plug-in that contributes help files shall extend the org.eclipse.help.toc extension point and create the TOC files that describe the table of contents for the help and the topic interleaving.

Let's first create such a plug-in. It will only contain documentation files, and the "Create Java Project" option (tag 1) do not need to be checked.

Help project.png

Then, the easiest way to proceed for beginners is to start from the available template:

Help project template.png

Help project toc.png

Option 1: Writing the Help Files

Option 2: Generating the Help Files