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
(One intermediate revision by the same user not shown)
Line 4: Line 4:
 
Each plug-in that contributes help files shall extend the <tt>org.eclipse.help.toc</tt> extension point and create the TOC files that describe the table of contents for the help and the topic interleaving.
 
Each plug-in that contributes help files shall extend the <tt>org.eclipse.help.toc</tt> extension point and create the TOC files that describe the table of contents for the help and the topic interleaving.
  
 +
==== Creating the Help Plug-in ====
 
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.
 
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.
  
Line 13: Line 14:
  
 
[[Image:help_project_toc.png]]
 
[[Image:help_project_toc.png]]
 +
 +
==== Examining the Help Files ====
 +
[[Image:help_files.png | right]]
 +
Three .xml files have been created:
 +
# plugin.xml
 +
# testToc.xml
 +
# 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.
 +
 +
[[Image:help_plugin_file.png]]
 +
 +
[[Image:help_toc_primary_file.png]]
 +
 +
[[Image:help_toc_file.png]]
  
 
=== Option 1: Writing the Help Files ===
 
=== Option 1: Writing the Help Files ===

Revision as of 12:24, 23 August 2010

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.

Creating the Help Plug-in

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

Option 1: Writing the Help Files

Option 2: Generating the Help Files