| <?xml version="1.0" encoding="UTF-8"?> |
| <cheatsheet title="Create an Eclipse Product"> |
| <intro> |
| <description> |
| This tutorial will demonstrate how to use the RCP tooling in PDE to create a fully-branded product. |
| <br/> |
| <br/> |
| To learn more about using cheat sheets, click the help button in the top right corner (?). |
| </description> |
| </intro> |
| <item title="Create the product configuration" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/file_wizards/new_product_config.htm"> |
| <description> |
| To create the product configuration, perform the following steps: |
| </description> |
| <subitem label="Select "File->New->Product Configuration" from the main menu to bring up the "New Product Configuration" wizard." skip="true"> |
| <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProductConfigurationWizard)" confirm="false"> |
| </command> |
| </subitem> |
| <subitem label="In the "New Product Configuration wizard", select the "org.eclipse.browser" project as the parent folder, then input "browser.product" into the "File name" text box." skip="false"> |
| </subitem> |
| <subitem label="Select the "Use a launch configuration" radio button inside the "Initialize the file content" section and press "Finish"." skip="false"> |
| </subitem> |
| </item> |
| <item title="Define the product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| <description> |
| To define the product, perform the following steps: |
| </description> |
| <subitem label="On the "Overview" page of the product editor, input "Eclipse Browser Product" into the "Product Name" text box." skip="false"> |
| </subitem> |
| <subitem label="Press the "New..." button next to the "Product ID" drop down menu to open the "New Product Definition" dialog box." skip="false"> |
| </subitem> |
| <subitem label="Select "org.eclipse.browser.application" from the list of available applications in the "Application" section. Press "Finish"." skip="false"> |
| </subitem> |
| </item> |
| <item title="Add window images" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/branding.htm"> |
| <description> |
| To add window images, perform the following steps: |
| </description> |
| <subitem label="Select the "Branding" page of the product editor." skip="false"> |
| </subitem> |
| <subitem label="In the "Window Images" section, press the "Browse..." button adjacent to the "16x16" text box to select the "/org.eclipse.browser/branding/world_16-16_windows.gif" image. Press "OK"." skip="false"> |
| </subitem> |
| <subitem label="In the "Window Images" section, press the "Browse..." button adjacent to the "32x32" text box to select the "/org.eclipse.browser/branding/world_32-32_windows.gif" image. Press "OK"." skip="false"> |
| </subitem> |
| </item> |
| <item title="Customize the About dialog" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/branding.htm"> |
| <description> |
| To customize the About dialog, perform the following steps: |
| </description> |
| <subitem label="In the "About Text" section, press the "Browse..." button adjacent to the "Image" text box to select the "/org.eclipse.browser/branding/world_about.gif" image. Press "OK"." skip="false"> |
| </subitem> |
| <subitem label="In the "Text" area, input "This is a blurb about my Eclipse Browser Product"." skip="false"> |
| </subitem> |
| </item> |
| <item title="Run the RCP product" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| <description> |
| To run the RCP product, perform the following steps: |
| </description> |
| <subitem label="Save the "browser.product" file via File > Save from the main menu." skip="false"> |
| </subitem> |
| <subitem label="On the "Overview" page of the product editor, click the "Launch the product" hyperlink under the "Testing" heading. Note the splash screen upon launching." skip="false"> |
| </subitem> |
| <subitem label="Note how the application window now has the title "Eclipse Browser Product" in the title bar." skip="true"> |
| </subitem> |
| <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"> |
| </subitem> |
| <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"> |
| </subitem> |
| <subitem label="Bring up the "About" dialog by selecting "Help > About Eclipse Browser Product" from the main menu of the application window. Verify that you see your custom text and image in the "About" dialog." skip="false"> |
| </subitem> |
| <subitem label="Exit the RCP application via "File > Exit" from the main menu of the application window." skip="false"> |
| </subitem> |
| </item> |
| <item title="Customize the launcher (Windows Only)" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/launcher.htm"> |
| <description> |
| To customize the launcher, perform the following steps: |
| </description> |
| <subitem label="Select the "Launcher" page of the product editor." skip="false"> |
| </subitem> |
| <subitem label="Input "browser" into the "Launcher Name" text box under the "Program Launcher" heading." skip="false"> |
| </subitem> |
| <subitem label="Select the "win32" tab under the "Program Launcher" heading and select the "Use a single ICO file containing 7 images as specified above" radio button." skip="true"> |
| </subitem> |
| <subitem label="Press the "Browse..." button adjacent to the "File" text box to select the "/org.eclipse.browser/branding/world_launcher.ico" file. Press "OK"." skip="true"> |
| </subitem> |
| <subitem label="Select "File->Save" from the main menu." skip="false"> |
| </subitem> |
| </item> |
| <item title="Export the product" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"> |
| <description> |
| To export the plug-in based product, perform the following steps: |
| </description> |
| <subitem label="Select the "Overview" page of the product editor." skip="false"> |
| </subitem> |
| <subitem label="Click the "Eclipse Product export wizard" hyperlink under the "Exporting" heading to bring up the "Eclipse Product" export wizard." skip="true"> |
| <command serialization="org.eclipse.ui.file.export(exportWizardId=org.eclipse.pde.ui.productExportWizard)" confirm="false"> |
| </command> |
| </subitem> |
| <subitem label="Input "browser" in the "Root directory" text field contained in the "Product Configuration" section." skip="false"> |
| </subitem> |
| <subitem label="Input a destination directory in the "Directory" text fiedl in the "Destination" section (e.g. "C:\destination" for Windows) and press "Finish"." skip="false"> |
| </subitem> |
| </item> |
| <item title="Browse the finished product" dialog="true" skip="false"> |
| <description> |
| To browse the exported plug-in 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:\destination" for Windows)" skip="false"> |
| </subitem> |
| <subitem label="Note the presence of the "browser" subdirectory. Expand it and examine the structure of your product. A "plugins" subdirectory containing all plug-ins, a "configuration" containing metadata." skip="true"> |
| </subitem> |
| <subitem label="Note the custom "browser" launcher with a branded icon ("browser.exe" on Windows) at the root of the "browser" directory." skip="true"> |
| </subitem> |
| <subitem label="Double-click on the "browser" executable to launch the product." skip="false"> |
| </subitem> |
| <subitem label="Observe the RCP product you created that is fully executable outside the Eclipse workspace." skip="true"> |
| </subitem> |
| <subitem label="Exit the product via "File > Exit" from the main menu." skip="false"> |
| </subitem> |
| </item> |
| </cheatsheet> |