sitemap:index
Full name:
io.earcam.maven.plugin:io.earcam.maven.plugin.sitemap:0.0.4:index
Description:
Mojo for generating sitemap indices
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator plugin.
- Binds by default to the lifecycle phase: site.
- Is NOT inherited by default in multi-project builds.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <baseUrl> | URI | - | The site's base URL, defaults to ${project.distributionManagement.site.url} Default value is: ${project.distributionManagement.site.url}. User property is: sitemap.url.base. |
| <gzip> | boolean | - | Whether to GZIP the generated files Default value is: false. User property is: sitemap.gzip. |
| <include> | String | - | Regular expression determining which file names to include Default value is: .*\.html?$. User property is: sitemap.include.regex. |
| <skip> | boolean | - | Skip execution of this plugin Default value is: false. User property is: sitemap.skip. |
| <sourceDir> | File | - | Location of files to index, defaults to ${project.reporting.outputDirectory} Default value is: ${project.reporting.outputDirectory}. User property is: sitemap.dir.source. |
| <targetDir> | File | - | Location of where the sitemap/index should be written, defaults to ${project.reporting.outputDirectory} Default value is: ${project.reporting.outputDirectory}. User property is: sitemap.dir.target. |
Parameter Details
<baseUrl>
The site's base URL, defaults to ${project.distributionManagement.site.url}
- Type: java.net.URI
- Required: No
- User Property: sitemap.url.base
- Default: ${project.distributionManagement.site.url}
<gzip>
Whether to GZIP the generated files
- Type: boolean
- Required: No
- User Property: sitemap.gzip
- Default: false
<include>
Regular expression determining which file names to include
- Type: java.lang.String
- Required: No
- User Property: sitemap.include.regex
- Default: .*\.html?$
<skip>
Skip execution of this plugin
- Type: boolean
- Required: No
- User Property: sitemap.skip
- Default: false
<sourceDir>
Location of files to index, defaults to ${project.reporting.outputDirectory}
- Type: java.io.File
- Required: No
- User Property: sitemap.dir.source
- Default: ${project.reporting.outputDirectory}
<targetDir>
Location of where the sitemap/index should be written, defaults to ${project.reporting.outputDirectory}
- Type: java.io.File
- Required: No
- User Property: sitemap.dir.target
- Default: ${project.reporting.outputDirectory}