Built by Maven

site:jar

Full name:

org.apache.maven.plugins:maven-site-plugin:4.0.0-M16: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.
  • Executes only as a reportSet (reporting goal).
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0-beta-6.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
<finalName> String - Specifies the filename that will be used for the generated jar file. Please note that "-site" will be appended to the file name.
User Property: project.build.finalName
<jarOutputDirectory> String - Specifies the directory where the generated jar file will be put.
User Property: project.build.directory

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 - Specifies whether to attach the generated artifact to the project.
Default: true
User Property: site.attach
<attributes> Map<String,Object> - 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: true
User Property: generateProjectInfo
<generateReports> boolean - Convenience parameter that allows you to disable report generation.
Default: true
User Property: generateReports
<generateSitemap> boolean 2.1 Generate a sitemap. The result will be a "sitemap.html" file at the site root.
Default: false
User Property: generateSitemap
<generatedSiteDirectory> File - Directory containing generated documentation in source format (Doxia supported markup). This is used to pick up other source docs that might have been generated at build time (by reports or any other build time mean). This directory is expected to have the same structure as siteDirectory (ie. one directory per Doxia-source-supported markup types). todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source intermediate step?
Default: ${project.build.directory}/generated-site
Alias: workingDirectory
<inputEncoding> String 2.3 Specifies the input encoding.
Default: ${project.build.sourceEncoding}
User Property: encoding
<locales> String 2.3 A comma separated list of locales to render. The first valid token will be the default Locale for this site.
Default: default
User Property: locales
<moduleExcludes> Map<String,String> - 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 - Directory where the project sites and report distributions will be generated (as html/css/...).
Default: ${project.reporting.outputDirectory}
User Property: siteOutputDirectory
<outputEncoding> String 2.3 Specifies the output encoding.
Default: ${project.reporting.outputEncoding}
User Property: outputEncoding
<outputTimestamp> String 3.9.0 Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<relativizeSiteLinks> 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: true
User Property: relativizeSiteLinks
<saveProcessedContent> boolean 3.5 Whether to save Velocity processed Doxia content (*.<ext>.vm) to ${generatedSiteDirectory}/processed.
<siteDirectory> File 2.3 Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).
Default: ${basedir}/src/site
<skip> boolean 3.0 Set this to 'true' to skip site generation and staging.
Default: false
User Property: maven.site.skip
<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: false
User Property: validate

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
  • Required: No
  • User Property: site.attach
  • Default: true

<attributes>

Additional template properties for rendering the site. See Doxia Site Renderer.
  • Type: java.util.Map<java.lang.String, java.lang.Object>
  • 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
  • Required: Yes
  • User Property: project.build.finalName

<generateProjectInfo>

Whether to generate the summary page for project reports: project-info.html.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: generateProjectInfo
  • Default: true

<generateReports>

Convenience parameter that allows you to disable report generation.
  • Type: boolean
  • Required: No
  • User Property: 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
  • User Property: generateSitemap
  • Default: false

<generatedSiteDirectory>

Directory containing generated documentation in source format (Doxia supported markup). This is used to pick up other source docs that might have been generated at build time (by reports or any other build time mean). This directory is expected to have the same structure as siteDirectory (ie. one directory per Doxia-source-supported markup types). todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source intermediate step?
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-site
  • Alias: workingDirectory

<inputEncoding>

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

<jarOutputDirectory>

Specifies the directory where the generated jar file will be put.
  • Type: java.lang.String
  • Required: Yes
  • User Property: project.build.directory

<locales>

A comma separated list of locales to render. The first valid token will be the default Locale for this site.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • User Property: locales
  • Default: default

<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<java.lang.String, java.lang.String>
  • Required: No

<outputDirectory>

Directory where the project sites and report distributions will be generated (as html/css/...).
  • Type: java.io.File
  • Required: No
  • User Property: siteOutputDirectory
  • Default: ${project.reporting.outputDirectory}

<outputEncoding>

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

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Since: 3.9.0
  • Required: No
  • Default: ${project.build.outputTimestamp}

<relativizeSiteLinks>

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
  • User Property: relativizeSiteLinks
  • Default: true

<saveProcessedContent>

Whether to save Velocity processed Doxia content (*.<ext>.vm) to ${generatedSiteDirectory}/processed.
  • Type: boolean
  • Since: 3.5
  • Required: No

<siteDirectory>

Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • Default: ${basedir}/src/site

<skip>

Set this to 'true' to skip site generation and staging.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.site.skip
  • Default: false

<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
  • User Property: validate
  • Default: false