l10n:report
Note:
This goal should be used as a Maven report.
Full name:
org.codehaus.mojo:l10n-maven-plugin:1.1.0:report
Description:
A simple report for keeping track of l10n status. It lists all bundle properties files and the number of properties in them. For a configurable list of locales it also tracks the progress of localization.
Attributes:
- Requires a Maven project to be executed.
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
1.0.0
.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
<outputDirectory> |
File |
- |
The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.
A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by Default: ${project.build.directory}/reports |
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<aggregate> |
boolean |
1.0.0 |
Whether to build an aggregated report at the root, or build individual reports. Default: false User Property: maven.l10n.aggregate |
<excludes> |
List<String> |
1.0.0 |
A list of exclude patterns to use. By default no files are excluded. |
<includes> |
List<String> |
1.0.0 |
A list of include patterns to use. By default, all *.properties files are included. |
<locale> |
String |
- |
The locale to use when the report generation is invoked directly as a standalone Mojo. See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String) Default: default |
<locales> |
List<String> |
1.0.0 |
A list of locale strings that are to be watched for l10n status. |
<outputFormat> |
String |
- |
The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id. User Property: output.format |
<outputTimestamp> |
String |
- |
Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).Default: ${project.build.outputTimestamp} |
<siteDirectory> |
File |
- |
Directory containing the site.xml file.Default: ${basedir}/src/site |
Parameter Details
<aggregate>
- Type:
boolean
- Since:
1.0.0
- Required:
No
- User Property:
maven.l10n.aggregate
- Default:
false
<excludes>
- Type:
java.util.List<java.lang.String>
- Since:
1.0.0
- Required:
No
<includes>
*.properties
files are included.- Type:
java.util.List<java.lang.String>
- Since:
1.0.0
- Required:
No
<locale>
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
- Type:
java.lang.String
- Required:
No
- Default:
default
<locales>
- Type:
java.util.List<java.lang.String>
- Since:
1.0.0
- Required:
No
<outputDirectory>
A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName()
.
- Type:
java.io.File
- Required:
Yes
- Default:
${project.build.directory}/reports
<outputFormat>
- Type:
java.lang.String
- Required:
No
- User Property:
output.format
<outputTimestamp>
yyyy-MM-dd'T'HH:mm:ssXXX
or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).- Type:
java.lang.String
- Required:
No
- Default:
${project.build.outputTimestamp}
<siteDirectory>
site.xml
file.- Type:
java.io.File
- Required:
No
- Default:
${basedir}/src/site