Initial commit

This commit is contained in:
Eagle517
2026-01-14 10:27:57 -06:00
commit c1576fee30
11290 changed files with 1552799 additions and 0 deletions

View File

@@ -0,0 +1,165 @@
<?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>

View File

@@ -0,0 +1,199 @@
<?xml version="1.0" encoding="UTF-8" ?>
<cheatsheet title="Creating and publishing a feature">
<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 feature and publish it
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_setup.htm"
title="Switching to the PDE perspective">
<action
pluginId="org.eclipse.pde.ui"
class="org.eclipse.pde.internal.ui.OpenPDEPerspectiveAction"/>
<description>
Select <b>Window-&gt;Open Perspective-&gt;Other...-&gt;Plug-in Development</b>
to switch to the PDE perspective. The PDE perspective is
automatically launched 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 the 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 <b>File-&gt;New-&gt;Plug-in Project</b> to bring up the plug-in
project creation wizard. Choose 'com.example.xyz' for the project
name. Accept all the defaults. Pick the <b>Hello, World</b> template
from the list of templates and press <b>Finish</b>. The wizard
is automatically launched when you click the
&quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_feature_setup.htm"
title="Creating the feature project"
skip="true">
<action
pluginId="org.eclipse.pde.ui"
param1="com.example.xyz-feature"
param2="com.example.xyz"
param3="XYZ Feature"
class="org.eclipse.pde.internal.ui.wizards.feature.OpenProjectWizardAction"/>
<description>
Select <b>File-&gt;New-&gt;Feature Project</b> to bring up the
feature project creation wizard. Choose 'com.example.xyz-feature'
for the project name. Choose 'com.example.xyz' for the feature id
and 'XYZ Feature' for the feature name.
Check 'com.example.xyz' plug-in in the list of plug-ins and
press <b>Finish</b>. The wizard
is automatically launched when you click the
&quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_feature_manifest.htm"
title="Adding description and license agreement">
<description>
Switch to the <b>Information</b> page of the feature
editor opened as a result of the previous step. Enter
a short description
in the <b>Description</b> tab. Switch to the <b>License Agreement</b>
tab and enter a short license text (features without
a license will not be accepted by Eclipse Update).
Press 'Ctrl+S' to save the file.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_setup.htm"
title="Creating an update site project"
skip="true">
<action
pluginId="org.eclipse.pde.ui"
param1="updates"
class="org.eclipse.pde.internal.ui.wizards.site.OpenProjectWizardAction"/>
<description>
Select <b>File-&gt;New-&gt;Project-&gt;Plug-in Development-&gt;Update Site Project</b>
to bring up the update site project creation wizard.
Choose 'updates' for the project name and
press <b>Finish</b>. The wizard
is automatically launched when you click the
&quot;Click to Perform&quot; button.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_editor.htm"
title="Selecting features to build">
<description>
Select <b>Add...</b> in <b>Features to Build</b>
section and check 'com.example.xyz' from the list.
Verify that the feature appears in the section
upon clicking <b>Finish</b>.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_editor.htm"
title="Creating a feature category">
<description>
Select <b>New Category...</b> in <b>Features to Publish</b>
section and enter 'sample' for category name,
'Sample' for the label and some random text
for description.
Verify that the category appears in the section
upon clicking <b>OK</b>.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_editor.htm"
title="Adding feature to category">
<description>
Select 'com.example.xyz' feature in
<b>Features to Build</b> section and
drag it to the 'Sample' category in
<b>Features to Publish</b> section.
Verify that the feature appears as a child
of the category.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_building.htm"
title="Saving and building">
<description>
Select 'Ctrl+S' to save the file. Select the
<b>Build All</b> button in the <b>Features to Build</b>
section. Verify that 'plugins' and 'features'
folders in the update site project contain
JARs after the build is done.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_previewing.htm"
title="Testing the update site">
<action
pluginId="org.eclipse.ui.ide"
class="org.eclipse.ui.internal.ide.update.InstallWizardAction"/>
<description>
Select <b>Help-&gt;Software Updates-&gt;Find and Install...</b>.
The wizard is automatically launched when you click the
&quot;Click to Perform&quot; button.
Select the <b>Search for new features to install</b> radio button.
Click <b>Next</b>. Select <b>Add Local Site...</b>.
Find the workspace in the local file system and
navigate to the update site project.
Check the site, expand it and verify that 'Sample'
category shows up. Click <b>Next</b>.
<br/>
The wizard list should show 'XYZ Feature'. Select it
and verify that the description shows up.
Click the <b>Properties</b> button and verify that
properties are correct. Click <b>Next</b>.
Verify that the license agreement shows up correctly.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_previewing.htm"
title="Installing the feature">
<description>
When ready to test the feature itself, install
another Eclipse instance and start it.
Select <b>Help-&gt;Software Updates-&gt;Find and Install...</b>.
in that instance. Repeat the previous two steps. This
time, go all the way to the
end of the wizard and press <b>Finish</b>.
Accept to restart the workbench.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_previewing.htm"
title="Verifying the installation">
<description>
Upon restart, select <b>Help-&gt;Software Updates-&gt;Manage Configuration...</b>.
Expand the install location under <b>Eclipse Platform</b>.
Verify that the 'XYZ Feature' exists.
</description>
</item>
<item
href="/org.eclipse.pde.doc.user/guide/pde_site_previewing.htm"
title="Publishing the update site">
<description>
Once the update site is verified in the local file system,
export the update site project and copy it to an HTTP server.
</description>
</item>
</cheatsheet>