Jump to: navigation, search

FAQ How do I add help content to my plug-in?

Revision as of 15:30, 14 March 2006 by Claffra (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Help is added to Eclipse in the form of help books that appear in the online help system. Each help book is laid out in table-of-contents files (toc.xml) that specify the structure of each help book. These table-of-contents files are then registered with the platform, using the org.eclipse.help.toc extension point. The help content must be in the form of standard HTML files. Each major topic should be in a separate file so it can be referenced in the table of contents. Not surprisingly, excellent help content that describes how to integrate help into your plug-in is available, so we don’t need to go into further detail here.


See Also:

Go to Platform Plug-in Developer Guide > Programmer’s Guide > Plugging in help.


This FAQ was originally published in Official Eclipse 3.0 FAQs. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the Eclipse Public License v1.0.