Versions Compared

Key

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

...

To generate a new plugin project use the following maven command:

Code Block
languagebash
No Format

mvn archetype:generate -DarchetypeGroupId=com.qcadoo -DarchetypeArtifactId=qcadoo-plugin-archetype -DarchetypeVersion=0.4.0-SNAPSHOT -DartifactId=warehouse -Dversion=0.4.0 -Didentifier=warehouse -Dname="Warehouse module" -DvendorName="Warehouse Corporation" -DvendorUrl=www.warehousecorp.com [ -DgroupId=com.my.domain -Dpackage=package ]
  • -DarchetypeGroupId - this should always have the value com.qcadoo, it identifies the group to which the archetype belongs to
  • -DarchetypeArtifactId - this should always have the value qcadoo-plugin-archetype, 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 - this will be your plugin's artifact id, like warehouse for example (set in the project's pom.xml)
  • -Dversion - this is your plugin's version, like 0.4.0 for example (set in the project's pom.xml)
  • -Didentifier - this will be your plugin's name, like warehouse for example. 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 - this will be your plugin's name, like Warehouse module for example (set in the project's pom.xml)
  • -DvendorName - this will be the name of the vendor who developed the plugin, like Warehouse Corporation for example
  • -DvendorUrl - this will be the URL address of the vendor who developed the plugin, like www.warehousecorp.com for example
  • -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Ā 

...