|
1 <?xml version="1.0" encoding="UTF-8" ?> |
|
2 <!-- |
|
3 Copyright (c) 2005, 2008 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="Export an RCP 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 modify a build |
|
22 configuration and export an |
|
23 RCP product 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 build configuration editor" |
|
51 href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/build.htm" |
|
52 dialog="false" |
|
53 skip="false"> |
|
54 <description> |
|
55 To open the build configuration editor, |
|
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>build.properties</b> file. |
|
59 <br/> |
|
60 <br/> |
|
61 Select the <b>Build</b> tab to display the <b>Build Configuration</b> |
|
62 page if it is not the initial page. |
|
63 <br/> |
|
64 <br/> |
|
65 Alternatively, click the following button to perform the task. |
|
66 </description> |
|
67 <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/build.properties)" required="false" translate="" /> |
|
68 </item> |
|
69 |
|
70 <!-- Item --> |
|
71 |
|
72 <item title="Modify the build configuration" |
|
73 href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/build.htm" |
|
74 dialog="true" |
|
75 skip="false"> |
|
76 <description> |
|
77 In order to control what files are deployed with our packaged |
|
78 RCP application, we need to modify the build configuration. |
|
79 <br/> |
|
80 <br/> |
|
81 To modify the build configuration, perform the following steps: |
|
82 </description> |
|
83 <subitem label="Select the checkbox corresponding to the "icons" directory under the "Binary Build" heading" |
|
84 skip="false"/> |
|
85 <subitem label="Select the checkbox corresponding to the "splash.bmp" file under the "Binary Build" heading" |
|
86 skip="false"/> |
|
87 <subitem label="Select "File->Save" from the main menu" |
|
88 skip="false"/> |
|
89 </item> |
|
90 |
|
91 <!-- Item --> |
|
92 |
|
93 <item title="Open the product editor" |
|
94 href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/editor.htm" |
|
95 dialog="false" |
|
96 skip="false"> |
|
97 <description> |
|
98 To open the product editor (if it is not already open), |
|
99 expand the <b>com.example.rcpapp</b> tree dialog |
|
100 in the <b>Package Explorer</b> view and double-click |
|
101 on the <b>rcpapp.product</b> file. |
|
102 <br/> |
|
103 <br/> |
|
104 Alternatively, click the following button to perform the task. |
|
105 </description> |
|
106 <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" /> |
|
107 </item> |
|
108 |
|
109 <!-- Item --> |
|
110 |
|
111 <item title="Export the plug-in based product" |
|
112 href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm" |
|
113 dialog="true" |
|
114 skip="false"> |
|
115 <description> |
|
116 To export the plug-in based product, perform the following steps: |
|
117 </description> |
|
118 <subitem label="Select the "Overview" tab within the product editor to display the "Overview" page" |
|
119 skip="false"/> |
|
120 <subitem label="Click the "Eclipse Product export wizard" hyperlink under the "Exporting" heading to launch the "Export" dialog box" |
|
121 skip="false"> |
|
122 <command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" required="false" translate="" /> |
|
123 </subitem> |
|
124 <subitem label="Verify that "/com.example.rcpapp/rcpapp.product" is entered in the "Configuration" combo box within the "Product Configuration" group" |
|
125 skip="true"/> |
|
126 <subitem label="Input "rcpapp_plugin-based" in the "Root directory" text box contained in the "Product Configuration" group" |
|
127 skip="false"/> |
|
128 <subitem label="Input a destination directory in the "Directory" text box under the "Destination" group (e.g. "C:\" for Windows) and click "Finish"" |
|
129 skip="false"/> |
|
130 </item> |
|
131 |
|
132 <!-- Item --> |
|
133 |
|
134 <item title="Browse the exported plug-in based product directory" |
|
135 dialog="true" |
|
136 skip="false"> |
|
137 <description> |
|
138 To browse the exported plug-in based product directory, perform the following steps: |
|
139 </description> |
|
140 <subitem label="Navigate your file system to the destination directory specified in the previous step (e.g. "C:\" for Windows)" |
|
141 skip="false"/> |
|
142 <subitem label="Note the presence of the "rcpapp_plugin-based" directory in the destination directory and open it" |
|
143 skip="false"/> |
|
144 <subitem label="Note the presence of the "com.example.rcpapp" plug-in along with many other RCP plug-ins it depends upon within the "plugins" sub-directory" |
|
145 skip="true"/> |
|
146 <subitem label="Note the "rcpapp" launcher with a branded icon ("rcpapp.exe" on Windows)" |
|
147 skip="false"/> |
|
148 <subitem label="Run the "rcpapp" launcher" |
|
149 skip="false"/> |
|
150 <subitem label="Observe the plug-in based RCP application you created that is fully executable outside the Eclipse workspace" |
|
151 skip="true"/> |
|
152 <subitem label="Exit the RCP application" |
|
153 skip="false"/> |
|
154 </item> |
|
155 |
|
156 </cheatsheet> |
|
157 |