Acquire the Maven site skin configuration from a Velocity template.
This way any custom setting from the site.xml file can be used when generating the site pages.
It was created to be used by Docs Maven Skin.
- No additional configuration, just add the dependency
- Read Maven Skin data from the custom tag inside a Velocity template
- Read general Maven Skin data, such as the current page id, easily inside a Velocity template
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:
$ mvn verify site
The verify phase is required, as otherwise some of the reports won't be created.
The code comes from adapting the tools includes inside the Reflow Maven Skin.
The tools are meant to be used through Velocity, by making use of Maven Site autofinder feature. Just include the project as a dependency on any Maven Skin, and then the tool will be accessible.
Having a keywords tag set as follows in the site.xml:
<custom>
<skinConfig>
...
<keywords>Velocity tool, configuration</keywords>
...
</skinConfig>
</custom>
Just invoke the tool like this:
<html>
<head>
...
<meta name="keywords" content="$config.keywords.getValue()">
...
</head>
...
<html>
And the keywords will be set into the template.
More information can be found in the documentation pages.
The project has been tested on the following Java versions:
- JDK 7
- JDK 8
- OpenJDK 7
All other dependencies are handled through Maven, and noted in the included POM file.
The recommended way to install the project is by setting it up as a dependency. To get the configuration information for this check the Maven Central Repository.
If for some reason manual installation is necessary, just use the following Maven command:
$ mvn install
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
The project has been released under the MIT License.