site:jar

Full name:

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

Description:

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

Attributes:

Requires a Maven 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.
jarOutputDirectory	`String`	`2.0-beta-6`	Specifies the directory where the generated jar file will be put.

Optional Parameters

Name	Type	Since	Description
archive	`MavenArchiveConfiguration`	`3.1`	The archive configuration to use. See Maven Archiver Reference.
archiveExcludes	`String[]`	`3.1`	List of files to exclude. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.
archiveIncludes	`String[]`	`3.1`	List of files to include. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.
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`	Additional template properties for rendering the site. See Doxia Site Renderer.
generateProjectInfo	`boolean`	`2.3`	Whether to generate the summary page for project reports: project-info.html. Default value is: `true`.
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`.
generatedSiteDirectory	`File`	`2.0-beta-6`	Directory containing generated documentation. This is used to pick up other source docs that might have been generated at build time. Default value is: `${project.build.directory}/generated-site`.
inputEncoding	`String`	`2.0-beta-6`	Specifies the input encoding. Default value is: `${project.build.sourceEncoding}`.
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>
outputDirectory	`File`	`2.0-beta-6`	Directory where the project sites and report distributions will be generated. Default value is: `${project.reporting.outputDirectory}`.
outputEncoding	`String`	`2.0-beta-6`	Specifies the output encoding. Default value is: `${project.reporting.outputEncoding}`.
relativizeDecorationLinks	`boolean`	`2.3`	Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. Links will not be changed if this is set to false, or if the project has no URL defined. Default value is: `true`.
reportPlugins	`ReportPlugin[]`	`3.0-beta-1`	Configuration section used internally by Maven 3. More details available here: http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats Note: using this field is not mandatory with Maven 3 as Maven core injects usual `<reporting>` section into this field.
siteDirectory	`File`	`2.0-beta-6`	Directory containing the site.xml file and the source for apt, fml and xdoc docs. Default value is: `${basedir}/src/site`.
skip	`boolean`	`3.0`	Set this to 'true' to skip site generation. Default value is: `false`.
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

archive:

The archive configuration to use. See Maven Archiver Reference.

Type: org.apache.maven.archiver.MavenArchiveConfiguration
Since: 3.1
Required: No

archiveExcludes:

List of files to exclude. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.

Type: java.lang.String[]
Since: 3.1
Required: No

archiveIncludes:

List of files to include. Specified as file set patterns which are relative to the input directory whose contents is being packaged into the JAR.

Type: java.lang.String[]
Since: 3.1
Required: No

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:

Additional template properties for rendering the site. See Doxia Site Renderer.

Type: java.util.Map
Since: 2.0-beta-6
Required: No

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}

generateProjectInfo:

Whether to generate the summary page for project reports: project-info.html.

Type: boolean
Since: 2.3
Required: No
Expression: ${generateProjectInfo}
Default: true

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. This is used to pick up other source docs that might have been generated at build time.

Type: java.io.File
Since: 2.0-beta-6
Required: No
Default: ${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}

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 where the project sites and report distributions will be generated.

Type: java.io.File
Since: 2.0-beta-6
Required: No
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}

relativizeDecorationLinks:

Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. Links will not be changed if this is set to false, or if the project has no URL defined.

Type: boolean
Since: 2.3
Required: No
Expression: ${relativizeDecorationLinks}
Default: true

reportPlugins:

Configuration section used internally by Maven 3.

More details available here: http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

Note: using this field is not mandatory with Maven 3 as Maven core injects usual <reporting> section into this field.

Type: org.apache.maven.reporting.exec.ReportPlugin[]
Since: 3.0-beta-1
Required: No

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: No
Default: ${basedir}/src/site

skip:

Set this to 'true' to skip site generation.

Type: boolean
Since: 3.0
Required: No
Expression: ${maven.site.skip}
Default: false

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

Overview

Configuration

Examples

Project Documentation

Maven Projects

ASF

site:jar

Required Parameters

Optional Parameters

Parameter Details