| <?xml version="1.0" encoding="UTF-8" ?> |
| |
| <!-- Simple Cheat Sheet --> |
| |
| <cheatsheet title="Create an update site"> |
| |
| <!-- Introduction --> |
| |
| <intro href="/org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm"> |
| <description> |
| This cheat sheet will demonstrate how to create an update site for a plug-in |
| using PDE. |
| <br/> |
| <br/> |
| To learn more about using cheat sheets, click the help button |
| in the top right corner (?). |
| </description> |
| </intro> |
| |
| |
| <!-- Item --> |
| |
| <item title="Open the plug-in development perspective" |
| href="/org.eclipse.pde.doc.user/guide/tools/views/views.htm" |
| dialog="false" |
| skip="false"> |
| <description> |
| To open the plug-in development perspective, |
| select <b>Window->Open Perspective->Other...</b> |
| and choose <b>Plug-in Development</b>. |
| <br/> |
| <br/> |
| Alternatively, click the following button to perform the task. |
| </description> |
| <command serialization="org.eclipse.ui.perspectives.showPerspective(org.eclipse.ui.perspectives.showPerspective.perspectiveId=org.eclipse.pde.ui.PDEPerspective)" required="false" translate="" /> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Create the update site" |
| dialog="true" |
| href="/org.eclipse.pde.doc.user/guide/tools/project_wizards/new_update_site_project.htm" |
| skip="false"> |
| <description> |
| To create the update site, perform the following steps: |
| </description> |
| <subitem label="Select "File->New->Project...", and choose "Update Site Project" under the "Plug-in Development" heading" |
| skip="false"> |
| <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewSiteProjectWizard)" required="false" translate="" /> |
| </subitem> |
| <subitem label="Input "helloworld.site" into the "Project Name" text box on the "Update Site Project" page" |
| skip="false"/> |
| <subitem label="Deselect the "Use default location" text box" |
| skip="false"/> |
| <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." |
| skip="true"/> |
| <subitem label="Input "C:\helloworld.site" in the "Location" text box and click "Finish"" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Create the update site description" |
| dialog="false" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/archives.htm" |
| skip="false"> |
| <description> |
| The site editor should be open on the <b>Site Map</b> tab. |
| <br/> |
| <br/> |
| To create the update site description, perform the following steps: |
| </description> |
| <subitem label="Select the "Archives" tab" |
| skip="false"/> |
| <subitem label="Input "file:///C:/helloworld.site/" into the "URL" text box" |
| skip="false"/> |
| <subitem label="Input "Hello World! Update Site" into the "Description" text box" |
| skip="false"/> |
| <subitem label="Click "File->Save" from the main menu" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Create a feature category" |
| dialog="false" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
| skip="false"> |
| <description> |
| To create a feature category, perform the following steps: |
| </description> |
| <subitem label="Select the "Site Map" tab from the site editor" |
| skip="false"/> |
| <subitem label="Click the "New Category;" button" |
| skip="false"/> |
| <subitem label="Input "Hello World!" into the "Name" text box" |
| skip="false"/> |
| <subitem label="Input "Hello World!" into the "Label" text box" |
| skip="false"/> |
| <subitem label="Click "File->Save" from the main menu" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Add a feature to a feature category" |
| dialog="true" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
| skip="false"> |
| <description> |
| To add a feature to a feature category, perform the following steps: |
| </description> |
| <subitem label="Select the "Hello World!" feature category in the "Managing the Site" list box" |
| skip="false"/> |
| <subitem label="Click the "Add Feature..." button" |
| skip="false"/> |
| <subitem label="Select "com.example.feature" from the list box and click "OK"" |
| skip="false"/> |
| <subitem label="Click "File->Save" from the main menu" |
| skip="false"/> |
| </item> |
| |
| <!-- Item --> |
| |
| <item title="Build and export a feature to an update site" |
| dialog="false" |
| href="/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/site_map.htm" |
| skip="false"> |
| <description> |
| To build a feature and export it to an update site, perform the following steps: |
| </description> |
| <subitem label="Click the "Build All" button" |
| skip="false"/> |
| <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)" |
| skip="true"/> |
| <subitem label="Verify the "com.example.feature_1.0.0.jar" jar file has been created in the "features" folders on the update site" |
| skip="true"/> |
| |
| |
| </item> |
| |
| </cheatsheet> |
