| Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame^] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <cheatsheet title="Utilize custom extension"> |
| 3 | <intro> |
| 4 | <description> |
| 5 | This cheat sheet will demonstrate how to extend the example plug-in by adding a custom extesion using PDE. |
| 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->Open Perspective->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="Create a new plug-in" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/project_wizards/new_plugin_project.htm"> |
| 25 | <description> |
| 26 | To create the plug-in perform the following steps |
| 27 | </description> |
| 28 | <subitem label="Select "File->New->Project..." from the main menu, expand the "Plug-in Development" category within the resulting "New Project" dialog box, and choose "Plug-in Project"" skip="true"> |
| 29 | <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProjectWizard)" confirm="false"> |
| 30 | </command> |
| 31 | </subitem> |
| 32 | <subitem label="Input "org.eclipsecon.browser.extension" into the "Project Name" text box" skip="false"> |
| 33 | </subitem> |
| 34 | <subitem label="Accept the rest of the default preloaded values on the "Plug-in Project" page and click "Next >"" skip="false"> |
| 35 | </subitem> |
| 36 | <subitem label="Accept the default preloaded values on the "Plug-in Content" page and click "Finish"" skip="false"> |
| 37 | </subitem> |
| 38 | </item> |
| 39 | <item title="Define a useful links extension" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm"> |
| 40 | <description> |
| 41 | To define a view extension, perform the following steps: |
| 42 | </description> |
| 43 | <subitem label="Select the "Extensions" tab of the Manifest Editor (which should open automatically)" skip="false"> |
| 44 | </subitem> |
| 45 | <subitem label="Click the "Add" button in the "All Extensions" section, to open the "New Extension" wizard" skip="false"> |
| 46 | </subitem> |
| 47 | <subitem label="Deselect the checkbox labeled "Show only extension points from the required plug-ins"" skip="false"> |
| 48 | </subitem> |
| 49 | <subitem label="Select "org.eclipsecon.browser.usefulLinks" from the "Extension Points" list box and click "Finish"" skip="false"> |
| 50 | </subitem> |
| 51 | <subitem label="Select "Yes" when prompted "Do you want to add plug-in org.eclipsecon.browser, declaring the usefulLinks extension point, to the list of plug-in dependencies?"" skip="false"> |
| 52 | </subitem> |
| 53 | </item> |
| 54 | <item title="Add new link object" dialog="false" skip="true" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm"> |
| 55 | <description> |
| 56 | To add an additional link object, perform the following steps: |
| 57 | </description> |
| 58 | <subitem label="Select "org.eclipsecon.browser.usefulLinks" in the list box under "All Extensions" heading in the "Extensions" page" skip="false"> |
| 59 | </subitem> |
| 60 | <subitem label="Right-click and select "New->linkObject" from the context menu" skip="false"> |
| 61 | </subitem> |
| 62 | <subitem label="Replace the content of the "name" text box under "Extension Element Details" with "Eclipse Articles"" skip="false"> |
| 63 | </subitem> |
| 64 | <subitem label="Replace the content of the "link" text box with "http://www.eclipse.org/articles/"" skip="false"> |
| 65 | </subitem> |
| 66 | <subitem label="Replace the content of the "description" text box with "Web site to find eclipse related articles"" skip="false"> |
| 67 | </subitem> |
| 68 | <subitem label="Select "File->Save" from the main menu" skip="false"> |
| 69 | </subitem> |
| 70 | </item> |
| 71 | <item title="Test the plug-in" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/launchers/eclipse_application_launcher.htm"> |
| 72 | <description> |
| 73 | To test your Eclipse plug-in inside a target Eclipse platform, |
| 74 | perform the following steps: |
| 75 | </description> |
| 76 | <subitem label="Select the "Overview" tab of the Manifest Editor" skip="true"> |
| 77 | <command serialization="org.eclipse.ui.navigate.openResource(filePath=/org.eclipsecon.browser.extension/META-INF/MANIFEST.MF)" confirm="false"> |
| 78 | </command> |
| 79 | </subitem> |
| 80 | <subitem label="Click the "Launch an Eclipse application" hyperlink under the "Testing" heading" skip="false"> |
| 81 | </subitem> |
| 82 | <subitem label="Select "Window->Show View->Other..." from the main menu in the newly launched Eclipse platform" skip="false"> |
| 83 | </subitem> |
| 84 | <subitem label="Select "EclipseCon>Links" and click the "OK" button" skip="false"> |
| 85 | </subitem> |
| 86 | <subitem label="Note the "Eclipse Homepage" and "Eclipse Articles" links under the "Useful Links" section in the Links view" skip="false"> |
| 87 | </subitem> |
| 88 | <subitem label="Select "File->Exit" from the main menu to exit the target Eclipse platform" skip="false"> |
| 89 | </subitem> |
| 90 | </item> |
| 91 | </cheatsheet> |