carbidecpp22devenv/configuration/org.eclipse.osgi/bundles/188/1/.cp/cheatsheets/rcpapp/rcpapp-plugin-product.xml
author cawthron
Fri, 04 Dec 2009 10:01:33 -0600
changeset 5 684bf18fdedf
permissions -rw-r--r--
add files for RCL_2_2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8" ?>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     2
<!--
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     3
     Copyright (c) 2005, 2009 IBM Corporation and others.
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     4
     All rights reserved. This program and the accompanying materials
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     5
     are made available under the terms of the Eclipse Public License v1.0
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     6
     which accompanies this distribution, and is available at
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     7
     http://www.eclipse.org/legal/epl-v10.html
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     8
    
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
     9
     Contributors:
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    10
         IBM Corporation - initial API and implementation
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    11
 -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    12
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    13
<!-- Simple Cheat Sheet -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    14
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    15
<cheatsheet title="Define a plug-in based product">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    16
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    17
   <!-- Introduction -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    18
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    19
   <intro href="/org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    20
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    21
         This cheat sheet will demonstrate how to define a plug-in based
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    22
         product configuration for an RCP application and run an RCP application 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    23
         product using PDE.  
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    24
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    25
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    26
         To learn more about using cheat sheets, click the help button
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    27
         in the top right corner (?). 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    28
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    29
   </intro>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    30
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    31
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    32
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    33
   <item title="Open the plug-in development perspective"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    34
         href="/org.eclipse.pde.doc.user/guide/tools/views/views.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    35
         dialog="false"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    36
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    37
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    38
         To open the plug-in development perspective,
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    39
         select <b>Window-&gt;Open Perspective-&gt;Other...</b> 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    40
         and choose <b>Plug-in Development</b>.
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    41
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    42
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    43
         Alternatively, click the following button to perform the task.
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    44
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    45
      <command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.pde.ui.PDEPerspective)" required="false" translate="" />
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    46
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    47
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    48
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    49
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    50
   <item title="Create the product configuration"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    51
         href="/org.eclipse.pde.doc.user/guide/tools/file_wizards/new_product_config.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    52
         dialog="true"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    53
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    54
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    55
         To create the product configuration, perform the following steps:
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    56
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    57
      <subitem label="Select &quot;File-&gt;New-&gt;Product Configuration&quot; from the main menu" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    58
               skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    59
         <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProductConfigurationWizard)" required="false" translate="" />
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    60
      </subitem>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    61
      <subitem label="Select &quot;com.example.rcpapp&quot; in the resulting &quot;New Product Configuration&quot; wizard page" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    62
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    63
      <subitem label="Input &quot;rcpapp.product&quot; into the &quot;File name&quot; text box" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    64
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    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;" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    66
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    67
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    68
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    69
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    70
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    71
   <item title="Open the product editor"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    72
         href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/editor.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    73
         dialog="false"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    74
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    75
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    76
         To open the product editor (if it is not already open),
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    77
         expand the <b>com.example.rcpapp</b> tree dialog
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    78
         in the <b>Package Explorer</b> view and double-click
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    79
         on the <b>rcpapp.product</b> file (the <b>Overview</b> page
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    80
         should be open initially).
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    81
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    82
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    83
         Alternatively, click the following button to perform the task.         
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    84
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    85
      <command serialization="org.eclipse.ui.navigate.openResource(filePath=/com.example.rcpapp/rcpapp.product)" required="false" translate="" />
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    86
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    87
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    88
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    89
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    90
   <item title="Define the product"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    91
         href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    92
         dialog="true"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    93
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    94
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    95
         To define the product, perform the following steps:
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    96
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    97
      <subitem label="Input &quot;RCP Application&quot; into the &quot;Name&quot; text box on the &quot;General Information&quot; section" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    98
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
    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" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   100
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   101
      <subitem label="Verify &quot;com.example.rcpapp&quot; is the inputted value for the &quot;Defining Plug-in&quot; text box" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   102
               skip="true"/>        
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   103
      <subitem label="Verify &quot;product&quot; is the inputted value for the &quot;Product ID&quot; text box" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   104
               skip="true"/>        
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   105
      <subitem label="Accept the defaults and click &quot;Finish&quot;" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   106
               skip="false"/>        
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   107
      <subitem label="Select &quot;File-&gt;Save&quot; from the main menu" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   108
               skip="false"/> 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   109
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   110
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   111
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   112
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   113
   <item title="Synchronize the product configuration with the defining plug-in"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   114
         href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   115
         dialog="true"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   116
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   117
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   118
         Product configurations and their constituent files may become
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   119
         unsynchronized.  This situation is apparent when changes 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   120
         made using the product editor are not reflected in the application.  
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   121
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   122
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   123
         To synchronize the product configuration with the defining plug-in, 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   124
         click the <b>Synchronize</b> hyperlink under the <b>Testing</b>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   125
         heading on the product editor <b>Overview</b> page.
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   126
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   127
         <br/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   128
         Note:  PDE automatically synchronizes the product configuration
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   129
         when the <b>Launch an Eclipse Application</b> hyperlinks under the 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   130
         <b>Testing</b> heading are used.
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   131
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   132
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   133
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   134
   <!-- Item -->
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   135
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   136
   <item title="Run the RCP product"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   137
         dialog="false"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   138
         href="/org.eclipse.pde.doc.user/guide/tools/editors/product_editor/overview.htm"
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   139
         skip="false">
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   140
      <description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   141
         To run the RCP product,
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   142
         perform the following steps:
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   143
      </description>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   144
      <subitem label="Click the &quot;Launch an Eclipse application&quot; hyperlink under the &quot;Testing&quot; heading" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   145
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   146
      <subitem label="Note: &quot;RCP Application&quot; now shows up in the window title bar" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   147
               skip="true"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   148
      <subitem label="Exit the RCP application" 
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   149
               skip="false"/>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   150
   </item>
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   151
684bf18fdedf add files for RCL_2_2
cawthron
parents:
diff changeset
   152
</cheatsheet>