From 35daec14d9161f10f35b07731578093da9aa975d Mon Sep 17 00:00:00 2001 From: Andres Almiray Date: Sun, 11 Apr 2021 18:42:55 +0200 Subject: [PATCH] Document parsed project and Java named templates --- .../configuration/pages/name-templates.adoc | 70 +++++++++++-------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/docs/modules/configuration/pages/name-templates.adoc b/docs/modules/configuration/pages/name-templates.adoc index d188268..2d9086c 100644 --- a/docs/modules/configuration/pages/name-templates.adoc +++ b/docs/modules/configuration/pages/name-templates.adoc @@ -29,27 +29,32 @@ The following names are related to xref:configuration:project.adoc[] [%header, cols="<2,<5", width="100%"] |=== -| Key | Description -| projectName | the project name -| projectNameCapitalized | the project name, capitalized, hyphens replaced by spaces. -| projectVersion | the project version -| projectVersionMajor | the major number of the project's version -| projectVersionMinor | the minor number (if any) of the project's version -| projectVersionPatch | the patch number (if any) of the project's version -| projectVersionTag | the tag (if any) of the project's version -| projectVersionBuild | the build info (if any) of the project's version -| projectDescription | the project description -| projectLongDescription | the project long description -| projectWebsite | link to the project website -| projectLicense | the project license, typically an SPDX identifier -| projectAuthorsBySpace | space separated list of author names -| projectAuthorsByComma | commma separated list of author names -| projectTagsBySpace | space separate list of project tags -| projectTagsByComma | comma separate list of project tags -| projectJavaGroupId | the project groupId (Maven coordinates) -| projectJavaArtifactId | the project artifactId (Maven coordinates) -| projectJavaVersion | the project Java version -| projectMainClass | the main class launched by the executable script launcher +| Key | Description +| projectName | the project name +| projectNameCapitalized | the project name, capitalized, hyphens replaced by spaces. +| projectVersion | the project version +| projectVersionMajor | the major number of the project's version +| projectVersionMinor | the minor number (if any) of the project's version +| projectVersionPatch | the patch number (if any) of the project's version +| projectVersionTag | the tag (if any) of the project's version +| projectVersionBuild | the build info (if any) of the project's version +| projectDescription | the project description +| projectLongDescription | the project long description +| projectWebsite | link to the project website +| projectLicense | the project license, typically an SPDX identifier +| projectAuthorsBySpace | space separated list of author names +| projectAuthorsByComma | commma separated list of author names +| projectTagsBySpace | space separate list of project tags +| projectTagsByComma | comma separate list of project tags +| projectJavaGroupId | the project groupId (Maven coordinates) +| projectJavaArtifactId | the project artifactId (Maven coordinates) +| projectJavaVersion | the project Java version (full) +| projectJavaVersionMajor | the project Java version (major) +| projectJavaVersionMinor | the project Java version (minor) +| projectJavaVersionPatch | the project Java version (patch) +| projectJavaVersionTag | the project Java version (tag) +| projectJavaVersionBuild | the project Java version (build) +| projectMainClass | the main class launched by the executable script launcher |=== Additionally, every key/value from `project.extraProperties` is mapped with `project` as key prefix and the capitalized @@ -145,15 +150,20 @@ The following names are related to xref:configuration:distributions.adoc[] [%header, cols="<2,<5", width="100%"] |=== -| Key | Description -| distributionName | the name of the distribution -| distributionExecutable | the name of the executable script launcher -| distributionTagsBySpace | space separate list of distribution tags -| distributionTagsByComma | comma separate list of distribution tags -| distributionJavaGroupId | the distribution groupId (Maven coordinates) -| distributionJavaArtifactId | the distribution artifactId (Maven coordinates) -| distributionJavaVersion | the distribution Java version -| distributionMainClass | the main class launched by the executable script launcher +| Key | Description +| distributionName | the name of the distribution +| distributionExecutable | the name of the executable script launcher +| distributionTagsBySpace | space separate list of distribution tags +| distributionTagsByComma | comma separate list of distribution tags +| distributionJavaGroupId | the distribution groupId (Maven coordinates) +| distributionJavaArtifactId | the distribution artifactId (Maven coordinates) +| distributionJavaVersion | the distribution Java version (full) +| distributionJavaVersionMajor | the distribution Java version (major) +| distributionJavaVersionMinor | the distribution Java version (minor) +| distributionJavaVersionPatch | the distribution Java version (patch) +| distributionJavaVersionTag | the distribution Java version (tag) +| distributionJavaVersionBuild | the distribution Java version (build) +| distributionMainClass | the main class launched by the executable script launcher |=== Additionally, every key/value from `distribution..extraProperties` is mapped with `distribution` as key prefix