Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Plugin/Feature Configuration Guidelines"
m (Plugin Configuration Guidelines moved to Plugin/Feature Configuration Guidelines: Added feature descriptions.) |
(updated formatting information) |
||
| Line 1: | Line 1: | ||
| − | This page describes the guidelines when creating new plugins and features for | + | This page describes the guidelines when creating new plugins and features for EMFStore or ECP. |
| − | For the following settings we assume that we want to create a new plugin " | + | For the following settings we assume that we want to create a new plugin "example".<br> |
== General settings == | == General settings == | ||
| Line 7: | Line 7: | ||
These settings can be modified in the "New Plug-in Project/New Feature" wizards.'''<br>''' | These settings can be modified in the "New Plug-in Project/New Feature" wizards.'''<br>''' | ||
| − | *'''Namespace:''' The plugin-name should begin with "org.eclipse.emf.emfstore". Therefore the name of our | + | *'''Namespace:''' The plugin-name should begin with "org.eclipse.emf.emfstore" or "org.eclipse.emf.ecp". Therefore the name of our example plugin and the prefix for the packages would be "org.eclipse.emf.emfstore.example". The name of a feature would be e.g. "org.eclipse.emf.emfstore.example.feature".<br> |
*'''Execution Environment:''' As JRE version the plugin should use 1.5, so please select "J2SE-1.5". (Note that a feature does not have this setting.)<br> | *'''Execution Environment:''' As JRE version the plugin should use 1.5, so please select "J2SE-1.5". (Note that a feature does not have this setting.)<br> | ||
| − | *'''Version:''' As version please use the current version (see in other plugin) plus the qualifier, e.g. " | + | *'''Version:''' As version please use the current version (see in other plugin) plus the qualifier, e.g. "1.0.0.qualifier". |
| − | *'''Name:''' Enter a describing name for your plugin | + | *'''Name:''' Enter a describing name for your plugin, e.g. "Cool Example Plugin". |
*'''Provider:''' For the provider please enter "Eclipse Modeling Project".<br> | *'''Provider:''' For the provider please enter "Eclipse Modeling Project".<br> | ||
| Line 20: | Line 20: | ||
When adding dependencies to your project please note the following giudelines: | When adding dependencies to your project please note the following giudelines: | ||
| − | *'''Internal plugins''' (plugins of emfstore) should not have any version matching settings. | + | <!-- *'''Internal plugins''' (plugins of emfstore) should not have any version matching settings. --> |
| − | *''' | + | *'''Plugins''' should have the needed minimum version and the next major version as maximum version, e.g. "[4.8.1, 5.0.0)". |
| − | *'''Reexport dependencies''' when | + | *'''Reexport dependencies''' when you use classes from the other plugins in your API.<br> |
| − | == Formatting & | + | == Formatting & co<br> == |
| − | + | *Set the Text file encoding to UTF-8 | |
| + | *Set the New text file line delimiter to Unix | ||
| + | *For the Formatter enable project specific settings and import the esmFormatter.xml. You can find it in the releng folder. | ||
| + | *For the Code Templates enable project specific settings and import the esmCodetemplates.xml. You can find it in the releng folder. | ||
| + | *For the Clean Up enable project specific settings and import the esmCleanUp.xml. You can find it in the releng folder. | ||
| + | *For the Save Actions enable project specific settings. Enable "Perform the selected actions on save". Enable "Format source code" and select "Format all lines". Enable "Organize imports". | ||
| + | *Activate checkstyle for your project. Go to Local Check Configurations and create a new configuration. Select "Remote Configuration" the location is "http://download.eclipse.org/emf-store/checkstyle/emfstoreStyle.xml". Enable "Chache configuration file".<br> | ||
Revision as of 06:55, 26 July 2013
This page describes the guidelines when creating new plugins and features for EMFStore or ECP.
For the following settings we assume that we want to create a new plugin "example".
General settings
These settings can be modified in the "New Plug-in Project/New Feature" wizards.
- Namespace: The plugin-name should begin with "org.eclipse.emf.emfstore" or "org.eclipse.emf.ecp". Therefore the name of our example plugin and the prefix for the packages would be "org.eclipse.emf.emfstore.example". The name of a feature would be e.g. "org.eclipse.emf.emfstore.example.feature".
- Execution Environment: As JRE version the plugin should use 1.5, so please select "J2SE-1.5". (Note that a feature does not have this setting.)
- Version: As version please use the current version (see in other plugin) plus the qualifier, e.g. "1.0.0.qualifier".
- Name: Enter a describing name for your plugin, e.g. "Cool Example Plugin".
- Provider: For the provider please enter "Eclipse Modeling Project".
Plugin dependencies
When adding dependencies to your project please note the following giudelines:
- Plugins should have the needed minimum version and the next major version as maximum version, e.g. "[4.8.1, 5.0.0)".
- Reexport dependencies when you use classes from the other plugins in your API.
Formatting & co
- Set the Text file encoding to UTF-8
- Set the New text file line delimiter to Unix
- For the Formatter enable project specific settings and import the esmFormatter.xml. You can find it in the releng folder.
- For the Code Templates enable project specific settings and import the esmCodetemplates.xml. You can find it in the releng folder.
- For the Clean Up enable project specific settings and import the esmCleanUp.xml. You can find it in the releng folder.
- For the Save Actions enable project specific settings. Enable "Perform the selected actions on save". Enable "Format source code" and select "Format all lines". Enable "Organize imports".
- Activate checkstyle for your project. Go to Local Check Configurations and create a new configuration. Select "Remote Configuration" the location is "http://download.eclipse.org/emf-store/checkstyle/emfstoreStyle.xml". Enable "Chache configuration file".