| Brian Bauman | dacaa12 | 2007-02-13 20:59:57 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <cheatsheet title="Export RCP product"> |
| 3 | <intro> |
| 4 | <description> |
| 5 | This cheat sheet will demonstrate how to export the Eclipse Browser plug-in as an RCP application. |
| 6 | <br/> |
| 7 | <br/> |
| 8 | To learn more about using cheat sheets, click the help button |
| 9 | in the top right corner (?). |
| 10 | </description> |
| 11 | </intro> |
| Brian Bauman | dacaa12 | 2007-02-13 20:59:57 +0000 | [diff] [blame] | 12 | <item title="Create the product configuration" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/file_wizards/new_product_config.htm"> |
| 13 | <description> |
| 14 | To create the product configuration, perform the following steps: |
| 15 | </description> |
| 16 | <subitem label="Select "File->New->Product Configuration" from the main menu" skip="true"> |
| 17 | <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProductConfigurationWizard)" confirm="false"> |
| 18 | </command> |
| 19 | </subitem> |
| 20 | <subitem label="Select "org.eclipsecon.browser" in the resulting "New Product Configuration" wizard page" skip="false"> |
| 21 | </subitem> |
| 22 | <subitem label="Input "browser.product" into the "File name" text box" skip="false"> |
| 23 | </subitem> |
| 24 | <subitem label="Select the "Use a launch configuration" radio button inside the "Initialize the file content" group and click "Finish"." skip="false"> |
| 25 | </subitem> |
| 26 | </item> |
| Brian Bauman | dacaa12 | 2007-02-13 20:59:57 +0000 | [diff] [blame] | 27 | <item title="Define the product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| 28 | <description> |
| 29 | To define the product, perform the following steps: |
| 30 | </description> |
| 31 | <subitem label="Input "Browser RCP Application" into the "Product Name" text box" skip="false"> |
| 32 | </subitem> |
| 33 | <subitem label="Click the "New..." button next to the "Product ID" drop down menu to open the "New Product Definition" dialog box" skip="false"> |
| 34 | </subitem> |
| 35 | <subitem label="Verify "org.eclipsecon.browser" is the inputted value for the "Defining Plug-in" text box" skip="true"> |
| 36 | </subitem> |
| 37 | <subitem label="Verify "product" is the inputted value for the "Product ID" text box" skip="true"> |
| 38 | </subitem> |
| 39 | <subitem label="Select "org.eclipsecon.browser.application" in the "Application" combo." skip="false"> |
| 40 | </subitem> |
| 41 | <subitem label="Select "File->Save" from the main menu" skip="false"> |
| 42 | </subitem> |
| 43 | </item> |
| Brian Bauman | dacaa12 | 2007-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> |
| 48 | <subitem label="Select the "Branding" tab within the product editor to display the "Branding" page" skip="false"> |
| 49 | </subitem> |
| 50 | <subitem label="Click the "Browse" button adjacent to the "16x16" text box under the "Window Images" heading" skip="false"> |
| 51 | </subitem> |
| 52 | <subitem label="Fully expand the "org.eclipsecon.browser" tree in the "Image Selection" dialog box and select "alt_window_16.gif" and click "OK"" skip="false"> |
| 53 | </subitem> |
| 54 | <subitem label="Click the "Browse" button adjacent to the "32x32" text box under the "Window Images" heading" skip="false"> |
| 55 | </subitem> |
| 56 | <subitem label="Fully expand the "org.eclipsecon.browser" tree in the "Image Selection" dialog box and select "alt_window_32.gif" and click "OK"" skip="false"> |
| 57 | </subitem> |
| 58 | <subitem label="Select "File->Save" from the main menu" skip="false"> |
| 59 | </subitem> |
| 60 | </item> |
| Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 61 | <item title="Run the RCP product" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| 62 | <description> |
| 63 | To run the RCP product, |
| 64 | perform the following steps: |
| 65 | </description> |
| 66 | <subitem label="Click the "Launch the product" hyperlink under the "Testing" heading" skip="false"> |
| 67 | </subitem> |
| 68 | <subitem label="Note: "Browser RCP Application" now shows up in the window title bar" skip="true"> |
| 69 | </subitem> |
| 70 | <subitem label="Exit the RCP application" skip="false"> |
| 71 | </subitem> |
| 72 | </item> |
| Brian Bauman | dacaa12 | 2007-02-13 20:59:57 +0000 | [diff] [blame] | 73 | <item title="Customize the launcher" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/launcher.htm"> |
| 74 | <description> |
| 75 | We will walk through this task assuming we are working on a Windows |
| 76 | platform (Similar steps may be followed for other platforms). |
| 77 | <br/> |
| 78 | <br/> |
| 79 | To customize the launcher, perform the following steps: |
| 80 | </description> |
| 81 | <subitem label="Select the "Launcher" tab within the product editor to display the "Launcher" page" skip="false"> |
| 82 | </subitem> |
| 83 | <subitem label="Input "browser" into the "Launcher Name" text box under the "Program Launcher" heading" skip="false"> |
| 84 | </subitem> |
| 85 | <subitem label="Select the "win32" tab under the "Program Launcher" heading" skip="true"> |
| 86 | </subitem> |
| 87 | <subitem label="Select the "Use a single ICO file containing 7 images as specified above" radio button" skip="true"> |
| 88 | </subitem> |
| 89 | <subitem label="Click the "Browse..." button adjacent to the "File" text box" skip="true"> |
| 90 | </subitem> |
| 91 | <subitem label="Fully expand the "org.eclipsecon.browser" tree in the "Image Selection" dialog box and select "alt_launcher.ico" and click "OK"" skip="true"> |
| 92 | </subitem> |
| 93 | <subitem label="Select "File->Save" from the main menu" skip="false"> |
| 94 | </subitem> |
| 95 | </item> |
| 96 | <item title="Export the plug-in based product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| 97 | <description> |
| 98 | To export the plug-in based product, perform the following steps: |
| 99 | </description> |
| 100 | <subitem label="Select the "Overview" tab within the product editor to display the "Overview" page" skip="false"> |
| 101 | </subitem> |
| 102 | <subitem label="Click the "Eclipse Product export wizard" hyperlink under the "Exporting" heading to launch the "Export" dialog box" skip="true"> |
| 103 | <command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" confirm="false"> |
| 104 | </command> |
| 105 | </subitem> |
| 106 | <subitem label="Verify that "/org.eclipsecon.browser/browser.product" is entered in the "Configuration" combo box within the "Product Configuration" group" skip="true"> |
| 107 | </subitem> |
| 108 | <subitem label="Input "browser_rcpapp" in the "Root directory" text box contained in the "Product Configuration" group" skip="false"> |
| 109 | </subitem> |
| 110 | <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"> |
| 111 | </subitem> |
| 112 | </item> |
| 113 | <item title="Browse the exported plug-in based product directory" dialog="true" skip="false"> |
| 114 | <description> |
| 115 | To browse the exported plug-in based product directory, perform the following steps: |
| 116 | </description> |
| 117 | <subitem label="Navigate your file system to the destination directory specified in the previous step (e.g. "C:\" for Windows)" skip="false"> |
| 118 | </subitem> |
| 119 | <subitem label="Note the presence of the "rcpapp_plugin-based" directory in the destination directory and open it" skip="false"> |
| 120 | </subitem> |
| 121 | <subitem label="Note the presence of the "org.eclipsecon.browser" plug-in along with many other RCP plug-ins it depends upon within the "plugins" sub-directory" skip="true"> |
| 122 | </subitem> |
| 123 | <subitem label="Note the "browser" launcher with a branded icon ("browser.exe" on Windows)" skip="false"> |
| 124 | </subitem> |
| 125 | <subitem label="Run the "browser" launcher" skip="false"> |
| 126 | </subitem> |
| 127 | <subitem label="Observe the plug-in based RCP application you created that is fully executable outside the Eclipse workspace" skip="true"> |
| 128 | </subitem> |
| 129 | <subitem label="Exit the RCP application" skip="false"> |
| 130 | </subitem> |
| 131 | </item> |
| 132 | </cheatsheet> |