--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/background.htm Wed Mar 25 11:55:19 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/background.htm Fri Mar 27 10:36:17 2009 -0500
@@ -12,7 +12,7 @@
<p>Carbide.c++ is built on the <a href="http://www.eclipse.org">Eclipse</a> platform. The Eclipse components used are:</p>
<ul>
<li>Eclipse 3.4</li>
-<li>A slightly modified version of CDT 5.0.0</li>
+<li>A slightly modified version of CDT 5.0.1</li>
<li>EMF 2.4.1</li>
<li>GEF 3.4.1</li>
</ul>
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/env_setup.htm Wed Mar 25 11:55:19 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/env_setup.htm Fri Mar 27 10:36:17 2009 -0500
@@ -16,26 +16,25 @@
<p>This section will describe how to set up a basic Eclipse development environment
to develop a plugin against the Carbide.c++ development environment.</p>
-<h3><a name="download" id="download"></a>Download the Eclipse 3.4 SDK</h3>
-<p>Carbide.c++ is developed against the Eclipse 3.4 release build. You can download the build
-<a href="http://www.eclipse.org/downloads/">here</a>. Carbide.c++ is only tested and supported on the Windows platform.</p>
-<p>You can extract the Eclipse platform anywhere you like.</p>
-<p class="note"><strong>NOTE</strong> When you launch eclipse, choose a workspace location without spaces. This will help to prevent build issues later on with Symbian SDKs.</p>
-<h3><a name="setup" id="setup"></a>Set-up the Target Platform</h3>
+<h3><a name="download" id="download"></a>Download the Carbide.c++ Development Kit (CDK) </h3>
+<p>Carbide.c++ is developed against the Eclipse 3.4 release build which includes the Java Development Tools (JDT) and Plug-in Development Environment (PDE). You will need these items as well as the Carbide.c++/CDT source code to develop Eclipse/Carbide.c++ plug-ins. If you want to install the CDK you will need to run the Software Updates under the Help menu to update your installation to include the CDK. </p>
+<p>For more information on running the Software Updater please see the page <a href="PLUGINS_ROOT/com.nokia.carbide.cpp.doc.user/html/tasks/start/carbide_updating.htm">Updating Carbide.c++</a>. </p>
+<h3><a name="setup" id="setup"></a>Importing source projects </h3>
-<p>Once you have your Eclipse environment extracted and launched, you can set up your <strong>Target Platform</strong> to have your fresh installation reference all the Carbide.c++/CDT/Eclipse plugins.</p>
-<p>The Eclipse Target Platform feature allows you to compile and run against a different Eclipse installation than the
-one you're using for development. In this case you'll be targeting the Carbide.c++ installation. The <b>Target Platform</b> is a workspace-wide setting, so you may want to dedicate a separate workspace for your Carbide.c++ plugin development. </p>
-
+<p>Once you have your Carbide environment updated to include the CDK, you can create new Eclipse plug-in projects and debug the Carbide.c++ sources. How to create eclipse plug-ins is beyond the scope of this demonstration. If you want to debug any of the Carbide.c++ or Ecilpse platform source follow these steps to verify your CDK isntallation: </p>
<ol>
- <li>Choose <strong>Window</strong> > <strong>Preferences</strong> > <strong>Plug-in Development</strong> > <strong>Target Platform</strong>.</li>
- <li>Browse for the <strong>Location</strong> of your Carbide.c++ installation. This is the location that contains the <span class="style1">Carbide.c++.exe</span> and <span class="style1">plugins</span> folder. When you have chosen the new location eclipse will load the plugins found in Carbide.c++ installation you will work against. Your Target Platform preference should look something like this:<br />
- <br />
- <img src="../img/target_platform.JPG" width="740" height="584" /></li>
- <li>Select <strong>OK</strong>.</li>
+ <li>Switch to the <strong>Plug-in Development</strong> perspective. </li>
+ <li>Select the <strong>Plug-ins</strong> view. </li>
+ <li>Select the binary plug-in you want view the source of. Don't select the *source feature.</li>
+ <li>Right-click on the plug-in you want to import and select <strong>Import As > Source Project</strong>. For example, the <span class="style1">com.nokia.carbide.cpp.leavescan</span> plug-in as shown below.<br>
+ <br>
+ <img src="../img/import_source_project.jpg" width="706" height="459"> </li>
+ <li>Now you can return to the <strong>Package Explorer</strong> view and navigate the source files for the imported plug-in. It should look like a normal plug-in project:<br>
+ <br>
+ <img src="../img/source_plugin.jpg" width="361" height="392"><br>
+ <br>
+ You can now <a href="launchconfig.htm">create a launch configuration</a> and debug Carbide. </li>
</ol>
-<p>You are now ready to import or create new projects into your Eclipse workspace.</p>
-
<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>
</div>
</body>
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm Wed Mar 25 11:55:19 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/import_examples.htm Fri Mar 27 10:36:17 2009 -0500
@@ -12,43 +12,22 @@
</head>
<body bgcolor="#FFFFFF">
-<h2><a name="import" id="import"></a>Importing the SDK example and leavescan plug-ins</h2>
-<p>There are two example plugins you can import and examine as examples of Carbide.c++ API usage.</p>
+<h2><a name="import" id="import"></a>Importing the SDK Example </h2>
+<p>You can import any of the plug-ins in Carbide.c++ and examine the source code. However, the SDK provides a plug-in you can import and examine as an example of Carbide.c++ API usage.</p>
<ul>
-<li>The Examples plugin (<span class="code">com.nokia.carbide.cpp.sdk.examples</span>) is part of the Carbide.c++ Plug-in SDK. It
+<li>The Examples plugin (<span class="code">com.nokia.carbide.cpp.sdk.examples</span>) is part of the Carbide.c++ Development Kit (CDK). It
provides examples of installing items in the Carbide menu, creating new projects programatically, and accessing
project and Symbian build information. See <a href="#showExamplesMenu">below</a> for instructions on how to enable the example menu
commands inside carbide. </li>
-<li>The leavescan plugin (com.nokia.carbide.cpp.leavescan) is part of the Carbide.c++ product installation with source code included.
-The source code can help give you a basic understanding of how to access basic project configuration
-settings from the Carbide.c++ APIs.</li>
</ul>
-<p>You can import these plugins into your workspace and view/debug all the source to get a better understanding of the
-Carbide.c++ APIs in a functional plugin.</p>
+<p>You can import this and other plugins into your workspace and view/debug all the source to get a better understanding of the
+Carbide.c++ APIs in a functional plugin. Plesae see the page on <a href="env_setup.htm">setting up your development environment</a> for information on how to import a source project. </p>
<p class="note"><strong>Note</strong> that the example plugins were built with JRE1.5, you will likely receive errors with JRE1.6. Select Window > Preferences > Java > Installed JREs to add currently installed JREs and select the JRE to use.</p>
-<ol>
- <li>Choose <b>File > Import</b></li>
- <li> Choose<strong> Plug-in Development</strong> > <strong>Plug-ins and Fragments</strong> from the <strong>Import</strong> wizard page.<br />
- <br />
- <img src="../img/Import_wizard_page.JPG" width="470" height="550"/> <br />
- </li>
- <li>On the Import Plug-ins and Fragments pages you select import options. In the <strong>Import As</strong> group, select <strong>Projects with source folders</strong>.
- In addition, note that <strong>The target platform (as specified in the Preferences)</strong>
- checkbox should be enabled. This should be the path you specified previously in the Target Preferences.<br />
- <br />
- <img src="../img/plugins_and_frags_wizard.JPG" width="575" height="525"/> <br />
- </li>
- <li> Finally, select the plugins you want to import. Here you select the <code class="code">com.nokia.carbide.cpp.leavescan</code> and
- <code class="code">com.nokia.carbide.cpp.sdk.examples</code> plugins.<br />
- <br />
- <img src="../img/plugin_selection_wizard.JPG" width="663" height="554"/> <br />
- </li>
- <li>When you are done importing you should have new plugins in your workspace and be able to view the
- sources for both plugin projects. Your workspace should look something like this:<br />
- <br />
- <img src="../img/dev_ide_complete.JPG" width="1024" height="757"/></li>
-</ol>
- <h3>Adding a Carbide menu</h3>
+<p class="note">When you are done importing you should have new plugins in your workspace and be able to view the
+ sources for both plugin projects. Your workspace should look something like this:<br />
+ <br />
+ <img src="../img/dev_ide_complete.JPG" width="1024" height="757"/></p>
+<h3>Adding a Carbide menu</h3>
<p>The menu items contributed by the Examples plugin are not visible by default in the Carbide.c++ program. To show the missing menu, follow these steps:</p>
<ol>
<li>In Carbide.c++ (not in your Eclipse Java development SDK) choose <b>Window > Customize Perspective...</b></li>
@@ -57,7 +36,7 @@
<br/>
<img src="../img/show_examples_menu.jpg" width="711" height="501"/></li>
</ol>
- <p>Click OK, and you should now see the Carbide menu in the menu bar.</p>
+ <p>Click OK, and you should now see the Carbide menu in the menu bar. You can now examine the source code and run it in the debugger. See <a href="launchconfig.htm">debugging a debugging a Carbide.c++ plug-in</a> for information on setting up a plug-in debug session. </p>
<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></div>
</body>
</html>
\ No newline at end of file
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/launchconfig.htm Wed Mar 25 11:55:19 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/launchconfig.htm Fri Mar 27 10:36:17 2009 -0500
@@ -4,18 +4,26 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Debugging a Carbide.c++ plug-in</title>
<link rel="StyleSheet" href="../../book.css" type="text/css"/>
+<style type="text/css">
+<!--
+.style1 {font-family: "Courier New", Courier, mono}
+-->
+</style>
</head>
<body bgcolor="#FFFFFF">
<h2>Debugging a Carbide.c++ plug-in</h2>
<p>In order to launch Carbide.c++ in debug mode you need to create an Eclipse runtime debug configuration. Follow these steps.</p>
<ol>
<li> Click the <b>Debug</b> icon (<img src="../img/btn_debug.png" width="17" height="16" align="absmiddle">) in the task bar or right click on a project and choose<strong> Debug As</strong> ><strong> Open Debug Dialog...</strong> You should see the Eclipse launch configuration dialog. </li>
- <li>Choose <b>Eclipse Application</b> and then click on the <b>New</b> button. A new configuration is created. You should be able to take the default settings which should look like this:<br />
+ <li>Choose <b>Eclipse Application</b> and then click on the <b>New</b> button. A new configuration is created. You should be able to take the default settings which should look like this: <br />
<br />
- <img src="../img/launch_config.JPG" width="799" height="573" /> <br />
+ <img src="../img/launch_config.jpg" width="881" height="638"> <br />
</li>
- <li>Click <strong>Debug</strong> and you should have a fully functional debug environment around Carbide.c++.<br />
- </li>
+ <li>Click <strong>Debug</strong> and the Carbide.c++ project will launch another instance under debug control. You can set breakpoints in any of the plug-ins you have imported or any sources in the stack crawl during a debug session. <br>
+ <br>
+ <br>
+ <strong>TIP</strong>: Under the Arguments Tab, be sure to add theses VM Arguments for memory management: <span class="style1">-Xms40m -Xmx1024m<br />
+ </span> </li>
</ol>
<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></div>
</body>
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/sdk_help.htm Wed Mar 25 11:55:19 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/gettingStarted/sdk_help.htm Fri Mar 27 10:36:17 2009 -0500
@@ -7,64 +7,17 @@
</head>
<body bgcolor="#FFFFFF">
-<h2>Installing the Carbide.c++ Plug-in SDK help</h2>
+<h2> Carbide.c++ Plug-in SDK help</h2>
<p>If you're just getting started with creating a Carbide.c++ plug-in you're probably looking
-at this help documentation from within Carbide.c++. But if you are setting up your development
-environment as described in <a href="env_setup.htm">Setting up your development environment</a>
-you will find it much more useful to have the help available from within your plug-in development
-environment.</p>
-
-<p>The following steps will show you how to install the latest version of the Carbide.c++
-Plugin SDK into your plug-in development environment. If your network requires a proxy to
-access external Internet sites then follow the first two steps. Otherwise skip to step 3.</p>
-<ol>
-<li>From the menu bar choose <strong>Window > Preferences</strong>.<br/><br/>
-<img src="../img/preferences_command.jpg" alt="" width="820" height="665" /><br/>
-</li>
-<li>Expand the General group and select Network Connections. Select <strong>Manual proxy configuration</strong> and enter your proxy information.<br/>
- <br/>
-<img src="../img/proxy_setup.jpg" alt="" width="632" height="544" /><br/>
-<br/>
-</li>
-<li>From the menu bar choose <strong>Help > Software Updates > Find and Install...</strong><br/>
- <br/>
-<img src="../img/find_install.jpg" alt="" width="820" height="665" /><br/>
-<br/>
-</li>
-<li>Select "Search for new features to install" and click Next.<br/>
+at this help documentation from within Carbide.c++. Make sure you first follow the steps to import the Carbide Development Kit (CDK) as described in <a href="env_setup.htm">Setting up your development environment</a>. The CDK contains all the non-internal APIs for you to browse for your convenience. The same documentation appears in the javadoc comments in the source code.<br/>
<br/>
-<img src="../img/new_features.jpg" alt="" width="600" height="322" /><br/>
-<br/>
-</li>
-<li>On the Update sites to visit page, you will need to add the Carbide.c++ update site. Press the
-"New Remote Site.." button.<br/><br/>
-<img src="../img/before_new_site.jpg" alt="" width="600" height="451" /><br/>
-<br/>
-</li>
-<li>Fill in the update site information (<span class="code">http://tools.ext.nokia.com/updates/</span>) with the latest major release version (<span class="code">carbide13</span>) and press OK.<br/>
- <br/>
-<img src="../img/new_site_dialog.jpg" alt="" width="356" height="154" /><br/>
-<br/>
-</li>
-<li>The new site should now appear in the list of update sites. Press the Finish button.<br/><br/>
-<img src="../img/after_new_site.jpg" alt="" width="600" height="451" /><br/>
-<br/>
-</li>
-<li>Eclipse will connect to the Carbide.c++ update site and display the available updates. The
-specific list may differ from the screenshot below, but the Carbide.c++ SDK item should
-be present. Select it and press Next and proceed through the rest of the installation.<br/>
-<br/>
-<img src="../img/select_sdk_feature.jpg" alt="" width="600" height="523" /><br/>
-<br/>
-</li>
-<li>The SDK is now installed. You can <a href="import_examples.htm">import</a> the latest version of the
-Examples plugin. The SDK help is under the "Carbide.c++ Plug-in Developer Guide" entry in the Eclipse online
+ The SDK help is under the "Carbide.c++ Plug-in Developer Guide" entry in the Eclipse online
help.<br/>
<br/>
-<img src="../img/help_api_ref.jpg" alt="" width="939" height="697" /><br/>
-<br/></li>
-</ol>
+<img src="../img/help_api_ref.jpg" width="878" height="630"><br/>
+<br/>
+</p>
<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>
</div></body>