blob: 0c554b7119a04a39329f3db707d2fe11556f6097 [file] [log] [blame]
Brian Bauman20fbfb72007-02-13 02:25:52 +00001<?xml version="1.0" encoding="UTF-8"?>
2<cheatsheet title="Importing PDE example">
3 <intro>
4 <description>
5 This cheat sheet will demonstrate how to import and run the PDE tutorial example.
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>
12 <item title="Open the plug-in development perspective" dialog="false" skip="true" href="/org.eclipse.pde.doc.user/guide/tools/views/views.htm">
13 <description>
14 To open the plug-in development perspective,
15 select <b>Window-&gt;Open Perspective-&gt;Other...</b>
16 and choose <b>Plug-in Development</b>.
17 <br/>
18 <br/>
19 Alternatively, click the following button to perform the task.
20 </description>
21 <command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.pde.ui.PDEPerspective)" confirm="false">
22 </command>
23 </item>
24 <item title="Import Sample Plugin" dialog="true" skip="false">
25 <description>
26 To import the sample plug-in for the PDE tutorial,
27 perform the following steps:
28 </description>
29 <subitem label="Select &quot;File-&gt;Import...&quot; from the main menu, expand the &quot;Plug-in Development&quot; category within the resulting &quot;Import&quot; wizard, and choose &quot;Plugins and Fragments&quot;" skip="false">
30 </subitem>
31 <subitem label="Deselect the checkbox labeled &quot;The target platform (as specified in the Preferences)&quot;. Then click the Browse button and go to !!!!!!!!!!!!!!!!. Lastly, select the &quot;Projects with source folders&quot; radio button in the &quot;Import As&quot; section towards the bottom of the page. Click &quot;Next&quot;" skip="false">
32 </subitem>
33 <subitem label="Select the &quot;org.eclipsecon.browser&quot; plug-in in the &quot;Plug-ins and Fragments found&quot; table, click the &quot;Add--&gt;&quot; button, and select &quot;Finish&quot;" skip="false">
34 </subitem>
35 </item>
36 <item title="Open the plug-in editor" dialog="false" skip="true" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/editor.htm">
37 <description>
38 To open the plug-in editor (if it is not already open),
39 expand the <b>org.eclipsecon.browser</b> tree dialog
40 in the <b>Package Explorer</b> view and double-click
41 on the <b>plugin.xml</b> file (the <b>Extensions</b> page
42 should be open initially).
43 <br/>
44 <br/>
45 Alternatively, click the following button to perform the task.
46 </description>
47 <command serialization="org.eclipse.ui.navigate.openResource(filePath=/org.eclipsecon.browser/plugin.xml)" confirm="false">
48 </command>
49 </item>
50 <item title="Define a view extension" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm">
51 <description>
52 To define a view extension, perform the following steps:
53 </description>
54 <subitem label="Click the &quot;Add&quot; button to open the &quot;New Extension&quot; wizard" skip="false">
55 </subitem>
56 <subitem label="Select &quot;org.eclipse.ui.views&quot; from the &quot;Extension Points&quot; list box and click &quot;Finish&quot;" skip="false">
57 </subitem>
58 </item>
59 <item title="Add a view category" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm">
60 <description>
61 To define a view category, perform the following steps:
62 </description>
63 <subitem label="Select &quot;org.eclipse.ui.views&quot; in the list box under &quot;All Extensions&quot; heading in the &quot;Extensions&quot; page" skip="false">
64 </subitem>
65 <subitem label="Right-click and select &quot;New-&gt;category&quot; from the context menu" skip="false">
66 </subitem>
67 <subitem label="Replace the content of the &quot;id&quot; text box under &quot;Extension Element Details&quot; with &quot;org.eclipsecon.browser.category&quot;" skip="false">
68 </subitem>
69 <subitem label="Replace the content of the &quot;name&quot; text box with &quot;%category.name.browser&quot;" skip="false">
70 </subitem>
71 <subitem label="Select &quot;File-&gt;Save&quot; from the main menu" skip="false">
72 </subitem>
73 </item>
74 <item title="Add a view" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm">
75 <description>
76 To define a view, perform the following steps:
77 </description>
78 <subitem label="Select &quot;org.eclipse.ui.views&quot; in the list box under &quot;All Extensions&quot; heading in the &quot;Extensions&quot; page" skip="false">
79 </subitem>
80 <subitem label="Right-click and select &quot;New-&gt;view&quot; from the context menu" skip="false">
81 </subitem>
82 <subitem label="Replace the content of the &quot;id&quot; text box under &quot;Extension Element Details&quot; with &quot;org.eclipsecon.browser.view&quot;" skip="false">
83 </subitem>
84 <subitem label="Replace the content of the &quot;name&quot; text box with &quot;%view.name.links&quot;" skip="false">
85 </subitem>
86 <subitem label="Replace the content of the &quot;class&quot; text box with &quot;org.eclipsecon.browser.view.ui.EclipseLinksView&quot;" skip="false">
87 </subitem>
88 <subitem label="Replace the content of the &quot;category&quot; text box with &quot;org.eclipsecon.browser.category&quot;" skip="false">
89 </subitem>
90 <subitem label="Replace the content of the &quot;icon&quot; text box with &quot;icons/eclipse_icon.gif&quot;" skip="false">
91 </subitem>
92 <subitem label="In the &quot;allowMultiple&quot; combo, select &quot;false&quot;" skip="false">
93 </subitem>
94 <subitem label="Select &quot;File-&gt;Save&quot; from the main menu" skip="false">
95 </subitem>
96 </item>
97 <item title="Add a sticky view" dialog="false" skip="true">
98 <description>
99 To define a stickyView, perform the following steps:
100 </description>
101 <subitem label="Select &quot;org.eclipse.ui.views&quot; in the list box under &quot;All Extensions&quot; heading in the &quot;Extensions&quot; page" skip="false">
102 </subitem>
103 <subitem label="Right-click and select &quot;New-&gt;stickyView&quot; from the context menu" skip="false">
104 </subitem>
105 <subitem label="Replace the content of the &quot;id&quot; text box under &quot;Extension Element Details&quot; with &quot;org.eclipsecon.browser.view&quot;" skip="false">
106 </subitem>
107 <subitem label="From the &quot;location&quot; combo under &quot;Extension Element Details&quot; select &quot;RIGHT&quot;" skip="false">
108 </subitem>
109 <subitem label="From the &quot;closeable&quot; combo select &quot;true&quot;" skip="false">
110 </subitem>
111 <subitem label="From the &quot;moveable&quot; combo select &quot;true&quot;" skip="false">
112 </subitem>
113 <subitem label="Select &quot;File-&gt;Save&quot; from the main menu" skip="false">
114 </subitem>
115 </item>
116 <item title="Test the plug-in" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/launchers/eclipse_application_launcher.htm">
117 <description>
118 To test your Eclipse plug-in inside a target Eclipse platform,
119 perform the following steps:
120 </description>
121 <subitem label="Open the plug-in editor and select the &quot;Overview&quot; tab" skip="true">
122 <command serialization="org.eclipse.ui.navigate.openResource(filePath=/org.eclipsecon.browser/META-INF/MANIFEST.MF)" confirm="false">
123 </command>
124 </subitem>
125 <subitem label="Click the &quot;Launch an Eclipse application&quot; hyperlink under the &quot;Testing&quot; heading" skip="false">
126 </subitem>
127 <subitem label="Select &quot;Window-&gt;Show View-&gt;Other...&quot; from the main menu in the newly launched Eclipse platform" skip="false">
128 </subitem>
129 <subitem label="Note the &quot;EclipseCon&quot; category and expand its tree dialog" skip="false">
130 </subitem>
131 <subitem label="Select the &quot;Links&quot; view and click the &quot;OK&quot; button" skip="false">
132 </subitem>
133 <subitem label="Select &quot;File-&gt;Exit&quot; from the main menu to exit the target Eclipse platform" skip="false">
134 </subitem>
135 </item>
136</cheatsheet>