Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "SMILA/Documentation/HowTo/Create a bundle (plug-in)"
< SMILA | Documentation | HowTo
m |
m |
||
| Line 1: | Line 1: | ||
| − | This page describes how to create a new bundle for SMILA. | + | This page describes how to create a new bundle for SMILA.The description on how to add a test bundle to test the components of the new bundle can be found in [[SMILA/Development Guidelines/Create a test bundle (plug-in)|How to create a test bundle (plug-in)]]. |
| − | + | == Create the bundle == | |
| − | The following steps must be performed to create the project base: | + | The following steps must be performed to create the project base: |
| − | + | #Launch Eclipse and select your SMILA workspace. | |
| − | + | ||
| − | #Launch Eclipse and select your SMILA workspace. | + | |
#Select ''File > New > Project'' and click ''Plug-in Project''. | #Select ''File > New > Project'' and click ''Plug-in Project''. | ||
| + | #Click ''Next''. <br>Now you have to fill in various metadata and settings for your plug-in project. You may as well edit the settings later on by opening the <tt>MANIFEST.MF</tt> with the ''Plug-in Manifest'' editor. | ||
| + | #Enter a project name (you should use a fully qualified name, for this example we will use <tt>org.eclipse.smila.integration.bundle</tt>). | ||
| + | #Add <tt>code</tt> as a parent to the source and output folder: | ||
| + | #*Set ''Source folder'' to "code/src". | ||
| + | #*Set ''Output folder'' to "code/bin". | ||
| + | #Set ''Target Platform'' to "an OSGi framework: Equinox". | ||
#Click ''Next''. | #Click ''Next''. | ||
| − | # | + | #Fill in the metadata information of the new bundle. Set the plug-in's name as ID, your bundle's version, a reasonable bundle name and the information about the provider (i.e. you). For our example we select: |
| − | + | #*ID: <tt>org.eclipse.smila.integration.bundle</tt> | |
| − | + | #*Version: <tt>1.0.0</tt> | |
| − | + | #*Name: <tt>Example Bundle Plugin</tt> | |
| − | + | #*Provider: <tt>Example company</tt> | |
| − | + | #*Exection Environment: <tt>JavaSE-1.6</tt> | |
| − | + | #Unless you need an activator, uncheck this option. | |
| − | + | #Click ''Next''. | |
| − | + | #Unless you want to use any of the given templates to create your plugin, uncheck the option. | |
| − | + | #Click ''Finish''. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | Fill in the metadata information | + | |
| − | + | ||
| − | Set the | + | |
| − | + | ||
| − | For our example: | + | |
| − | * ID: <tt>org.eclipse.smila.integration.bundle</tt> | + | |
| − | * Version: <tt>1.0.0</tt> | + | |
| − | * Name: <tt>Example Bundle Plugin</tt> | + | |
| − | * Provider: <tt>Example company</tt> | + | |
| − | * Exection Environment: <tt>JavaSE-1.6</tt> | + | |
| − | + | ||
| − | Unless you need an activator, uncheck this option. | + | |
| − | + | ||
| − | Click ''Next''. | + | |
| − | + | ||
| − | + | ||
| − | Unless you want to use any of the given templates to create your plugin, | + | |
| − | + | ||
| − | Click ''Finish'' | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | == Check the result == | |
| − | Open the <tt>MANIFEST.MF</tt> file and | + | When you're done with the above, your actions should have resulted in a new project with (in our example) the name of <tt>org.eclipse.smila.integration.bundle</tt>, that now shows up in your workspace. Just check your ''Package Explorer'' for the new bundle. In it, there should be an empty <tt>code/src</tt> package, a <tt>META-INF</tt> folder containing a <tt>MANIFEST.MF</tt> file and a <tt>build.properties</tt> file. Open the <tt>MANIFEST.MF</tt> file and clicking through the panels and you will recognize most of the settings, we did above. |
| − | Now you've created your bundle, you can add your components | + | Now that you've created your bundle, you can add your components as you like but do not forget to [[SMILA/Development Guidelines/Create a test bundle (plug-in)|add a test bundle]]. |
[[Category:SMILA]] | [[Category:SMILA]] | ||
Revision as of 12:10, 18 January 2012
This page describes how to create a new bundle for SMILA.The description on how to add a test bundle to test the components of the new bundle can be found in How to create a test bundle (plug-in).
Create the bundle
The following steps must be performed to create the project base:
- Launch Eclipse and select your SMILA workspace.
- Select File > New > Project and click Plug-in Project.
- Click Next.
Now you have to fill in various metadata and settings for your plug-in project. You may as well edit the settings later on by opening the MANIFEST.MF with the Plug-in Manifest editor. - Enter a project name (you should use a fully qualified name, for this example we will use org.eclipse.smila.integration.bundle).
- Add code as a parent to the source and output folder:
- Set Source folder to "code/src".
- Set Output folder to "code/bin".
- Set Target Platform to "an OSGi framework: Equinox".
- Click Next.
- Fill in the metadata information of the new bundle. Set the plug-in's name as ID, your bundle's version, a reasonable bundle name and the information about the provider (i.e. you). For our example we select:
- ID: org.eclipse.smila.integration.bundle
- Version: 1.0.0
- Name: Example Bundle Plugin
- Provider: Example company
- Exection Environment: JavaSE-1.6
- Unless you need an activator, uncheck this option.
- Click Next.
- Unless you want to use any of the given templates to create your plugin, uncheck the option.
- Click Finish.
Check the result
When you're done with the above, your actions should have resulted in a new project with (in our example) the name of org.eclipse.smila.integration.bundle, that now shows up in your workspace. Just check your Package Explorer for the new bundle. In it, there should be an empty code/src package, a META-INF folder containing a MANIFEST.MF file and a build.properties file. Open the MANIFEST.MF file and clicking through the panels and you will recognize most of the settings, we did above.
Now that you've created your bundle, you can add your components as you like but do not forget to add a test bundle.