| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML> |
| <HEAD> |
| |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
| |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> |
| <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> |
| |
| <LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css"> |
| <TITLE>Plugging in help |
| </TITLE> |
| |
| <link rel="stylesheet" type="text/css" HREF="../book.css"> |
| </HEAD> |
| <BODY BGCOLOR="#ffffff"> |
| |
| <h2>Plugging in help</h2> |
| <P > |
| The Eclipse platform's help facilities provide you with the raw building blocks to structure and contribute |
| documentation to the platform. It does not dictate structure or granularity of documentation. |
| You can choose the tools and structure for your documentation that suits your |
| needs. The help plug-in allows you to describe your documentation |
| structure to the platform using a table of contents (toc) file.</P> |
| <P >Your plug-in's online help is contributed using the <a href="../reference/extension-points/org_eclipse_help_toc.html"> <b> org.eclipse.help.toc</b></a> extension point. You can either contribute the online help as part of your code plug-in or provide it separately in its own documentation plug-in.</P> |
| <P > |
| Separating the documentation into a separate plug-in is beneficial in those situations where the code and documentation teams are different groups or where you want to reduce the coupling between the documentation and code. </P> |
| <P > |
| Advanced features of the help system include context-sensitive help with |
| reference links and the ability to invoke platform |
| code from the documentation. A help browser lets you view, print, and |
| search your documentation. Since 3.1, the new Help view adds dynamic help and |
| federated information search capability.</P> |
| <P > |
| The best way to demonstrate the contribution of help is to create a |
| documentation plug-in.</P> |
| |
| </BODY> |
| </HTML> |
