| <?xml version="1.0" encoding="UTF-8" ?> |
| <!-- |
| Copyright (c) 2005, 2010 IBM Corporation and others. |
| All rights reserved. This program and the accompanying materials |
| are made available under the terms of the Eclipse Public License v1.0 |
| which accompanies this distribution, and is available at |
| http://www.eclipse.org/legal/epl-v10.html |
| |
| Contributors: |
| IBM Corporation - initial API and implementation |
| --> |
| |
| <!-- Simple Cheat Sheet --> |
| |
| <cheatsheet title="Define a feature based product"> |
| |
| <!-- Introduction --> |
| |
| <intro href="/org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm"> |
| <description> |
| This cheat sheet will demonstrate how to define a feature based product |
| configuration using a plug-in based one and create a feature for an RCP |
| application using PDE. |
| <br/> |
| <br/> |
| To learn more about using cheat sheets, click the help button |
| in the top right corner (?). |
| </description> |
| </intro> |
| |
| <!-- Item --> |
| |
| <item title="Open the plug-in development perspective" |
| href="/org.eclipse.pde.doc.user/guide/tools/views/views.htm" |
| dialog="false" |
| skip="false"> |
| <description> |
| To open the plug-in development perspective, |
| select <b>Window->Open Perspective->Other...</b> |
| and choose <b>Plug-in Development</b>. |
| <br/> |
| <br/> |
| Alternatively, click the following button to perform the task. |
| </description> |
| <command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.pde.ui.PDEPerspective)" required="false" translate="" /> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Open the product editor" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/editor.htm" |
| dialog="false" |
| skip="false"> |
| <description> |
| To open the product editor (if it is not already open), |
| expand the <b>com.example.rcpapp</b> tree dialog |
| in the <b>Package Explorer</b> view and double-click |
| on the <b>rcpapp.product</b> file. |
| <br/> |
| <br/> |
| Alternatively, click the following button to perform the task. |
| </description> |
| <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" /> |
| </item> |
| |
| <item title="Switch to a feature based product configuration" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm" |
| dialog="true" |
| skip="false"> |
| <description> |
| Select the <b>Overview</b> tab to display the <b>Overview</b> |
| page if it is not the initial page. |
| <br/> |
| <br/> |
| To switch to a feature based product configuration, |
| select the <b>features</b> radio button under the <b>Product Definition</b> heading. |
| <br/> |
| <br/> |
| Select <b>File->Save</b> from the main menu. |
| </description> |
| </item> |
| |
| <item title="Create the feature" |
| href="/org.eclipse.pde.doc.user/guide/tools/project_wizards/new_feature_project.htm" |
| dialog="true" |
| skip="false"> |
| <description> |
| To create the feature, perform the following steps: |
| </description> |
| <subitem label="Select the "Dependencies" tab to display the "Dependencies" page" |
| skip="false"/> |
| <subitem label="Select the "New Feature..." tool button in the "Features" section." |
| skip="false"/> |
| <subitem label="Input "com.example.feature" into the "Project Name" text box on the "Feature Properties" page" |
| skip="false"/> |
| <subitem label="Input "RCP Application Feature" into the "Feature Name" text box and click "Next >"" |
| skip="false"/> |
| <subitem label="Select the "com.example.rcpapp" checkbox on the "Refererenced Plug-ins and Fragments" page and click "Finish"" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Add a feature description and license agreement" |
| dialog="false" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/feature_editor/information.htm" |
| skip="false"> |
| <description> |
| The <b>com.example.rcpapp</b> feature editor should be opened |
| on the <b>Overview</b> page. |
| <br/> |
| <br/> |
| To add a feature description and license agreement, perform the following steps: |
| </description> |
| <subitem label="Select the "Information" tab" |
| skip="false"/> |
| <subitem label="Input "RCP application feature description" into the "Text" text box within the "Feature Description" tab" |
| skip="false"/> |
| <subitem label="Select the "License Agreement" tab within the "Information" page" |
| skip="false"/> |
| <subitem label="Input "RCP application license agreement" into the "Text" text box" |
| skip="false"/> |
| <subitem label="Select "File->Save" from the main menu" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Add features to the product configuration" |
| dialog="true" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/configuration.htm" |
| skip="false"> |
| <description> |
| To add features to the product configuration, perform the following steps: |
| </description> |
| <subitem label="Select the "rcpapp.product" tab in the workbench to return back to the product editor (opened on the "Dependencies" page)" |
| skip="false"> |
| <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" /> |
| </subitem> |
| <subitem label="Click the "Add..." button under the "Features" heading" |
| skip="false"/> |
| <subitem label="Select the "org.eclipse.rcp" feature within the "Feature Selection" dialog box and click "OK"" |
| skip="false"/> |
| <subitem label="Select "File->Save" from the main menu" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Export the feature based product" |
| href="/org.eclipse.pde.doc.user/guide/tools/export_wizards/export_product.htm" |
| dialog="true" |
| skip="false"> |
| <description> |
| To export the feature based product, perform the following steps: |
| </description> |
| <subitem label="Select the "Overview" tab to display the "Overview" page" |
| skip="false"/> |
| <subitem label="Click the "Eclipse Product export wizard" hyperlink under the "Exporting" heading to launch the "Export" dialog box" |
| skip="false"> |
| <command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" required="false" translate="" /> |
| </subitem> |
| <subitem |
| label="Verify that "/com.example.rcpapp/rcpapp.product" is entered in the "Configuration" combo box within the "Product Configuration" group" |
| skip="true"> |
| </subitem> |
| <subitem label="Input "rcpapp_feature-based" in the "Root directory" text box contained in the "Product Configuration" group" |
| skip="false"/> |
| <subitem label="Input a destination directory in the "Directory" text box under the "Destination" group (e.g. "C:\" for Windows) and click "Finish"" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Browse the exported feature based product directory" |
| dialog="true" |
| skip="false"> |
| <description> |
| To browse the exported feature based product directory, perform the following steps: |
| </description> |
| <subitem label="Navigate your file system to the destination directory specified in the previous step (e.g. "C:\" for Windows)" |
| skip="false"/> |
| <subitem label="Note the presence of the "rcpapp_feature-based" directory in the destination directory and open it" |
| skip="false"/> |
| <subitem label="Note the presence of the "com.example.rcpapp" plug-in along with other RCP plug-ins it depends upon within the "plugins" sub-directory" |
| skip="true"/> |
| <subitem label="Note the presence of the "com.example.rcpapp" feature and "org.eclipse.rcp" feature within the "features" sub-directory" |
| skip="true"/> |
| <subitem label="Note the "rcpapp" launcher with a branded icon ("rcpapp.exe" on Windows)" |
| skip="false"/> |
| <subitem label="Run the "rcpapp" launcher" |
| skip="false"/> |
| <subitem label="Observe the feature based RCP application you created that is fully executable outside the Eclipse workspace" |
| skip="true"/> |
| </item> |
| |
| </cheatsheet> |
| |
