doap:generate

Full name:

org.apache.maven.plugins:maven-doap-plugin:1.1:generate

Description:

Generate a Description of a Project (DOAP) file from the main information found in a POM.
Note: The generated file is tailored for use by projects at Apache.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 1.0-beta-1.

Required Parameters

Name Type Since Description
doapFile String 1.0-beta-1 The name of the DOAP file that will be generated.
Default value is: doap_${project.artifactId}.rdf.
lang String 1.0 The value for the xml:lang attribute used by the <rdf:RDF/>, <description/> and <shortdesc/> elements.
POM doesn't have any notions about language.
See http://www.w3.org/TR/REC-xml/#sec-lang-tag

Default value is: en.
outputDirectory String 1.1 The output directory of the DOAP file that will be generated.
Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
about String 1.0 The about URI-reference which should be displayed in the DOAP file. Example: 
<rdf:RDF>
  <Project rdf:about="http://maven.apache.org/">
  ...
  </Project>
</rdf:RDF>
See http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#aboutAttr

Default value is: ${project.url}.
artifact DoapArtifact 1.1 An artifact to generate the DOAP file against.
Example: 
<artifact>
  <groupId>given-artifact-groupId</groupId>
  <artifactId>given-artifact-artifactId</artifactId>
  <version>given-artifact-version</version>
</artifact>

See Javadoc
asfExtOptions ASFExtOptions 1.0 Specific ASF extensions parameters, i.e. options that POM doesn't have any notions but required by ASF DOAP requirements.
Example: 
<asfExtOptions>
  <included>true</included>
  <charter>The mission of the Apache XXX project is to create and maintain software
  libraries that provide ...</charter>
  ...
</asfExtOptions>
Note: By default, <asfExtOptions><included/></asfExtOptions> will be automatically set to true if the project is hosted at ASF.
See Javadoc
category String 1.0-beta-1 Deprecated. Since 1.0. Instead of, configure <doapOptions><category/></doapOptions> parameter.
doapOptions DoapOptions 1.0 Specific DOAP parameters, i.e. options that POM doesn't have any notions.
Example: 
<doapOptions>
  <programmingLanguage>java</programmingLanguage>
</doapOptions>

See Javadoc
extOptions ExtOptions[] 1.1 Extensions parameters.
Example: 
<extOptions>
 <extOption>
   <xmlnsPrefix>labs</xmlnsPrefix>
   <xmlnsNamespaceURI>http://labs.apache.org/doap-ext/1.0#</xmlnsNamespaceURI>
   <extensions>
    <status>active</status>
   </extensions>
 </extOption>
</extOptions>
See Javadoc
language String 1.0-beta-1 Deprecated. Since 1.0. Instead of, configure <doapOptions><programmingLanguage/></doapOptions> parameter.
skip boolean 1.1 Specifies whether the DOAP generation should be skipped.
Default value is: false.
validate boolean 1.1 Flag to validate the generated DOAP.
Default value is: true.

Parameter Details

about:

The about URI-reference which should be displayed in the DOAP file. Example: 
<rdf:RDF>
  <Project rdf:about="http://maven.apache.org/">
  ...
  </Project>
</rdf:RDF>
See http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#aboutAttr
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${about}
  • Default: ${project.url}

artifact:

An artifact to generate the DOAP file against.
Example: 
<artifact>
  <groupId>given-artifact-groupId</groupId>
  <artifactId>given-artifact-artifactId</artifactId>
  <version>given-artifact-version</version>
</artifact>

See Javadoc
  • Type: org.apache.maven.plugin.doap.options.DoapArtifact
  • Since: 1.1
  • Required: No

asfExtOptions:

Specific ASF extensions parameters, i.e. options that POM doesn't have any notions but required by ASF DOAP requirements.
Example: 
<asfExtOptions>
  <included>true</included>
  <charter>The mission of the Apache XXX project is to create and maintain software
  libraries that provide ...</charter>
  ...
</asfExtOptions>
Note: By default, <asfExtOptions><included/></asfExtOptions> will be automatically set to true if the project is hosted at ASF.
See Javadoc
  • Type: org.apache.maven.plugin.doap.options.ASFExtOptions
  • Since: 1.0
  • Required: No
  • Expression: ${asfExtOptions}

category:

Deprecated. Since 1.0. Instead of, configure <doapOptions><category/></doapOptions> parameter.
The category which should be displayed in the DOAP file.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${category}

doapFile:

The name of the DOAP file that will be generated.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: Yes
  • Expression: ${doapFile}
  • Default: doap_${project.artifactId}.rdf

doapOptions:

Specific DOAP parameters, i.e. options that POM doesn't have any notions.
Example: 
<doapOptions>
  <programmingLanguage>java</programmingLanguage>
</doapOptions>

See Javadoc
  • Type: org.apache.maven.plugin.doap.options.DoapOptions
  • Since: 1.0
  • Required: No
  • Expression: ${doapOptions}

extOptions:

Extensions parameters.
Example: 
<extOptions>
 <extOption>
   <xmlnsPrefix>labs</xmlnsPrefix>
   <xmlnsNamespaceURI>http://labs.apache.org/doap-ext/1.0#</xmlnsNamespaceURI>
   <extensions>
    <status>active</status>
   </extensions>
 </extOption>
</extOptions>
See Javadoc
  • Type: org.apache.maven.plugin.doap.options.ExtOptions[]
  • Since: 1.1
  • Required: No
  • Expression: ${extOptions}

lang:

The value for the xml:lang attribute used by the <rdf:RDF/>, <description/> and <shortdesc/> elements.
POM doesn't have any notions about language.
See http://www.w3.org/TR/REC-xml/#sec-lang-tag
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${lang}
  • Default: en

language:

Deprecated. Since 1.0. Instead of, configure <doapOptions><programmingLanguage/></doapOptions> parameter.
The programming language which should be displayed in the DOAP file.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${language}

outputDirectory:

The output directory of the DOAP file that will be generated.
  • Type: java.lang.String
  • Since: 1.1
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

skip:

Specifies whether the DOAP generation should be skipped.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${maven.doap.skip}
  • Default: false

validate:

Flag to validate the generated DOAP.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Default: true