site:jar

Full name:

org.apache.maven.plugins:maven-site-plugin:2.1.1:jar

Description:

Bundles the site output into a JAR so that it can be deployed to a repository.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 2.0-beta-6.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
finalName String 2.0-beta-6 Specifies the filename that will be used for the generated jar file. Please note that "-site" will be appended to the file name.
generatedSiteDirectory File 2.0-beta-6 Directory containing generated documentation.
jarOutputDirectory String 2.0-beta-6 Specifies the directory where the generated jar file will be put.
outputDirectory File 2.0-beta-6 Directory containing the generated project sites and report distributions.
Default value is: ${project.reporting.outputDirectory}.
siteDirectory File 2.0-beta-6 Directory containing the site.xml file and the source for apt, fml and xdoc docs.

Optional Parameters

Name Type Since Description
attach boolean 2.0-beta-6 Specifies whether to attach the generated artifact to the project.
Default value is: true.
attributes Map 2.0-beta-6 The template properties for rendering the site.
generateReports boolean 2.0-beta-6 Convenience parameter that allows you to disable report generation.
Default value is: true.
generateSitemap boolean 2.1 Generate a sitemap. The result will be a "sitemap.html" file at the site root.
Default value is: false.
inputEncoding String 2.0-beta-6 Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
localRepository ArtifactRepository 2.0-beta-6 The local repository.
locales String 2.0-beta-6 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.
moduleExcludes Map 2.0-beta-6 Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this: 
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>

outputEncoding String 2.0-beta-6 Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
repositories List 2.0-beta-6 Remote repositories used for the project.
template String 2.0-beta-6 Deprecated. use templateFile or skinning instead
templateDirectory File 2.0-beta-6 Deprecated. use templateFile or skinning instead
Default value is: src/site.
templateFile File 2.0-beta-5 The location of a Velocity template file to use. When used, skins and the default templates, CSS and images are disabled. It is highly recommended that you package this as a skin instead.
validate boolean 2.1.1 Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
Default value is: false.
xdocDirectory File 2.0-beta-6 Deprecated. use the standard m2 directory layout
Default value is: ${basedir}/xdocs.

Parameter Details

attach:

Specifies whether to attach the generated artifact to the project.
  • Type: boolean
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${site.attach}
  • Default: true

attributes:

The template properties for rendering the site.
  • Type: java.util.Map
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${attributes}

finalName:

Specifies the filename that will be used for the generated jar file. Please note that "-site" will be appended to the file name.
  • Type: java.lang.String
  • Since: 2.0-beta-6
  • Required: Yes
  • Expression: ${project.build.finalName}

generateReports:

Convenience parameter that allows you to disable report generation.
  • Type: boolean
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${generateReports}
  • Default: true

generateSitemap:

Generate a sitemap. The result will be a "sitemap.html" file at the site root.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${generateSitemap}
  • Default: false

generatedSiteDirectory:

Directory containing generated documentation.
  • Type: java.io.File
  • Since: 2.0-beta-6
  • Required: Yes
  • Expression: ${project.build.directory}/generated-site

inputEncoding:

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

jarOutputDirectory:

Specifies the directory where the generated jar file will be put.
  • Type: java.lang.String
  • Since: 2.0-beta-6
  • Required: Yes
  • Expression: ${project.build.directory}

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Since: 2.0-beta-6
  • 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
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${locales}

moduleExcludes:

Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this: 
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>
  • Type: java.util.Map
  • Since: 2.0-beta-6
  • Required: No

outputDirectory:

Directory containing the generated project sites and report distributions.
  • Type: java.io.File
  • Since: 2.0-beta-6
  • Required: Yes
  • Expression: ${siteOutputDirectory}
  • Default: ${project.reporting.outputDirectory}

outputEncoding:

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

repositories:

Remote repositories used for the project.
  • Type: java.util.List
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

siteDirectory:

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

template:

Deprecated. use templateFile or skinning instead
Default template page.
  • Type: java.lang.String
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${template}

templateDirectory:

Deprecated. use templateFile or skinning instead
Directory containing the template page.
  • Type: java.io.File
  • Since: 2.0-beta-6
  • Required: No
  • Expression: ${templateDirectory}
  • Default: src/site

templateFile:

The location of a Velocity template file to use. When used, skins and the default templates, CSS and images are disabled. It is highly recommended that you package this as a skin instead.
  • Type: java.io.File
  • Since: 2.0-beta-5
  • Required: No
  • Expression: ${templateFile}

validate:

Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
  • Type: boolean
  • Since: 2.1.1
  • Required: No
  • Expression: ${validate}
  • Default: false

xdocDirectory:

Deprecated. use the standard m2 directory layout
Alternative directory for xdoc source, useful for m1 to m2 migration
  • Type: java.io.File
  • Since: 2.0-beta-6
  • Required: No
  • Default: ${basedir}/xdocs