Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 2 | <cheatsheet title="Extend the Eclipse Browser view"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 3 | <intro> |
| 4 | <description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 5 | This cheat sheet will demonstrate how to extend the Eclipse Browser view by adding a custom extesion using PDE. |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 6 | <br/> |
| 7 | <br/> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 8 | To learn more about using cheat sheets, click the help button |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 9 | in the top right corner (?). |
| 10 | </description> |
| 11 | </intro> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 12 | <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"> |
| 13 | <description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 14 | To create the plug-in, perform the following steps: |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 15 | </description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 16 | <subitem label="Select "File->New->Project..." from the main menu to bring up the "New Project" wizard. Expand the "Plug-in Development" category, choose "Plug-in Project" and press "Next"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 17 | <command serialization="org.eclipse.ui.newWizard(newWizardId=org.eclipse.pde.ui.NewProjectWizard)" confirm="false"> |
| 18 | </command> |
| 19 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 20 | <subitem label="Input "org.eclipse.browser.extension" into the "Project Name" text box. Accept all defaults and press "Next"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 21 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 22 | <subitem label="Accept all default values on the "Plug-in Content" page and press "Finish". A new plug-in project will be created and the plug-in manifest editor will open automatically." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 23 | </subitem> |
| 24 | </item> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 25 | <item title="Define a new link" dialog="true" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 26 | <description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 27 | To contribute a new link to the Eclipse Browser view, perform the following steps: |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 28 | </description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 29 | <subitem label="On the "Extensions" page of the plug-in manifest editor, click the "Add..." button in the "All Extensions" section to open the "New Extension" wizard." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 30 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 31 | <subitem label="Deselect the checkbox labeled "Show only extension points from the required plug-ins"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 32 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 33 | <subitem label="Select "org.eclipse.browser.usefulLinks" from the "Extension Points" list box and press "Finish"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 34 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 35 | <subitem label="Select "No" 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"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 36 | </subitem> |
| 37 | </item> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 38 | <item title="Add new link object" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/extensions.htm"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 39 | <description> |
| 40 | To add an additional link object, perform the following steps: |
| 41 | </description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 42 | <subitem label="Right-click the "org.eclipse.browser.usefulLinks" in the list box under "All Extensions" heading in the "Extensions" page and select "New->linkObject" from the context menu." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 43 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 44 | <subitem label="Replace the content of the "name" text box under "Extension Element Details" with "Eclipse Articles"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 45 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 46 | <subitem label="Replace the content of the "link" text box with "http://www.eclipse.org/articles/"." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 47 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 48 | <subitem label="Right-click on the "linkObject" element and select "New>description" from the context menu." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 49 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 50 | <subitem label="Select the "description" element. Expand the "Body Text" section at the bottom of the "Extensions" page and input "Web site to find Eclipse-related articles" in the text area." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 51 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 52 | <subitem label="Select "File->Save" from the main menu." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 53 | </subitem> |
| 54 | </item> |
| 55 | <item title="Test the plug-in" dialog="false" skip="false" href="/org.eclipse.pde.doc.user/guide/tools/launchers/eclipse_application_launcher.htm"> |
| 56 | <description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 57 | To test your plug-in, perform the following steps: |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 58 | </description> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 59 | <subitem label="On the "Overview" of the plug-in manifest editor, click the "Launch an Eclipse application" hyperlink under the "Testing" heading to launch a second instance of Eclipse." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 60 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 61 | <subitem label="Note the "Eclipse Articles" link under the "Useful Links" section in the Eclipse Browser view. Click on it to view the associated web site in an embedded browser." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 62 | </subitem> |
Wassim Melhem | 2f0a491 | 2007-02-19 09:50:03 +0000 | [diff] [blame] | 63 | <subitem label="Select "File->Exit" from the main menu to close the second Eclipse instance." skip="false"> |
Brian Bauman | 20fbfb7 | 2007-02-13 02:25:52 +0000 | [diff] [blame] | 64 | </subitem> |
| 65 | </item> |
| 66 | </cheatsheet> |