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 1: Line 1:
 
{{Navigation|Previous= [['''FIXME'''|Extending the Proof Obligation Generator]]|Next=[['''FIXME'''|Extending the structured editor]] | Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]]}}
 
{{Navigation|Previous= [['''FIXME'''|Extending the Proof Obligation Generator]]|Next=[['''FIXME'''|Extending the structured editor]] | Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]]}}
  
 +
=== Providing Help Contents ===
 +
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.
  
 +
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.
  
=== Extending the Extension Point ===
+
[[Image:help_project.png]]
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.
+
 
 +
Then, the easiest way to proceed for beginners is to start from the available template:
 +
 
 +
[[Image:help_project_template.png]]
 +
 
 +
[[Image:help_project_toc.png]]
  
 
=== Option 1: Writing the Help Files ===
 
=== Option 1: Writing the Help Files ===

Revision as of 10:03, 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.

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