blob: 32a15755a1fbd4adbd17c322c9ca772b9a599cd7 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8" ?>
<cheatsheet title="Creating a plug-in">
<intro
href="/org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">
<description>
This cheat sheet will automatically launch wizards,
perform actions, and guide you through the individual
steps to create a plug-in using the Plug-in Development
Environment (PDE). To learn more about using cheat
sheets or to see a list of available cheat sheets
click help (?). To start working on this cheat sheet,
click the &quot;Click to Begin&quot; button below.
</description>
</intro>
<item
href="/org.eclipse.pde.doc.user/guide/pde_configuring.htm"
title="Configuring PDE">
<action
pluginId="org.eclipse.pde.ui"
class="org.eclipse.pde.internal.ui.wizards.imports.ShowTargetPlatformAction"/>
<description>
Select the &quot;Target Platform&quot; page under
Plug-in Development in the Window-&gt;Preferences
dialog and verify the location of your target
platform. This step sets the run-time workbench
instance path. You don't need to change this
value to continue with the tutorial.
The &quot;Target Platform&quot; page
is automatically launched when you click
the &quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_setup.htm"
title="Setting up the Workbench">
<action
pluginId="org.eclipse.pde.ui"
class="org.eclipse.pde.internal.ui.OpenPDEPerspectiveAction"/>
<description>
Select Window-&gt;Open Perspective-&gt;Other... and
choose Plug-in Development. This step changes the
perspective to set up the workbench for PDE.
The &quot;Plug-in Development&quot; perspective is
automatically displayed when you click the &quot;Click
to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_creating.htm"
title="Creating a New Plug-in Project"
skip="true">
<action
pluginId="org.eclipse.pde.ui"
param1="com.example.xyz"
param2="org.eclipse.pde.ui.pluginContent.helloWorld"
class="org.eclipse.pde.internal.ui.wizards.plugin.OpenProjectWizardAction"/>
<description>
Select File-&gt;New-&gt;Project... and choose Plug-in
Project in the list of wizards under the &quot;Plug-in
Development&quot; category. Accept the preloaded
default values. This step creates the plug-in
project using the 'Hello, World' template.
The preset &quot;New Plug-in Project&quot; wizard
is automatically displayed when you click
the &quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_manifest_dependencies.htm"
title="Editing the Dependencies Section of the Plug-in Manifest File">
<description>
Select the Dependencies page tab in the Plug-in
manifest editor and inspect the required plug-ins.
Required plug-ins affect the classpath and class loading
of the plug-in you are developing.
This is a manual task, you will need to perform the work and
click the &quot;Click to Complete&quot; button to
move to the next step.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_manifest_extensions.htm"
title="Editing the Extensions Section of the Plug-in Manifest File">
<description>
Select the Extensions page tab in the Plug-in manifest
editor and inspect the created extensions.
Select elements in the tree and observe their
values.
This is a manual task, you will need to
perform the work and click
the &quot;Click to Complete&quot; button to move to
the next step.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_manifest_runtime.htm"
title="Editing the Runtime Section of the Plug-in Manifest File">
<description>
Select the Runtime page tab in the Plug-in
manifest editor and inspect the declared
runtime libraries and associated information.
This is a manual task, you will need to perform the
work and click the "Click to Complete" button to move
to the next step.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_manifest_extensionpoints.htm"
title="Editing the Extension Points Section of the Plug-in Manifest File">
<description>
Select the Extension Points page tab in the Plug-in
manifest editor. You can define extension points
that other plug-ins can extend in this page.
This is a manual task, you will need to perform the
work and click the &quot;Click to Complete&quot;
button to move to the next step.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_running.htm"
title="Running the plug-in">
<action
pluginId="org.eclipse.pde.ui"
class="org.eclipse.pde.internal.ui.launcher.RunWorkbenchAction"/>
<description>
Select Run-&gt;Run... Select 'Run-time Workbench'
and create a new launch configuration for it.
Accept the default and click Run. From the Welcome
page, select "Go to the workbench". In the menu bar
of the new runtime workbench click the new sample
menu item and select the new sample action.
This step will open a 'Hello, World' message box
to indicate that the new plug-in is working
properly. The &quot;Run&quot; shortcut is
automatically created and executed when you click
the &quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_deploy.htm"
title="Deploying a plug-in">
<action
pluginId="org.eclipse.pde.ui"
class="org.eclipse.pde.internal.ui.editor.plugin.PluginExportAction"/>
<description>
Select File-&gt;Export...-&gt;Deployable plug-ins and fragments
and select the newly created plug-in in the list.
This step packages the workspace plug-in in a format that
will make it easily deployable in any Eclipse product.
The "Deployable plug-ins and fragments"
dialog is automatically displayed when you click
the &quot;Click to Perform&quot; button.
</description>
</item>
</cheatsheet>