You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2022/05/28 21:08:14 UTC
[maven-doxia-sitetools] branch DOXIASITETOOLS-230 updated (f41b5b6 -> 423a410)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch DOXIASITETOOLS-230
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
discard f41b5b6 [DOXIASITETOOLS-230] improve doc
omit fa4eafb [DOXIASITETOOLS-230] Upgrade to Velocity Engine 2.3 and Velocity Tools 3.1
new 423a410 [DOXIASITETOOLS-230] Upgrade to Velocity Engine 2.3 and Velocity Tools 3.1
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (f41b5b6)
\
N -- N -- N refs/heads/DOXIASITETOOLS-230 (423a410)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
doxia-site-renderer/src/site/apt/index.apt.vm | 80 +++++++++++++--------------
1 file changed, 40 insertions(+), 40 deletions(-)
[maven-doxia-sitetools] 01/01: [DOXIASITETOOLS-230] Upgrade to Velocity Engine 2.3 and Velocity Tools 3.1
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch DOXIASITETOOLS-230
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
commit 423a4106c9eaea8045709800d1bbb0cc1089fda8
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun May 15 22:23:10 2022 +0200
[DOXIASITETOOLS-230] Upgrade to Velocity Engine 2.3 and Velocity Tools 3.1
This closes #42
---
doxia-site-renderer/pom.xml | 41 +++---------
doxia-site-renderer/src/site/apt/index.apt.vm | 92 +++++++++++++--------------
pom.xml | 10 ---
3 files changed, 56 insertions(+), 87 deletions(-)
diff --git a/doxia-site-renderer/pom.xml b/doxia-site-renderer/pom.xml
index 4ecf0cf..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>
@@ -103,6 +107,7 @@ under the License.
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-velocity</artifactId>
+ <version>2.0</version>
<exclusions>
<exclusion>
<groupId>org.codehaus.plexus</groupId>
@@ -118,39 +123,13 @@ under the License.
<!-- misc -->
<dependency>
<groupId>org.apache.velocity</groupId>
- <artifactId>velocity</artifactId>
+ <artifactId>velocity-engine-core</artifactId>
+ <version>${velocityEngineVersion}</version>
</dependency>
<dependency>
- <groupId>org.apache.velocity</groupId>
- <artifactId>velocity-tools</artifactId>
- <version>2.0</version>
- <exclusions>
- <!-- exclude VelocityView and VelocityStruts specific dependencies -->
- <exclusion>
- <groupId>javax.servlet</groupId>
- <artifactId>servlet-api</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.apache.struts</groupId>
- <artifactId>struts-core</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.apache.struts</groupId>
- <artifactId>struts-taglib</artifactId>
- </exclusion>
- <exclusion>
- <groupId>org.apache.struts</groupId>
- <artifactId>struts-tiles</artifactId>
- </exclusion>
- <exclusion>
- <groupId>sslext</groupId>
- <artifactId>sslext</artifactId>
- </exclusion>
- <exclusion>
- <groupId>commons-validator</groupId>
- <artifactId>commons-validator</artifactId>
- </exclusion>
- </exclusions>
+ <groupId>org.apache.velocity.tools</groupId>
+ <artifactId>velocity-tools-generic</artifactId>
+ <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 efb1952..5499d03 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 {{{http://velocity.apache.org/engine/1.7/}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}} | 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}} | 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}} | 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/${velocityToolsVersion}/tools-summary.html" )
+*------------------+---------------------------------------------------------------+-------------------------------+
+|| Variable || Type || Description ||
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<alternator>>> | {{{$generic${esc.hash}deprecated-tools}AlternatorTool}} | {{{$generic${esc.hash}deprecated-tools}<<Deprecated>>}}: use CSS3 nth-child(even/odd) selectors or ${esc.hash}if($foreach.index % 2). For creating alternators to easily alternate over a set of values.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<class>>> | {{{$generic${esc.hash}ClassTool}ClassTool}} | For simplifying reflective lookup of information about classes and their fields, methods and constructors.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<context>>> | {{{$generic${esc.hash}ContextTool}ContextTool}} | For convenient access to context data and metadata.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<convert>>> | {{{$generic${esc.hash}deprecated-tools}ConversionTool}} | {{{$generic${esc.hash}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${esc.hash}ComparisonDateTool}ComparisonDateTool}} | For manipulating, formatting, and comparing dates.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<display>>> | {{{$generic${esc.hash}DisplayTool}DisplayTool}} | For controlling display of references (e.g., truncating values, "pretty printing" lists, and displaying alternates when a reference is null).
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<esc>>> | {{{$generic${esc.hash}EscapeTool}EscapeTool}} | For common escaping needs in Velocity templates (e.g. escaping html, xml, javascript etc.).
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<field>>> | {{{$generic${esc.hash}FieldTool}FieldTool}} | For (easy) access to static fields in a class, such as string constants.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<link>>> | {{{$generic${esc.hash}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${esc.hash}LoopTool}LoopTool}} | A convenience tool to use with <<<${esc.hash}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${esc.hash}MathTool}MathTool}} | For performing math functions.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<number>>> | {{{$generic${esc.hash}NumberTool}NumberTool}} | For formatting and converting numbers.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<render>>> | {{{$generic${esc.hash}RenderTool}RenderTool}} | To evaluate and render arbitrary strings of VTL, including recursive rendering.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<text>>> | {{{$generic${esc.hash}ResourceTool}ResourceTool}} | For simplified access to resource bundles for internationalization or other dynamic content needs.
+*------------------+---------------------------------------------------------------+-------------------------------+
+| <<<sorter>>> | {{{$generic${esc.hash}deprecated-tools}SortTool}} | {{{$generic${esc.hash}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${esc.hash}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${esc.hash}L483}DefaultSiteRenderer.createToolManagedVelocityContext(...)}}>>>
+ source for more details and the {{{https://velocity.apache.org/tools/devel/tools-summary.html}tools usage summary}}.
** Maven Site Plugin
@@ -149,7 +149,7 @@ Doxia Sitetools - Site Renderer
| <project properties> | <<<String>>> | Properties defined in POM are directly available. |
*---------------------------------+----------------------+-------------------------------+
- See <<<{{{/plugins/maven-site-plugin/apidocs/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html\#createSiteRenderingContext(java.util.Locale)}AbstractSiteRenderingMojo.createSiteRenderingContext(...)}}>>>
+ See <<<{{{/plugins/maven-site-plugin/apidocs/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html${esc.hash}createSiteRenderingContext(java.util.Locale)}AbstractSiteRenderingMojo.createSiteRenderingContext(...)}}>>>
source for more details.
** Site Template
@@ -175,5 +175,5 @@ Doxia Sitetools - Site Renderer
| <<<docRenderingContext>>> | {{{./apidocs/org/apache/maven/doxia/siterenderer/RenderingContext.html}<<<RenderingContext>>>}} | (since 1.8) The document rendering context. |
*---------------------------------+----------------------+-------------------------------+
- See <<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html\#L616}DefaultSiteRenderer.createSiteTemplateVelocityContext(...)}}>>>
+ See <<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html${esc.hash}L616}DefaultSiteRenderer.createSiteTemplateVelocityContext(...)}}>>>
source for more details.
diff --git a/pom.xml b/pom.xml
index 8c71396..2529215 100644
--- a/pom.xml
+++ b/pom.xml
@@ -156,11 +156,6 @@ under the License.
</exclusion>
</exclusions>
</dependency>
- <dependency>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-velocity</artifactId>
- <version>1.2</version>
- </dependency>
<!-- Don't upgrade, it is broken: https://github.com/codehaus-plexus/plexus-utils/commit/1e18ddcc98f318b36449102f3267fd4631cc668b -->
<dependency>
<groupId>org.codehaus.plexus</groupId>
@@ -184,11 +179,6 @@ under the License.
<artifactId>javax.inject</artifactId>
<version>1</version>
</dependency>
- <dependency>
- <groupId>org.apache.velocity</groupId>
- <artifactId>velocity</artifactId>
- <version>1.7</version>
- </dependency>
<!-- Test -->
<dependency>
<groupId>org.junit.jupiter</groupId>