5
|
1 |
<?xml version="1.0" encoding="UTF-8" ?>
|
|
2 |
<!--
|
|
3 |
Copyright (c) 2005, 2009 IBM Corporation and others.
|
|
4 |
All rights reserved. This program and the accompanying materials
|
|
5 |
are made available under the terms of the Eclipse Public License v1.0
|
|
6 |
which accompanies this distribution, and is available at
|
|
7 |
http://www.eclipse.org/legal/epl-v10.html
|
|
8 |
|
|
9 |
Contributors:
|
|
10 |
IBM Corporation - initial API and implementation
|
|
11 |
-->
|
|
12 |
|
|
13 |
<!-- Simple Cheat Sheet -->
|
|
14 |
|
|
15 |
<cheatsheet title="Define a feature based product">
|
|
16 |
|
|
17 |
<!-- Introduction -->
|
|
18 |
|
|
19 |
<intro href="/org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">
|
|
20 |
<description>
|
|
21 |
This cheat sheet will demonstrate how to define a feature based product
|
|
22 |
configuration using a plug-in based one and create a feature for an RCP
|
|
23 |
application using PDE.
|
|
24 |
<br/>
|
|
25 |
<br/>
|
|
26 |
To learn more about using cheat sheets, click the help button
|
|
27 |
in the top right corner (?).
|
|
28 |
</description>
|
|
29 |
</intro>
|
|
30 |
|
|
31 |
<!-- Item -->
|
|
32 |
|
|
33 |
<item title="Open the plug-in development perspective"
|
|
34 |
href="/org.eclipse.pde.doc.user/guide/tools/views/views.htm"
|
|
35 |
dialog="false"
|
|
36 |
skip="false">
|
|
37 |
<description>
|
|
38 |
To open the plug-in development perspective,
|
|
39 |
select <b>Window->Open Perspective->Other...</b>
|
|
40 |
and choose <b>Plug-in Development</b>.
|
|
41 |
<br/>
|
|
42 |
<br/>
|
|
43 |
Alternatively, click the following button to perform the task.
|
|
44 |
</description>
|
|
45 |
<command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.pde.ui.PDEPerspective)" required="false" translate="" />
|
|
46 |
</item>
|
|
47 |
|
|
48 |
<!-- Item -->
|
|
49 |
|
|
50 |
<item title="Open the product editor"
|
|
51 |
href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/editor.htm"
|
|
52 |
dialog="false"
|
|
53 |
skip="false">
|
|
54 |
<description>
|
|
55 |
To open the product editor (if it is not already open),
|
|
56 |
expand the <b>com.example.rcpapp</b> tree dialog
|
|
57 |
in the <b>Package Explorer</b> view and double-click
|
|
58 |
on the <b>rcpapp.product</b> file.
|
|
59 |
<br/>
|
|
60 |
<br/>
|
|
61 |
Alternatively, click the following button to perform the task.
|
|
62 |
</description>
|
|
63 |
<command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" />
|
|
64 |
</item>
|
|
65 |
|
|
66 |
<item title="Switch to a feature based product configuration"
|
|
67 |
href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"
|
|
68 |
dialog="true"
|
|
69 |
skip="false">
|
|
70 |
<description>
|
|
71 |
Select the <b>Overview</b> tab to display the <b>Overview</b>
|
|
72 |
page if it is not the initial page.
|
|
73 |
<br/>
|
|
74 |
<br/>
|
|
75 |
To switch to a feature based product configuration,
|
|
76 |
select the <b>features</b> radio button under the <b>Product Definition</b> heading.
|
|
77 |
<br/>
|
|
78 |
<br/>
|
|
79 |
Select <b>File->Save</b> from the main menu.
|
|
80 |
</description>
|
|
81 |
</item>
|
|
82 |
|
|
83 |
<item title="Create the feature"
|
|
84 |
href="/org.eclipse.pde.doc.user/guide/tools/project_wizards/new_feature_project.htm"
|
|
85 |
dialog="true"
|
|
86 |
skip="false">
|
|
87 |
<description>
|
|
88 |
To create the feature, perform the following steps:
|
|
89 |
</description>
|
|
90 |
<subitem label="Select the "Dependencies" tab to display the "Dependencies" page"
|
|
91 |
skip="false"/>
|
|
92 |
<subitem label="Select the "New Feature..." button under the "Features" heading"
|
|
93 |
skip="false"/>
|
|
94 |
<subitem label="Input "com.example.feature" into the "Project Name" text box on the "Feature Properties" page"
|
|
95 |
skip="false"/>
|
|
96 |
<subitem label="Input "RCP Application Feature" into the "Feature Name" text box and click "Next >""
|
|
97 |
skip="false"/>
|
|
98 |
<subitem label="Select the "com.example.rcpapp" checkbox on the "Refererenced Plug-ins and Fragements" page and click "Finish""
|
|
99 |
skip="false"/>
|
|
100 |
</item>
|
|
101 |
|
|
102 |
<!-- Item -->
|
|
103 |
|
|
104 |
<item title="Add a feature description and license agreement"
|
|
105 |
dialog="false"
|
|
106 |
href="/org.eclipse.pde.doc.user/guide/tools/editors/feature_editor/information.htm"
|
|
107 |
skip="false">
|
|
108 |
<description>
|
|
109 |
The <b>com.example.rcpapp</b> feature editor should be opened
|
|
110 |
on the <b>Overview</b> page.
|
|
111 |
<br/>
|
|
112 |
<br/>
|
|
113 |
To add a feature description and license agreement, perform the following steps:
|
|
114 |
</description>
|
|
115 |
<subitem label="Select the "Information" tab"
|
|
116 |
skip="false"/>
|
|
117 |
<subitem label="Input "RCP application feature description" into the "Text" text box within the "Feature Description" tab"
|
|
118 |
skip="false"/>
|
|
119 |
<subitem label="Select the "License Agreement" tab within the "Information" page"
|
|
120 |
skip="false"/>
|
|
121 |
<subitem label="Input "RCP application license agreement" into the "Text" text box"
|
|
122 |
skip="false"/>
|
|
123 |
<subitem label="Select "File->Save" from the main menu"
|
|
124 |
skip="false"/>
|
|
125 |
</item>
|
|
126 |
|
|
127 |
<!-- Item -->
|
|
128 |
|
|
129 |
<item title="Add features to the product configuration"
|
|
130 |
dialog="true"
|
|
131 |
href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/configuration.htm"
|
|
132 |
skip="false">
|
|
133 |
<description>
|
|
134 |
To add features to the product configuration, perform the following steps:
|
|
135 |
</description>
|
|
136 |
<subitem label="Select the "rcpapp.product" tab in the workbench to return back to the product editor (opened on the "Dependencies" page)"
|
|
137 |
skip="false">
|
|
138 |
<command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" />
|
|
139 |
</subitem>
|
|
140 |
<subitem label="Click the "Add..." button under the "Features" heading"
|
|
141 |
skip="false"/>
|
|
142 |
<subitem label="Select the "org.eclipse.rcp" feature within the "Feature Selection" dialog box and click "OK""
|
|
143 |
skip="false"/>
|
|
144 |
<subitem label="Select "File->Save" from the main menu"
|
|
145 |
skip="false"/>
|
|
146 |
</item>
|
|
147 |
|
|
148 |
<!-- Item -->
|
|
149 |
|
|
150 |
<item title="Export the feature based product"
|
|
151 |
href="/org.eclipse.pde.doc.user/guide/tools/export_wizards/export_product.htm"
|
|
152 |
dialog="true"
|
|
153 |
skip="false">
|
|
154 |
<description>
|
|
155 |
To export the feature based product, perform the following steps:
|
|
156 |
</description>
|
|
157 |
<subitem label="Select the "Overview" tab to display the "Overview" page"
|
|
158 |
skip="false"/>
|
|
159 |
<subitem label="Click the "Eclipse Product export wizard" hyperlink under the "Exporting" heading to launch the "Export" dialog box"
|
|
160 |
skip="false">
|
|
161 |
<command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" required="false" translate="" />
|
|
162 |
</subitem>
|
|
163 |
<subitem
|
|
164 |
label="Verify that "/com.example.rcpapp/rcpapp.product" is entered in the "Configuration" combo box within the "Product Configuration" group"
|
|
165 |
skip="true">
|
|
166 |
</subitem>
|
|
167 |
<subitem label="Input "rcpapp_feature-based" in the "Root directory" text box contained in the "Product Configuration" group"
|
|
168 |
skip="false"/>
|
|
169 |
<subitem label="Input a destination directory in the "Directory" text box under the "Destination" group (e.g. "C:\" for Windows) and click "Finish""
|
|
170 |
skip="false"/>
|
|
171 |
</item>
|
|
172 |
|
|
173 |
<!-- Item -->
|
|
174 |
|
|
175 |
<item title="Browse the exported feature based product directory"
|
|
176 |
dialog="true"
|
|
177 |
skip="false">
|
|
178 |
<description>
|
|
179 |
To browse the exported feature based product directory, perform the following steps:
|
|
180 |
</description>
|
|
181 |
<subitem label="Navigate your file system to the destination directory specified in the previous step (e.g. "C:\" for Windows)"
|
|
182 |
skip="false"/>
|
|
183 |
<subitem label="Note the presence of the "rcpapp_feature-based" directory in the destination directory and open it"
|
|
184 |
skip="false"/>
|
|
185 |
<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"
|
|
186 |
skip="true"/>
|
|
187 |
<subitem label="Note the presence of the "com.example.rcpapp" feature and "org.eclipse.rcp" feature within the "features" sub-directory"
|
|
188 |
skip="true"/>
|
|
189 |
<subitem label="Note the "rcpapp" launcher with a branded icon ("rcpapp.exe" on Windows)"
|
|
190 |
skip="false"/>
|
|
191 |
<subitem label="Run the "rcpapp" launcher"
|
|
192 |
skip="false"/>
|
|
193 |
<subitem label="Observe the feature based RCP application you created that is fully executable outside the Eclipse workspace"
|
|
194 |
skip="true"/>
|
|
195 |
</item>
|
|
196 |
|
|
197 |
</cheatsheet>
|
|
198 |
|