sitemapxml:gen
Full name:
org.simplify4u.plugins:sitemapxml-maven-plugin:2.2.0:gen
Description:
Generate sitemap.xml for project site.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
site.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<includes> |
List<String> |
1.0.0 |
Files mask which be used to include its to sitemap.xml Default value is: *.html. |
<indexPages> |
List<String> |
2.2.0 |
List of index page names. Those names will be removed from the end of generated urls.
So for default configuration we will have: Default value is: index.html. |
<siteOutputDirectory> |
File |
1.0.0 |
Directory where the project sites and report distributions was generated. Default value is: ${project.reporting.outputDirectory}.User property is: siteOutputDirectory. |
<siteUrl> |
String |
1.0.0 |
URL prefix which will be used to build url in sitemap.xml Default value is: ${project.url}.User property is: sitemapxml.siteurl. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<maxDepth> |
int |
1.0.0 |
Maximum depth for looking for items for sitemap.xml Default value is: 1.User property is: sitemapxml.maxdept. |
<skip> |
boolean |
2.1.0 |
Skip sitemap.xml generation. Default value is: false.User property is: maven.site.skip. |
Parameter Details
<includes>
Files mask which be used to include its to sitemap.xml
- Type:
java.util.List<java.lang.String> - Since:
1.0.0 - Required:
Yes - Default:
*.html
<indexPages>
List of index page names. Those names will be removed from the end of generated urls.
So for default configuration we will have: https://www.example.com/ instead of https://www.example.com/index.html
- Type:
java.util.List<java.lang.String> - Since:
2.2.0 - Required:
Yes - Default:
index.html
<maxDepth>
Maximum depth for looking for items for sitemap.xml
- Type:
int - Since:
1.0.0 - Required:
No - User Property:
sitemapxml.maxdept - Default:
1
<siteOutputDirectory>
Directory where the project sites and report distributions was generated.
- Type:
java.io.File - Since:
1.0.0 - Required:
Yes - User Property:
siteOutputDirectory - Default:
${project.reporting.outputDirectory}
<siteUrl>
URL prefix which will be used to build url in sitemap.xml
- Type:
java.lang.String - Since:
1.0.0 - Required:
Yes - User Property:
sitemapxml.siteurl - Default:
${project.url}
<skip>
Skip sitemap.xml generation.
- Type:
boolean - Since:
2.1.0 - Required:
No - User Property:
maven.site.skip - Default:
false