Difference between revisions of "Providing help for your plug-in (How to extend Rodin Tutorial)"

From Event-B
Jump to navigationJump to search
imported>Pascal
imported>Pascal
Line 32: Line 32:
  
 
=== Viewing the Help Contents ===
 
=== Viewing the Help Contents ===
Launch the Rodin platform and select Help > Help Contents. We can see that a new Test TOC item has been created.
+
Launch the Rodin platform and select Help > Help Contents to view the available Eclipse Help contents. We can see that a new Test TOC item has been created.
  
 
[[Image:help_contents.png]]
 
[[Image:help_contents.png]]

Revision as of 13:42, 23 August 2010

Creating the Help Plug-in

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

Examining the Help Files

Help files.png

Three .xml files have been created:

  1. plugin.xml
  2. testToc.xml
  3. toc.xml

When opening the plugin.xml file, we can see that the testToc.xml file is a primary file, i.e. it contains the master table of contents; toc.xml is not primary, but is integrated into this table of contents.

Help plugin file.png

Help toc primary file.png

Help toc file.png

The contents is provided as .html files and linked from the tables of contents.

Viewing the Help Contents

Launch the Rodin platform and select Help > Help Contents to view the available Eclipse Help contents. We can see that a new Test TOC item has been created.

Help contents.png

Writing the Help Contents

Filling Manually the Help Contents

Generating the Help Contents