Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Let's assume that the identifier of The Warehouse plugin is warehouse.

Maven archetype

Another way to set up a new plugin project is to use a special maven archetype. When using this method you input certain parameters, which automatically generate the whole project with sample files (no need to change folder names or file names any more!). To do so you just need to have maven installed and be in the directory where you want your project. 

...

  • -DarchetypeGroupId - this should stay exactly as in the example abovealways have the value com.qcadoo, it identifies the group to which the archetype belongs to
  • -DarchetypeArtifactId - just like above, it identifies the artifact id of the archetype
  • -DarchetypeVersion - this will change with time, it identifies the archetype's version. Currently 0.4.0-SNAPSHOT
  • -DartifactId - required parameter, this will be your plugin's artifact id (set in the project's pom.xml)
  • -Dversion - required parameter, this is your plugin's version (set in the project's pom.xml)
  • -Didentifier - required parameter, this will be your plugin's name, appropriate folders and files will be renamed using it (i.e. the locale files), it will be used in the sample view.xml and model.xml as the view/model names.
  • -Dname - required parameter, this will be your plugin's name (set in the project's pom.xml)
  • -DvendorName - required parameter, this will be the name of the vendor who developed the plugin
  • -DvendorUrl - required parameter, this will be the URL address of the vendor who developed the plugin
  • -DgroupId - optional parameter, this is your plugin's group id (set in the project's pom.xml), the default value is "com.qcadoo.mes"
  • -Dpackage - optional parameter, this should match your plugin's package structure which will be set in the root-context.xml, the default value is the same as the groupId 

...

Pom.xml, qcadoo-plugin.xml and root-context.xml are all automatically filled out with the mvn archetype:generate parameters.

Generate Eclipse project

To generate Eclipse project we need to open terminal and type mvn eclipse:eclipse. Before opening the project you must have a Maven plugin installed in Eclipse. We suggest using Q4E which is now becoming Eclipse's official Maven plugin under the name Eclipse IAM. Please see the following page for instruction how to install it:

...