|
2
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
2 |
|
|
|
3 |
<html>
|
|
|
4 |
<head>
|
|
|
5 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
6 |
<title>Adding Plug-in Help</title>
|
|
|
7 |
<style>
|
|
|
8 |
<!--
|
|
|
9 |
span.attr
|
|
|
10 |
{color:green}
|
|
|
11 |
-->
|
|
|
12 |
</style>
|
|
|
13 |
<link rel="StyleSheet" href="../../book.css" type="text/css"/>
|
|
|
14 |
</head>
|
|
|
15 |
|
|
|
16 |
<body>
|
|
|
17 |
<h2>Adding Plug-in Help</h2>
|
|
|
18 |
|
|
|
19 |
<p>If you are creating a plug-in specifically for use with Carbide.c++ we recommend that
|
|
|
20 |
any menu items you create be added to existing Eclipse menus or to the <b>Carbide</b> menu. The topics in this section include:</p>
|
|
|
21 |
<ul>
|
|
|
22 |
<li><a href="#help_assist">Carbide Help Assistance</a></li>
|
|
|
23 |
<li><a href="#help_toc">Carbide Table of Contents Anchors</a></li>
|
|
|
24 |
<li><a href="#help_css">Carbibe CSS</a></li>
|
|
|
25 |
<li><a href="#help_f1">Carbide F1 Help</a></li>
|
|
|
26 |
<li><a href="#help_cheatsheets">Carbide Cheatsheets</a> </li>
|
|
|
27 |
</ul>
|
|
|
28 |
<h3><a name="help_assist"></a>Carbide Help Assistance </h3>
|
|
|
29 |
<p>It is highly recommended that every plug-in that adds itself to the Carbide menu include help content. Except for highly unusual cases you can include the help content (html, xml, images, etc.) directly in the plug-in itself. This means that users only have a single plugin to install and the help comes along with it. In the event that your plugin involves several related plugins, as say, UI Designer does, then a separate help plugin may be the better solution. </p>
|
|
|
30 |
<h3><a name="help_toc" id="help_toc"></a>Carbide Table of Content Anchors</h3>
|
|
|
31 |
<p>All plug-in tools that add themselves to the Carbide menu should install their help to the <span class="code">anchorCarbideMisc</span> anchor point using the <span class="code">link_to</span> command. This will correctly place the help content for the plug-in within the Carbide Help section of the Help window. </p>
|
|
|
32 |
<p class="note"><b>NOTE</b> All other help content anchors are reserved for use by the Carbide team.</p>
|
|
|
33 |
<p>In the manuals main TOC file, for the <span class="code"><toc></span> keyword, add the command:</p>
|
|
|
34 |
<p class="listing">link_to="../com.nokia.carbide.help.common/carbideHelpTOC.xml#anchorCarbideMisc"</p>
|
|
|
35 |
<p>The complete line might look something like this: </p>
|
|
|
36 |
<p class="listing"><toc label="Carbide.c++ Plug-in Developer Guide" link_to="../com.nokia.carbide.help.common/carbideHelpTOC.xml#anchorCarbideMisc" ></p>
|
|
|
37 |
<p>See the Eclipse documentation <b>Platform Plug-in Developer Guide > Programmer's Guide > User assistance support > Help > </b><b>Help content</b> for more information on content assist help. </p>
|
|
|
38 |
<h3><a name="help_css" id="help_css"></a>Carbide CSS </h3>
|
|
|
39 |
<p>To enable your manual to match the style used by the Carbide documentation, use the <span class="code">book.css</span> file as your style sheet. We recommend that you access the copy in the <span class="code">com.nokia.carbide.cpp.ui</span> plug-in to ensure you are always using the latest version. In the <span class="code"><head></span> section of your HTML files, use the following line: </p>
|
|
|
40 |
<p class="listing"><link rel="StyleSheet" href="../book.css" type="text/css" /></p>
|
|
|
41 |
<p>If that is not possible, feel free to add a copy to your plug-in and call it from there. </p>
|
|
|
42 |
<h3><a name="help_f1" id="help_f1"></a>Carbide F1 Help </h3>
|
|
|
43 |
<p>Your help content can also include F1 help using the Eclipse help system. All you need is the help menu ID of the window or view you want to attach F1 help to, an XML file containing the links to the help content, and the correct extension point additions to the plugin's <span class="code">plugin.xml</span> file. </p>
|
|
|
44 |
<h5>Help Menu IDs</h5>
|
|
|
45 |
<p>Right now, the best way to get the help menu IDs for a specific Carbide view or wizard is to examine the xml files inside the <span class="code">html/context_help</span> directory of official Carbide manuals.</p>
|
|
|
46 |
<h5>Context Help XML Files</h5>
|
|
|
47 |
<p>Every context help XML file in the various Carbide.c++ manuals contain the F1 help for a specific plugin. The XML file name identifies the specific Carbide plugin that help is associated with and all the help menu IDs you can use. </p>
|
|
|
48 |
<h5>Plugin.xml Extensions</h5>
|
|
|
49 |
<p>To add your context help to the F1 help simply add the reference to your context help xml file to the extension point "<span class="code">org.eclipse.help.contexts</span>" as shown below: </p>
|
|
|
50 |
<p class="listing"> <extension point="org.eclipse.help.contexts" ><br>
|
|
|
51 |
<!-- CARBIDE DEBUG UI HELP (BRKPT, VAR, EXPR, etc) --><br>
|
|
|
52 |
<contexts file="html/context_help/org_eclipse_debug_ui.xml"<br>
|
|
|
53 |
plugin="org.eclipse.debug.ui" /><br>
|
|
|
54 |
</extension></p>
|
|
|
55 |
<p>See the Eclipse documentation <b>Platform Plug-in Developer Guide > Programmer's Guide > User assistance support > Help > Context sensitive help</b> for more information on content assist help. </p>
|
|
|
56 |
<h3><a name="help_cheatsheets" id="help_cheatsheets"></a>Carbide Cheatsheets </h3>
|
|
|
57 |
<p>Use the cheatsheet extension point to add any cheatsheet content to the cheatsheet list. Cheatsheets should be limited to very complex or long tasks. It is really not recommended for small tasks that a few tutorial steps can satisfy. </p>
|
|
|
58 |
<p>Currently, the categories you can link to when adding your cheatsheet include:</p>
|
|
|
59 |
<ul>
|
|
|
60 |
<li><b>IDE</b>: <span class="code"><category
|
|
|
61 |
id="com.nokia.carbide.ide.cheatsheets"></span></li>
|
|
|
62 |
<li><b>TRK</b>: <span class="code"><category id="com.nokia.carbide.trk.cheatsheets" ></span></li>
|
|
|
63 |
<li><b>Tools</b>: <span class="code"><category id="com.nokia.carbide.cpp.tools.cheatsheets" > </span></li>
|
|
|
64 |
</ul>
|
|
|
65 |
<p>See the Eclipse documentation <b>Platform Plug-in Developer Guide > Programmer's Guide > User assistance support > Cheat sheets </b> for more information on cheatsheets. </p>
|
|
|
66 |
<div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
|
|
|
67 |
</div></body>
|
|
|
68 |
</html> |