This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch DOXIASITETOOLS-230
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
The following commit(s) were added to refs/heads/DOXIASITETOOLS-230 by this
push:
new f41b5b6 [DOXIASITETOOLS-230] improve doc
f41b5b6 is described below
commit f41b5b6bfc97da930fe51fa8c7523602bd342a74
Author: Hervé Boutemy <[email protected]>
AuthorDate: Sat May 28 17:42:38 2022 +0200
[DOXIASITETOOLS-230] improve doc
---
doxia-site-renderer/pom.xml | 8 ++-
doxia-site-renderer/src/site/apt/index.apt.vm | 88 +++++++++++++--------------
2 files changed, 50 insertions(+), 46 deletions(-)
diff --git a/doxia-site-renderer/pom.xml b/doxia-site-renderer/pom.xml
index 8421f2c..dbdf51b 100644
--- a/doxia-site-renderer/pom.xml
+++ b/doxia-site-renderer/pom.xml
@@ -34,6 +34,10 @@ under the License.
<name>Doxia Sitetools :: Site Renderer</name>
<description>The Site Renderer handles the rendering of sites, merging site
decoration with document content.</description>
+ <properties>
+ <velocityEngineVersion>2.3</velocityEngineVersion>
+ <velocityToolsVersion>3.1</velocityToolsVersion>
+ </properties>
<dependencies>
<dependency>
@@ -120,12 +124,12 @@ under the License.
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
- <version>2.3</version>
+ <version>${velocityEngineVersion}</version>
</dependency>
<dependency>
<groupId>org.apache.velocity.tools</groupId>
<artifactId>velocity-tools-generic</artifactId>
- <version>3.1</version>
+ <version>${velocityToolsVersion}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
diff --git a/doxia-site-renderer/src/site/apt/index.apt.vm
b/doxia-site-renderer/src/site/apt/index.apt.vm
index d4ff531..f6a7417 100644
--- a/doxia-site-renderer/src/site/apt/index.apt.vm
+++ b/doxia-site-renderer/src/site/apt/index.apt.vm
@@ -34,7 +34,7 @@ Doxia Sitetools - Site Renderer
Documents can be dynamically generated with
{{{/doxia/doxia/doxia-sink-api/}Doxia Sink API}}, like Maven reports,
or simply read from static files written in
{{{/doxia/references/index.html}markup supported by Doxia Parsers}},
- eventually processed by {{{https://velocity.apache.org/engine/2.3/}Velocity}}
+ eventually processed by
{{{https://velocity.apache.org/engine/${velocityEngineVersion}/}Velocity}}
if their file names end in <<<.vm>>>.
[doxia-site-renderer.png]
@@ -76,62 +76,62 @@ Doxia Sitetools - Site Renderer
There are also some tools for general use:
-#set( $plexus =
"http://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus"; )
+#set( $plexus =
"https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util";
)
*---------------------------------+------------------------------------------------------+-------------------------------+
|| Variable || Type
|| Description ||
*---------------------------------+------------------------------------------------------+-------------------------------+
-| <<<PathTool>>> |
{{{$plexus/util/PathTool.html}<<<PathTool>>>}} |
|
+| <<<PathTool>>> | {{{$plexus/PathTool.html}<<<PathTool>>>}}
| |
*---------------------------------+------------------------------------------------------+-------------------------------+
-| <<<StringUtils>>> |
{{{$plexus/util/StringUtils.html}<<<StringUtils>>>}} |
|
+| <<<StringUtils>>> |
{{{$plexus/StringUtils.html}<<<StringUtils>>>}} |
|
*---------------------------------+------------------------------------------------------+-------------------------------+
-| <<<plexus>>> |
{{{http://git.eclipse.org/c/sisu/org.eclipse.sisu.plexus.git/tree/org.eclipse.sisu.plexus/src/org/codehaus/plexus/PlexusContainer.java}<<<PlexusContainer>>>}}
| |
+| <<<plexus>>> |
{{{https://github.com/eclipse/sisu.plexus/blob/master/org.eclipse.sisu.plexus/src/org/codehaus/plexus/PlexusContainer.java}<<<PlexusContainer>>>}}
| |
*---------------------------------+------------------------------------------------------+-------------------------------+
- Additionally, there are
{{{http://velocity.apache.org/tools/releases/2.0/generic.html} Velocity Generic
Tools}} populated
+ Additionally, there are
{{{https://velocity.apache.org/tools/${velocityToolsVersion}/tools-summary.html}
Velocity Generic Tools}} populated
with the site locale, the decoration model's date format, and site
renderer's resource bundle:
-#set( $generic =
"http://velocity.apache.org/tools/releases/2.0/javadoc/org/apache/velocity/tools/generic";
)
-*------------------+----------------------------------------------------------+-------------------------------+
-|| Variable || Type
|| Description ||
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<alternator>>> | {{{$generic/AlternatorTool.html}AlternatorTool}}
| <<Deprecated>>: use CSS3 nth-child(even/odd) selectors or #if($foreach.index
% 2). For creating alternators to easily alternate over a set of values.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<class>>> | {{{$generic/ClassTool.html}ClassTool}}
| For simplifying reflective lookup of information about classes and their
fields, methods and constructors.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<context>>> | {{{$generic/ContextTool.html}ContextTool}}
| For convenient access to context data and metadata.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<convert>>> | {{{$generic/ConversionTool.html}ConversionTool}}
| <<Deprecated>>: use NumberTool for numbers formatting/parsing, DateTool for
date/time formatting/parsing, or CollectionTool for toStrings(). For converting
String values to richer object Types.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<date>>> | {{{$generic/ComparisonDateTool.html}ComparisonDateTool}}
| For manipulating, formatting, and comparing dates.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<display>>> | {{{$generic/DisplayTool.html}DisplayTool}}
| For controlling display of references (e.g., truncating values, "pretty
printing" lists, and displaying alternates when a reference is null).
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<esc>>> | {{{$generic/EscapeTool.html}EscapeTool}}
| For common escaping needs in Velocity templates (e.g. escaping html, xml,
javascript etc.).
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<field>>> | {{{$generic/FieldTool.html}FieldTool}}
| For (easy) access to static fields in a class, such as string constants.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<link>>> | {{{$generic/LinkTool.html}LinkTool}}
| For creating and manipulating URIs and URLs. The API for this tool is
designed to closely resemble that of the VelocityView tool of the same name.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<loop>>> | {{{$generic/LoopTool.html}LoopTool}}
| A convenience tool to use with \#foreach loops. It wraps a list with a custom
iterator to provide greater control, allowing loops to end early, skip ahead
and more.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<math>>> | {{{$generic/MathTool.html}MathTool}}
| For performing math functions.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<number>>> | {{{$generic/NumberTool.html}NumberTool}}
| For formatting and converting numbers.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<render>>> | {{{$generic/RenderTool.html}RenderTool}}
| To evaluate and render arbitrary strings of VTL, including recursive
rendering.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<text>>> | {{{$generic/ResourceTool.html}ResourceTool}}
| For simplified access to resource bundles for internationalization or other
dynamic content needs.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<sorter>>> | {{{$generic/SortTool.html}SortTool}}
| <<Deprecated>>: use CollectionTool sort methods. Used to sort collections (or
arrays, iterators, etc) on any arbitary set of properties exposed by the
objects contained within the collection.
-*------------------+----------------------------------------------------------+-------------------------------+
-| <<<xml>>> | {{{$generic/XmlTool.html}XmlTool}}
| For reading/navigating XML files. This uses dom4j under the covers and
provides complete XPath support.
-*------------------+----------------------------------------------------------+-------------------------------+
+#set( $generic = "https://velocity.apache.org/tools/3.1/tools-summary.html"; )
+*------------------+-----------------------------------------------------+-------------------------------+
+|| Variable || Type ||
Description ||
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<alternator>>> | {{{$generic#deprecated-tools}AlternatorTool}} |
{{{$generic#deprecated-tools}<<Deprecated>>}}: use CSS3 nth-child(even/odd)
selectors or #if($foreach.index % 2). For creating alternators to easily
alternate over a set of values.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<class>>> | {{{$generic#ClassTool}ClassTool}} | For
simplifying reflective lookup of information about classes and their fields,
methods and constructors.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<context>>> | {{{$generic#ContextTool}ContextTool}} | For
convenient access to context data and metadata.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<convert>>> | {{{$generic#deprecated-tools}ConversionTool}} |
{{{$generic#deprecated-tools}<<Deprecated>>}}: use NumberTool for numbers
formatting/parsing, DateTool for date/time formatting/parsing, or
CollectionTool for toStrings(). For converting String values to richer object
Types.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<date>>> | {{{$generic#ComparisonDateTool}ComparisonDateTool}} | For
manipulating, formatting, and comparing dates.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<display>>> | {{{$generic#DisplayTool}DisplayTool}} | For
controlling display of references (e.g., truncating values, "pretty printing"
lists, and displaying alternates when a reference is null).
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<esc>>> | {{{$generic#EscapeTool}EscapeTool}} | For
common escaping needs in Velocity templates (e.g. escaping html, xml,
javascript etc.).
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<field>>> | {{{$generic#FieldTool}FieldTool}} | For
(easy) access to static fields in a class, such as string constants.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<link>>> | {{{$generic#LinkTool}LinkTool}} | For
creating and manipulating URIs and URLs. The API for this tool is designed to
closely resemble that of the VelocityView tool of the same name.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<loop>>> | {{{$generic#LoopTool}LoopTool}} | A
convenience tool to use with <<<\#foreach>>> loops. It wraps a list with a
custom iterator to provide greater control, allowing loops to end early, skip
ahead and more.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<math>>> | {{{$generic#MathTool}MathTool}} | For
performing math functions.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<number>>> | {{{$generic#NumberTool}NumberTool}} | For
formatting and converting numbers.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<render>>> | {{{$generic#RenderTool}RenderTool}} | To
evaluate and render arbitrary strings of VTL, including recursive rendering.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<text>>> | {{{$generic#ResourceTool}ResourceTool}} | For
simplified access to resource bundles for internationalization or other dynamic
content needs.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<sorter>>> | {{{$generic#deprecated-tools}SortTool}} |
{{{$generic#deprecated-tools}<<Deprecated>>}}: use CollectionTool sort methods.
Used to sort collections (or arrays, iterators, etc) on any arbitary set of
properties exposed by the objects contained within the collection.
+*------------------+-----------------------------------------------------+-------------------------------+
+| <<<xml>>> | {{{$generic#XmlTool}XmlTool}} | For
reading/navigating XML files. This uses dom4j under the covers and provides
complete XPath support.
+*------------------+-----------------------------------------------------+-------------------------------+
If you intend to use custom Velocity tools, add them to the Maven Site
Plugin's dependency list and make sure
that they have a bundled configuration file in
<<</META-INF/maven/site-tools.xml>>>.
- See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L488}DefaultSiteRenderer.createToolManagedVelocityContext(...)}}>>>
- source for more details and the
{{{http://velocity.apache.org/tools/devel/summary.html}tools usage summary}}.
+ See
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L483}DefaultSiteRenderer.createToolManagedVelocityContext(...)}}>>>
+ source for more details and the
{{{https://velocity.apache.org/tools/devel/summary.html}tools usage summary}}.
** Maven Site Plugin
