Full name:
org.apache.maven.plugins:maven-site-plugin:2.1:jar
Description:
Attributes:
test
.2.0-beta-6
.package
.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. |
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. |
xdocDirectory | File |
2.0-beta-6 |
Deprecated. use the standard m2 directory layout Default value is: ${basedir}/xdocs . |
boolean
2.0-beta-6
No
${site.attach}
true
java.util.Map
2.0-beta-6
No
${attributes}
java.lang.String
2.0-beta-6
Yes
${project.build.finalName}
boolean
2.0-beta-6
No
${generateReports}
true
boolean
2.1
No
${generateSitemap}
false
java.io.File
2.0-beta-6
Yes
${project.build.directory}/generated-site
java.lang.String
2.0-beta-6
No
${encoding}
${project.build.sourceEncoding}
java.lang.String
2.0-beta-6
Yes
${project.build.directory}
org.apache.maven.artifact.repository.ArtifactRepository
2.0-beta-6
No
${localRepository}
java.lang.String
2.0-beta-6
No
${locales}
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>
java.util.Map
2.0-beta-6
No
java.io.File
2.0-beta-6
Yes
${siteOutputDirectory}
${project.reporting.outputDirectory}
java.lang.String
2.0-beta-6
No
${outputEncoding}
${project.reporting.outputEncoding}
java.util.List
2.0-beta-6
No
${project.remoteArtifactRepositories}
java.io.File
2.0-beta-6
Yes
${basedir}/src/site
java.lang.String
2.0-beta-6
No
${template}
java.io.File
2.0-beta-6
No
${templateDirectory}
src/site
java.io.File
2.0-beta-5
No
${templateFile}
java.io.File
2.0-beta-6
No
${basedir}/xdocs