andromda-site-cartridge:generate-cartridge-howto-artifacts

Full name:

org.andromda.maven.plugins.site:andromda-site-cartridge-plugin:3.5-SNAPSHOT:generate-cartridge-howto-artifacts

Description:

Goal that runs AndroMDA over the howto model to generate the cartridge java source files which are referenced via the cartridge xhtml docs. It also unpacks the cartridge related archive files, such as the howto pictures for the cartridge site documentation, to target/site/howto locations preparing for deployment.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: site.

Required Parameters

Name Type Since Description
configurationUri String - This is the URI to the AndroMDA configuration file.

Optional Parameters

Name Type Since Description
howtoCartridgePicturesOutputDirectory File - Path to the cartride howto pictures destination extraction directory
howtoCartridgePicturesSourcePath File - Path to the cartridge howto pictures zip source. This file's path is typically cartridge/src/site/resource/howto/HowToPictures.zip.
modelOutputHistory File - The directory where the model generation output history is located (Modelname file containing a list of files generated by that model).
projectName String - The name of the project injected from pom.xml. Not used.
Default value is: ${project.name}.
propertyFiles List - (no description)

Parameter Details

configurationUri:

This is the URI to the AndroMDA configuration file.
  • Type: java.lang.String
  • Required: Yes
  • Expression: file:${basedir}/conf/howto/andromda.xml

howtoCartridgePicturesOutputDirectory:

Path to the cartride howto pictures destination extraction directory
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/target/site/howto

howtoCartridgePicturesSourcePath:

Path to the cartridge howto pictures zip source. This file's path is typically cartridge/src/site/resource/howto/HowToPictures.zip.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/site/resources/howto/HowToPictures.zip

modelOutputHistory:

The directory where the model generation output history is located (Modelname file containing a list of files generated by that model).
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/history

projectName:

The name of the project injected from pom.xml. Not used.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name}

propertyFiles:

(no description)
  • Type: java.util.List
  • Required: No
  • Expression: ${project.build.filters}