Gitiles
Code Review Sign In
git.eclipse.org / pde / eclipse.pde.incubator / 5861743e7549c7aae10ee2e320768dd5be086e94 / . / presentations / eclipse-con / 2007 / plugins / org.eclipse.browser.cheatsheets / cheatsheets / product-export.xml
blob: a8c3d6509a7b74b9d9a88b23dc7bab0cbee20bd7 [file] [log] [blame]
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Wassim Melhem3ef16152007-02-21 07:51:32 +0000[diff] [blame]2<cheatsheet title="Create an Eclipse Product">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]3 <intro>
4 <description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]5 This tutorial will demonstrate how to use the RCP tooling in PDE to create a fully-branded product.
6<br/>
7<br/>
8To learn more about using cheat sheets, click the help button in the top right corner (?).
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]9 </description>
10 </intro>
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]11 <item title="Create the product configuration" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/file_wizards/new_product_config.htm">
12 <description>
13 To create the product configuration, perform the following steps:
14 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]15 <subitem label="Select &quot;File-&gt;New-&gt;Product Configuration&quot; from the main menu to bring up the &quot;New Product Configuration&quot; wizard." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]16 <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProductConfigurationWizard)" confirm="false">
17 </command>
18 </subitem>
Wassim Melhem58617432007-03-05 18:49:14 +0000[diff] [blame^]19 <subitem label="In the &quot;New Product Configuration wizard&quot;, select the &quot;org.eclipse.browser&quot; project as the parent folder, then input &quot;browser.product&quot; into the &quot;File name&quot; text box. Press &quot;Finish&quot;." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]20 </subitem>
21 </item>
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]22 <item title="Define the product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm">
23 <description>
24 To define the product, perform the following steps:
25 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]26 <subitem label="On the &quot;Overview&quot; page of the product editor, input &quot;Eclipse Browser Product&quot; into the &quot;Product Name&quot; text box." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]27 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]28 <subitem label="Press the &quot;New...&quot; button next to the &quot;Product ID&quot; drop down menu to open the &quot;New Product Definition&quot; dialog box." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]29 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]30 <subitem label="Select &quot;org.eclipse.browser.application&quot; from the list of available applications in the &quot;Application&quot; section. Press &quot;Finish&quot;." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]31 </subitem>
32 </item>
Wassim Melhem58617432007-03-05 18:49:14 +0000[diff] [blame^]33 <item title="Specify the constituent plug-ins" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/configuration.htm">
34 <description>
35 To specify the plug-ins that make up the product, perform the following steps:
36 </description>
37 <subitem label="On the &quot;Configuration&quot; tab of the product editor, press &quot;Add...&quot; in the &quot;Plug-ins and Fragments&quot; section." skip="false">
38 </subitem>
39 <subitem label="In the plug-in selection dialog, select &quot;org.eclipse.browser&quot; and press OK." skip="false">
40 </subitem>
41 <subitem label="Press &quot;Add Required Plug-ins&quot; to include in the list all the plug-ins that need to be present for the org.eclipse.browser plug-in to run." skip="false">
42 </subitem>
43 </item>
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]44 <item title="Add window images" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/branding.htm">
45 <description>
46 To add window images, perform the following steps:
47 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]48 <subitem label="Select the &quot;Branding&quot; page of the product editor." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]49 </subitem>
Wassim Melhemcbdd9fa2007-02-23 21:05:17 +0000[diff] [blame]50 <subitem label="In the &quot;Window Images&quot; section, press the &quot;Browse...&quot; button adjacent to the &quot;16x16&quot; text box to select the &quot;/org.eclipse.browser/branding/world_16-16_windows.gif&quot; image. Press &quot;OK&quot;." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]51 </subitem>
Wassim Melhemcbdd9fa2007-02-23 21:05:17 +0000[diff] [blame]52 <subitem label="In the &quot;Window Images&quot; section, press the &quot;Browse...&quot; button adjacent to the &quot;32x32&quot; text box to select the &quot;/org.eclipse.browser/branding/world_32-32_windows.gif&quot; image. Press &quot;OK&quot;." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]53 </subitem>
54 </item>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]55 <item title="Customize the About dialog" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/branding.htm">
Wassim Melhem3ef16152007-02-21 07:51:32 +0000[diff] [blame]56 <description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]57 To customize the About dialog, perform the following steps:
Wassim Melhem3ef16152007-02-21 07:51:32 +0000[diff] [blame]58 </description>
Wassim Melhemcbdd9fa2007-02-23 21:05:17 +0000[diff] [blame]59 <subitem label="In the &quot;About Text&quot; section, press the &quot;Browse...&quot; button adjacent to the &quot;Image&quot; text box to select the &quot;/org.eclipse.browser/branding/world_about.gif&quot; image. Press &quot;OK&quot;." skip="false">
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]60 </subitem>
61 <subitem label="In the &quot;Text&quot; area, input &quot;This is a blurb about my Eclipse Browser Product&quot;." skip="false">
62 </subitem>
Wassim Melhem3ef16152007-02-21 07:51:32 +0000[diff] [blame]63 </item>
Wassim Melhem2f0a4912007-02-19 09:50:03 +0000[diff] [blame]64 <item title="Run the RCP product" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm">
65 <description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]66 To run the RCP product, perform the following steps:
Wassim Melhem2f0a4912007-02-19 09:50:03 +0000[diff] [blame]67 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]68 <subitem label="Save the &quot;browser.product&quot; file via File &gt; Save from the main menu." skip="false">
Wassim Melhem2f0a4912007-02-19 09:50:03 +0000[diff] [blame]69 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]70 <subitem label="On the &quot;Overview&quot; page of the product editor, click the &quot;Launch the product&quot; hyperlink under the &quot;Testing&quot; heading. Note the splash screen upon launching." skip="false">
Wassim Melhem2f0a4912007-02-19 09:50:03 +0000[diff] [blame]71 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]72 <subitem label="Note how the application window now has the title &quot;Eclipse Browser Product&quot; in the title bar." skip="true">
73 </subitem>
74 <subitem label="Note how the application window has an image depicting the world in the top-left corner. The same image appears in the task bar at the bottom." skip="true">
75 </subitem>
76 <subitem label="Press Alt-Tab (on Windows) to see your RCP application among the list of running applications, represented with a larger 48x48 icon." skip="true">
77 </subitem>
78 <subitem label="Bring up the &quot;About&quot; dialog by selecting &quot;Help &gt; About Eclipse Browser Product&quot; from the main menu of the application window. Verify that you see your custom text and image in the &quot;About&quot; dialog." skip="false">
79 </subitem>
80 <subitem label="Exit the RCP application via &quot;File &gt; Exit&quot; from the main menu of the application window." skip="false">
Wassim Melhem2f0a4912007-02-19 09:50:03 +0000[diff] [blame]81 </subitem>
82 </item>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]83 <item title="Customize the launcher (Windows Only)" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/launcher.htm">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]84 <description>
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]85 To customize the launcher, perform the following steps:
86 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]87 <subitem label="Select the &quot;Launcher&quot; page of the product editor." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]88 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]89 <subitem label="Input &quot;browser&quot; into the &quot;Launcher Name&quot; text box under the &quot;Program Launcher&quot; heading." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]90 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]91 <subitem label="Select the &quot;win32&quot; tab under the &quot;Program Launcher&quot; heading and select the &quot;Use a single ICO file containing 7 images as specified above&quot; radio button." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]92 </subitem>
Wassim Melhemcbdd9fa2007-02-23 21:05:17 +0000[diff] [blame]93 <subitem label="Press the &quot;Browse...&quot; button adjacent to the &quot;File&quot; text box to select the &quot;/org.eclipse.browser/branding/world_launcher.ico&quot; file. Press &quot;OK&quot;." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]94 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]95 <subitem label="Select &quot;File-&gt;Save&quot; from the main menu." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]96 </subitem>
97 </item>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]98 <item title="Export the product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]99 <description>
100 To export the plug-in based product, perform the following steps:
101 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]102 <subitem label="Select the &quot;Overview&quot; page of the product editor." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]103 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]104 <subitem label="Click the &quot;Eclipse Product export wizard&quot; hyperlink under the &quot;Exporting&quot; heading to bring up the &quot;Eclipse Product&quot; export wizard." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]105 <command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" confirm="false">
106 </command>
107 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]108 <subitem label="Input &quot;browser&quot; in the &quot;Root directory&quot; text field contained in the &quot;Product Configuration&quot; section." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]109 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]110 <subitem label="Input a destination directory in the &quot;Directory&quot; text fiedl in the &quot;Destination&quot; section (e.g. &quot;C:\destination&quot; for Windows) and press &quot;Finish&quot;." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]111 </subitem>
112 </item>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]113 <item title="Browse the finished product" dialog="true" skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]114 <description>
115 To browse the exported plug-in based product directory, perform the following steps:
116 </description>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]117 <subitem label="Navigate your file system to the destination directory specified in the previous step (e.g. &quot;C:\destination&quot; for Windows)" skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]118 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]119 <subitem label="Note the presence of the &quot;browser&quot; subdirectory. Expand it and examine the structure of your product. A &quot;plugins&quot; subdirectory containing all plug-ins, a &quot;configuration&quot; containing metadata." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]120 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]121 <subitem label="Note the custom &quot;browser&quot; launcher with a branded icon (&quot;browser.exe&quot; on Windows) at the root of the &quot;browser&quot; directory." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]122 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]123 <subitem label="Double-click on the &quot;browser&quot; executable to launch the product." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]124 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]125 <subitem label="Observe the RCP product you created that is fully executable outside the Eclipse workspace." skip="true">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]126 </subitem>
Wassim Melhem30d951d2007-02-23 19:50:27 +0000[diff] [blame]127 <subitem label="Exit the product via &quot;File &gt; Exit&quot; from the main menu." skip="false">
Brian Baumandacaa122007-02-13 20:59:57 +0000[diff] [blame]128 </subitem>
129 </item>
130</cheatsheet>