Difference between revisions of "FAQ How do I add documentation and help for my own language?"

From Eclipsepedia

Jump to: navigation, search
 
m
 
Line 1: Line 1:
Documentation for plug-ins, including those that implement a programming language is
+
Documentation for plug-ins, including those that implement a programming language is done by contributing to the <tt></tt>extension point. Open the plug-in Manifest Editor on your plug-in and switch to the Extensions page. Click on '''Add...''' and choose '''Extension Templates &gt; Help Contents''' (see Figure 19.8).
done by contributing to the <tt></tt>extension point.
+
Open the plug-in Manifest Editor on your plug-in and switch to the  
+
Extensions page. Click on '''Add...''' and choose  
+
'''Extension Templates &gt; Help Contents''' (see Figure 19.8).
+
  
 
&nbsp;&nbsp;&nbsp;&nbsp;<img src=../images/help-content.png>
 
&nbsp;&nbsp;&nbsp;&nbsp;<img src=../images/help-content.png>
 +
&nbsp;&nbsp;&nbsp;&nbsp;'''Figure 19.8'''&nbsp;&nbsp; Using the Manifest Editor
  
&nbsp;&nbsp;&nbsp;&nbsp;'''Figure 19.8'''&nbsp;&nbsp;
+
Click '''Next''' and provide details. Click '''OK'''.  Voila, your plug-in now has documentation exported in the standard Eclipse Help format, provided through '''Help &gt; Help Contents...'''.
Using the Manifest Editor
+
 
+
 
+
Click '''Next''' and provide details. Click '''OK'''.  Voila,  
+
your plug-in now has documentation exported in the  
+
standard Eclipse Help format, provided through '''Help &gt; Help Contents...'''.
+
  
 
== See Also: ==
 
== See Also: ==
 +
*[[FAQ How can I generate HTML and toc.xml files?]]
 +
*[[FAQ How do I support source-level debugging for my own language?]]
  
[[FAQ_How_can_I_generate_HTML_and_toc.xml_files%3F]]
+
{{Template:FAQ_Tagline}}
 
+
[[FAQ_How_do_I_support_source-level_debugging_for_my_own_language%3F]]
+
 
+
<hr><font size=-2>This FAQ was originally published in [http://www.eclipsefaq.org Official Eclipse 3.0 FAQs]. Copyright 2004, Pearson Education, Inc. All rights reserved. This text is made available here under the terms of the [http://www.eclipse.org/legal/epl-v10.html Eclipse Public License v1.0].</font>
+

Latest revision as of 01:16, 16 June 2006

Documentation for plug-ins, including those that implement a programming language is done by contributing to the extension point. Open the plug-in Manifest Editor on your plug-in and switch to the Extensions page. Click on Add... and choose Extension Templates > Help Contents (see Figure 19.8).

    <img src=../images/help-content.png>     Figure 19.8   Using the Manifest Editor

Click Next and provide details. Click OK. Voila, your plug-in now has documentation exported in the standard Eclipse Help format, provided through Help > Help Contents....

[edit] See Also:


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.