Full name:
org.apache.maven.plugins:maven-site-plugin:2.0:run
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
generatedSiteDirectory | File |
- |
Directory containing generated documentation. |
siteDirectory | File |
- |
Directory containing the site.xml file and the source for apt, fml
and xdoc docs. |
Name | Type | Since | Description |
---|---|---|---|
attributes | Map |
- |
The template properties for rendering the site. |
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. |
moduleExcludes | Map |
- |
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 |
- |
Specifies the output encoding. Default value is: ${project.reporting.outputEncoding} . |
port | int |
- |
The port to execute the HTTP server on. Default value is: 8080 . |
repositories | List |
- |
Remote repositories used for the project. |
tempWebappDirectory | File |
- |
Where to create the dummy web application. |
template | String |
- |
Deprecated. {0}. use templateFile or skinning instead |
templateDirectory | File |
- |
Deprecated. {0}. 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 |
- |
Alternative directory for xdoc source, useful for m1 to m2
migration Default value is: ${basedir}/xdocs . |
java.util.Map
No
${attributes}
java.io.File
Yes
${project.build.directory}/generated-site
java.lang.String
No
${encoding}
${project.build.sourceEncoding}
org.apache.maven.artifact.repository.ArtifactRepository
No
${localRepository}
java.lang.String
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
No
java.lang.String
No
${outputEncoding}
${project.reporting.outputEncoding}
port:
int
No
${port}
8080
java.util.List
No
${project.remoteArtifactRepositories}
java.io.File
Yes
${basedir}/src/site
java.io.File
No
${project.build.directory}/site-webapp
java.lang.String
No
${template}
java.io.File
No
${templateDirectory}
src/site
java.io.File
2.0-beta-5
No
${templateFile}
java.io.File
No
${basedir}/xdocs