Book Image

Mastering Eclipse Plug-in Development

By : Alex Blewitt, Bandlem Limited
Book Image

Mastering Eclipse Plug-in Development

By: Alex Blewitt, Bandlem Limited

Overview of this book

Table of Contents (18 chapters)
Mastering Eclipse Plug-in Development
Credits
About the Author
Acknowledgments
About the Reviewers
www.PacktPub.com
Preface
Free Chapter
1
Plugging in to JFace and the Common Navigator Framework
Index

Help pages in Eclipse


Eclipse help pages are XHTML documents that are indexed with Apache Lucene and served over a web server either externally or as part of an Eclipse-based runtime. The pages are written in XHTML and have a table of contents that aggregates them together in a view known as a table of contents (toc). The table of contents may be primary, in which case it shows up as a closed book icon in the help pages; otherwise, it is shown as an open book icon and plugged in elsewhere.

This chapter will use the plug-in com.packtpub.e4.advanced.doc to act as the placeholder for documentation. This can be created from the extension point wizard by clicking on Add... in the Extensions tab of the plugin.xml file and choosing the org.eclipse.help.toc extension point, along with sample help contents:

Adding help pages

Help pages are contributed through an extension point, which registers a table of contents that refers to individual help pages. The help pages are typically provided in a separate...