|
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="Create an update site"> |
|
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 create an update site for a plug-in |
|
22 using PDE. |
|
23 <br/> |
|
24 <br/> |
|
25 To learn more about using cheat sheets, click the help button |
|
26 in the top right corner (?). |
|
27 </description> |
|
28 </intro> |
|
29 |
|
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->Open Perspective->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 update site" |
|
51 dialog="true" |
|
52 href="/org.eclipse.pde.doc.user/guide/tools/project_wizards/new_update_site_project.htm" |
|
53 skip="false"> |
|
54 <description> |
|
55 To create the update site, perform the following steps: |
|
56 </description> |
|
57 <subitem label="Select "File->New->Project...", and choose "Update Site Project" under the "Plug-in Development" heading" |
|
58 skip="false"> |
|
59 <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewSiteProjectWizard)" required="false" translate="" /> |
|
60 </subitem> |
|
61 <subitem label="Input "helloworld.site" into the "Project Name" text box on the "Update Site Project" page" |
|
62 skip="false"/> |
|
63 <subitem label="Deselect the "Use default location" text box" |
|
64 skip="false"/> |
|
65 <subitem label="Note: For the purpose of this cheat sheet we will define a Windows pathname for our update site location. For Unix platforms, adjust accordingly." |
|
66 skip="true"/> |
|
67 <subitem label="Input "C:\helloworld.site" in the "Location" text box and click "Finish"" |
|
68 skip="false"/> |
|
69 </item> |
|
70 |
|
71 <!-- Item --> |
|
72 |
|
73 <item title="Create the update site description" |
|
74 dialog="false" |
|
75 href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/archives.htm" |
|
76 skip="false"> |
|
77 <description> |
|
78 The site editor should be open on the <b>Site Map</b> tab. |
|
79 <br/> |
|
80 <br/> |
|
81 To create the update site description, perform the following steps: |
|
82 </description> |
|
83 <subitem label="Select the "Archives" tab" |
|
84 skip="false"/> |
|
85 <subitem label="Input "file:///C:/helloworld.site/" into the "URL" text box" |
|
86 skip="false"/> |
|
87 <subitem label="Input "Hello World! Update Site" into the "Description" text box" |
|
88 skip="false"/> |
|
89 <subitem label="Click "File->Save" from the main menu" |
|
90 skip="false"/> |
|
91 </item> |
|
92 |
|
93 <!-- Item --> |
|
94 |
|
95 <item title="Create a feature category" |
|
96 dialog="false" |
|
97 href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
|
98 skip="false"> |
|
99 <description> |
|
100 To create a feature category, perform the following steps: |
|
101 </description> |
|
102 <subitem label="Select the "Site Map" tab from the site editor" |
|
103 skip="false"/> |
|
104 <subitem label="Click the "New Category" button" |
|
105 skip="false"/> |
|
106 <subitem label="Input "Hello World!" into the "Name" text box" |
|
107 skip="false"/> |
|
108 <subitem label="Input "Hello World!" into the "Label" text box" |
|
109 skip="false"/> |
|
110 <subitem label="Click "File->Save" from the main menu" |
|
111 skip="false"/> |
|
112 </item> |
|
113 |
|
114 <!-- Item --> |
|
115 |
|
116 <item title="Add a feature to a feature category" |
|
117 dialog="true" |
|
118 href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
|
119 skip="false"> |
|
120 <description> |
|
121 To add a feature to a feature category, perform the following steps: |
|
122 </description> |
|
123 <subitem label="Select the "Hello World!" feature category in the "Managing the Site" list box" |
|
124 skip="false"/> |
|
125 <subitem label="Click the "Add Feature..." button" |
|
126 skip="false"/> |
|
127 <subitem label="Select "com.example.feature" from the list box and click "OK"" |
|
128 skip="false"/> |
|
129 <subitem label="Click "File->Save" from the main menu" |
|
130 skip="false"/> |
|
131 </item> |
|
132 |
|
133 <!-- Item --> |
|
134 |
|
135 <item title="Build and export a feature to an update site" |
|
136 dialog="false" |
|
137 href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
|
138 skip="false"> |
|
139 <description> |
|
140 To build a feature and export it to an update site, perform the following steps: |
|
141 </description> |
|
142 <subitem label="Click the "Build All" button" |
|
143 skip="false"/> |
|
144 <subitem label="Verify the "com.example.helloworld_1.0.0.jar" jar file has been created in the "plugins" folders on the update site (See the "Package Explorer" view or the "C:\helloworld.site" folder)" |
|
145 skip="true"/> |
|
146 <subitem label="Verify the "com.example.feature_1.0.0.jar" jar file has been created in the "features" folders on the update site" |
|
147 skip="true"/> |
|
148 |
|
149 |
|
150 </item> |
|
151 |
|
152 </cheatsheet> |