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 plug-in 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 plug-in based

    22          product configuration for an RCP application and run an RCP application 

    23          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-&gt;Open Perspective-&gt;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="Create the product configuration"

    51          href="/org.eclipse.pde.doc.user/guide/tools/file_wizards/new_product_config.htm"

    52          dialog="true"

    53          skip="false">

    54       <description>

    55          To create the product configuration, perform the following steps:

    56       </description>

    57       <subitem label="Select &quot;File-&gt;New-&gt;Product Configuration&quot; from the main menu" 

    58                skip="false">

    59          <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProductConfigurationWizard)" required="false" translate="" />

    60       </subitem>

    61       <subitem label="Select &quot;com.example.rcpapp&quot; in the resulting &quot;New Product Configuration&quot; wizard page" 

    62                skip="false"/>

    63       <subitem label="Input &quot;rcpapp.product&quot; into the &quot;File name&quot; text box" 

    64                skip="false"/>

    65       <subitem label="Select the &quot;Use a launch configuration&quot; radio button inside the &quot;Initialize the file content&quot; group and click &quot;Finish&quot;" 

    66                skip="false"/>

    67    </item>

    68 

    69    <!-- Item -->

    70 

    71    <item title="Open the product editor"

    72          href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/editor.htm"

    73          dialog="false"

    74          skip="false">

    75       <description>

    76          To open the product editor (if it is not already open),

    77          expand the <b>com.example.rcpapp</b> tree dialog

    78          in the <b>Package Explorer</b> view and double-click

    79          on the <b>rcpapp.product</b> file (the <b>Overview</b> page

    80          should be open initially).

    81          <br/>

    82          <br/>

    83          Alternatively, click the following button to perform the task.         

    84       </description>

    85       <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" />

    86    </item>

    87 

    88    <!-- Item -->

    89 

    90    <item title="Define the product"

    91          href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"

    92          dialog="true"

    93          skip="false">

    94       <description>

    95          To define the product, perform the following steps:

    96       </description>

    97       <subitem label="Input &quot;RCP Application&quot; into the &quot;Name&quot; text box on the &quot;General Information&quot; section" 

    98                skip="false"/>

    99       <subitem label="Click the &quot;New...&quot; button next to the &quot;Product&quot; drop down menu to open the &quot;New Product Definition&quot; dialog box" 

   100                skip="false"/>

   101       <subitem label="Verify &quot;com.example.rcpapp&quot; is the inputted value for the &quot;Defining Plug-in&quot; text box" 

   102                skip="true"/>        

   103       <subitem label="Verify &quot;product&quot; is the inputted value for the &quot;Product ID&quot; text box" 

   104                skip="true"/>        

   105       <subitem label="Accept the defaults and click &quot;Finish&quot;" 

   106                skip="false"/>        

   107       <subitem label="Select &quot;File-&gt;Save&quot; from the main menu" 

   108                skip="false"/> 

   109    </item>

   110 

   111    <!-- Item -->

   112 

   113    <item title="Synchronize the product configuration with the defining plug-in"

   114          href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"

   115          dialog="true"

   116          skip="false">

   117       <description>

   118          Product configurations and their constituent files may become

   119          unsynchronized.  This situation is apparent when changes 

   120          made using the product editor are not reflected in the application.  

   121          <br/>

   122          <br/>

   123          To synchronize the product configuration with the defining plug-in, 

   124          click the <b>Synchronize</b> hyperlink under the <b>Testing</b>

   125          heading on the product editor <b>Overview</b> page.

   126          <br/>

   127          <br/>

   128          Note:  PDE automatically synchronizes the product configuration

   129          when the <b>Launch an Eclipse Application</b> hyperlinks under the 

   130          <b>Testing</b> heading are used.

   131       </description>

   132    </item>

   133 

   134    <!-- Item -->

   135 

   136    <item title="Run the RCP product"

   137          dialog="false"

   138          href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"

   139          skip="false">

   140       <description>

   141          To run the RCP product,

   142          perform the following steps:

   143       </description>

   144       <subitem label="Click the &quot;Launch an Eclipse application&quot; hyperlink under the &quot;Testing&quot; heading" 

   145                skip="false"/>

   146       <subitem label="Note: &quot;RCP Application&quot; now shows up in the window title bar" 

   147                skip="true"/>

   148       <subitem label="Exit the RCP application" 

   149                skip="false"/>

   150    </item>

   151 

   152 </cheatsheet>