site:attach-descriptor

Full name:

org.apache.maven.plugins:maven-site-plugin:2.0.1:attach-descriptor

Description:

Adds the site descriptor (site.xml) to the list of files to be installed/deployed.

Attributes:

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

Required Parameters

Name Type Since Description
siteDirectory File - Directory containing the site.xml file and the source for apt, fml and xdoc docs.

Optional Parameters

Name Type Since Description
inputEncoding String - Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
localRepository ArtifactRepository - The local repository.
locales String - A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
outputEncoding String - Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.

Parameter Details

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

locales:

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locales}

outputEncoding:

Specifies the output encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}

siteDirectory:

Directory containing the site.xml file and the source for apt, fml and xdoc docs.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/site