Sentry Maven Skin 6.4.01
-
Home
- User Documentation Features 14
Maven properties (${property})
All properties defined in pom.xml can be referenced in the Markdown source documents (and others) using the ${propertyName} syntax, and will be replaced with their corresponding value in the resulting HTML.
Note
This is different from the default behavior of Maven Site and most skins. An extra-processing is performed with the Sentry Maven Skin to allow this feature.
Similarly, all properties defined in site/site.xml under the <custom> tag can also be referenced with the $decoration.getCustomValue("propertyName") syntax.
Properties in pom.xml
Example of a pom.xml:
<project>
...
<properties>
<productShortname>MetricsHub</productShortname>
<serviceUrl>https://metricshub.com/api</serviceUrl>
...
</properties>
In the source documents (src/site/markdown/*.md, or others), you can use $productShortname and $serviceUrl, which will be replaced with their corresponding value in the produced HTML:
**$productShortname** allows administrators to setup the monitoring of any application through an [API]($serviceUrl)...
This will produce the below result:
MetricsHub allows administrators to setup the monitoring of any application through an API[1]…
Dotted properties
If a property name contains dots, it cannot be referred to using the $property.subname syntax. You will need to use ${context.get("property.name")} as in the example below:
This documentation has been generated on ${context.get("project.build.outputTimestamp")}.
Properties in src/site/site.xml
Same principle goes with src/site/site.xml, with properties listed under <custom>:
<project name="My Documentation">
...
<custom>
<productShortname>MetricsHub</productShortname>
<serviceUrl>https://metricshub.com/api</serviceUrl>
...
</custom>
In the source documents (src/site/markdown/*.md, or others), you can use $decoration.getCustomValue("productShortName") and $decoration.getCustomValue("serviceUrl"), which will be replaced with with their corresponding value:
**$decoration.getCustomValue("productShortName")** allows administrators to setup the monitoring of any application through an [API]($decoration.getCustomValue("serviceUrl"))...
This will produce the below result:
MetricsHub allows administrators to setup the monitoring of any application through an API[1]…
Note
The syntax to reference values in
pom.xmllooks nicer and easier than the syntax forsrc/site/site.xml. However, it's the latter method that is recommended so that documentation information remains insrc/site/site.xmlrather than spread across several configuration files.
Other properties
Documents processed with Maven Site can also reference other objects that are defined by the Doxia SiteTools Site Renderer[2]. This includes various tools and useful metadata related to the project.