Full name:
org.apache.maven.plugins:maven-site-plugin:3.2:effective-site
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| attributes | Map | 2.2 | 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. User property is: generateProjectInfo. |
| generatedSiteDirectory | File | 2.2 | 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.2 | Specifies the input encoding. Default value is: ${project.build.sourceEncoding}. User property is: encoding. |
| locales | String | 2.2 | 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. User property is: locales. |
| moduleExcludes | Map | 2.2 | 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>
|
| output | File | 2.2 | Optional parameter to write the output of this help in a given
file, instead of writing to the console. Note: Could be a relative path. User property is: output. |
| outputEncoding | String | 2.2 | Specifies the output encoding. Default value is: ${project.reporting.outputEncoding}. User property is: 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. User property is: relativizeDecorationLinks. |
| 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.2 | Directory containing the site.xml file and the source for apt, fml
and xdoc docs. Default value is: ${basedir}/src/site. |
| template | String | 2.2 | Deprecated. use templateFile or skinning instead User property is: template. |
| templateDirectory | File | 2.2 | Deprecated. use templateFile or skinning instead Default value is: src/site. User property is: templateDirectory. |
| 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. User property is: templateFile. |
| xdocDirectory | File | 2.2 | Deprecated. use the standard m2 directory layout Default value is: ${basedir}/xdocs. |
<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>
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.