This is an automated email from the ASF dual-hosted git repository. cbrisson pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/velocity-site.git
The following commit(s) were added to refs/heads/main by this push: new 823c243 Link releases pages to index, plus several fixes here and there 823c243 is described below commit 823c243c733d3e276849ed903aed84b53b764ccb Author: Claude Brisson <cla...@renegat.net> AuthorDate: Mon Mar 8 21:05:47 2021 +0100 Link releases pages to index, plus several fixes here and there --- src/content/engine/1.7/index.mdtext | 2 +- src/content/engine/1.7/source-repository.mdtext | 2 +- src/content/engine/2.0/getting-started.mdtext | 19 ++------- src/content/engine/2.0/index.mdtext | 2 +- src/content/engine/2.1/getting-started.mdtext | 19 ++------- src/content/engine/2.1/index.mdtext | 2 +- src/content/engine/2.2/getting-started.mdtext | 19 ++------- src/content/engine/2.2/index.mdtext | 2 +- src/content/engine/2.3/developer-guide.mdtext | 2 +- src/content/engine/2.3/getting-started.mdtext | 19 ++------- src/content/engine/2.3/source-repository.mdtext | 2 +- src/content/engine/devel/developer-guide.mdtext | 2 +- src/content/engine/devel/index.mdtext | 2 +- src/content/engine/index.mdtext | 5 ++- src/content/index.mdtext | 4 +- src/content/left.nav | 4 +- src/content/news.xml | 52 +++++++++++++++++++++++++ src/content/release-process.mdtext | 11 +++++- src/content/tools/2.0/index.mdtext | 6 +-- src/content/tools/3.0/index.mdtext | 8 ++-- src/content/tools/3.1/generic.mdtext | 2 +- src/content/tools/3.1/index.mdtext | 33 ++++------------ src/content/tools/3.1/view.mdtext | 2 +- src/content/tools/devel/generic.mdtext | 2 +- src/content/tools/devel/index.mdtext | 33 ++++------------ src/content/tools/devel/view.mdtext | 2 +- src/content/tools/index.mdtext | 5 ++- 27 files changed, 121 insertions(+), 142 deletions(-) diff --git a/src/content/engine/1.7/index.mdtext b/src/content/engine/1.7/index.mdtext index 1d47343..f8d5538 100644 --- a/src/content/engine/1.7/index.mdtext +++ b/src/content/engine/1.7/index.mdtext @@ -8,7 +8,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 2.2. +The current stable release version is version 2.3. The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi).. diff --git a/src/content/engine/1.7/source-repository.mdtext b/src/content/engine/1.7/source-repository.mdtext index 89c11db..8a0df73 100644 --- a/src/content/engine/1.7/source-repository.mdtext +++ b/src/content/engine/1.7/source-repository.mdtext @@ -1,6 +1,6 @@ ## Overview -This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/). +~~This project uses [Subversion](http://subversion.tigris.org) to manage its source code. Instructions on Subversion use can be found at [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/).~~ ## Web Access diff --git a/src/content/engine/2.0/getting-started.mdtext b/src/content/engine/2.0/getting-started.mdtext index bf7df8a..8fbc2c8 100644 --- a/src/content/engine/2.0/getting-started.mdtext +++ b/src/content/engine/2.0/getting-started.mdtext @@ -13,23 +13,12 @@ The best place to start is with the examples provided in the distribution, and w ## Downloading Velocity -You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. +You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so using git, see the [downloads page](/download.cgi). -You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). - -Instructions for building Velocity from source can be found in the [Build](build.html) document. +Instructions for building Velocity from source can be found in the [Site Building](build.html) document. ## API Documentation -Our API documentation is available [online](apidocs/), as part of the distribution package, an of course, you can generate it yourself from the included source code. - -If you would like to create a full set of detailed API documentation for Velocity, go to the `build` directory and run: - - :::shell - ant javadocs - -The docs will be found in the `/bin/apidocs/` directory. - -**Note:** Velocity uses the [Maven](http://maven.Apache.org) build tool for all code and documentation generation, so you will need to have it installed. +Our API documentation is available [online](apidocs/), you can generate it yourself from the included source code using the `mvn javadoc:aggregate` command. diff --git a/src/content/engine/2.0/index.mdtext b/src/content/engine/2.0/index.mdtext index 161aaa1..85b298b 100644 --- a/src/content/engine/2.0/index.mdtext +++ b/src/content/engine/2.0/index.mdtext @@ -8,7 +8,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 2.2. +The current stable release version is version 2.3. The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). diff --git a/src/content/engine/2.1/getting-started.mdtext b/src/content/engine/2.1/getting-started.mdtext index bf7df8a..8fbc2c8 100644 --- a/src/content/engine/2.1/getting-started.mdtext +++ b/src/content/engine/2.1/getting-started.mdtext @@ -13,23 +13,12 @@ The best place to start is with the examples provided in the distribution, and w ## Downloading Velocity -You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. +You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so using git, see the [downloads page](/download.cgi). -You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). - -Instructions for building Velocity from source can be found in the [Build](build.html) document. +Instructions for building Velocity from source can be found in the [Site Building](build.html) document. ## API Documentation -Our API documentation is available [online](apidocs/), as part of the distribution package, an of course, you can generate it yourself from the included source code. - -If you would like to create a full set of detailed API documentation for Velocity, go to the `build` directory and run: - - :::shell - ant javadocs - -The docs will be found in the `/bin/apidocs/` directory. - -**Note:** Velocity uses the [Maven](http://maven.Apache.org) build tool for all code and documentation generation, so you will need to have it installed. +Our API documentation is available [online](apidocs/), you can generate it yourself from the included source code using the `mvn javadoc:aggregate` command. diff --git a/src/content/engine/2.1/index.mdtext b/src/content/engine/2.1/index.mdtext index b5a6298..c35da4c 100644 --- a/src/content/engine/2.1/index.mdtext +++ b/src/content/engine/2.1/index.mdtext @@ -8,7 +8,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 2.2. +The current stable release version is version 2.3. The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). diff --git a/src/content/engine/2.2/getting-started.mdtext b/src/content/engine/2.2/getting-started.mdtext index bf7df8a..8fbc2c8 100644 --- a/src/content/engine/2.2/getting-started.mdtext +++ b/src/content/engine/2.2/getting-started.mdtext @@ -13,23 +13,12 @@ The best place to start is with the examples provided in the distribution, and w ## Downloading Velocity -You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. +You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so using git, see the [downloads page](/download.cgi). -You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). - -Instructions for building Velocity from source can be found in the [Build](build.html) document. +Instructions for building Velocity from source can be found in the [Site Building](build.html) document. ## API Documentation -Our API documentation is available [online](apidocs/), as part of the distribution package, an of course, you can generate it yourself from the included source code. - -If you would like to create a full set of detailed API documentation for Velocity, go to the `build` directory and run: - - :::shell - ant javadocs - -The docs will be found in the `/bin/apidocs/` directory. - -**Note:** Velocity uses the [Maven](http://maven.Apache.org) build tool for all code and documentation generation, so you will need to have it installed. +Our API documentation is available [online](apidocs/), you can generate it yourself from the included source code using the `mvn javadoc:aggregate` command. diff --git a/src/content/engine/2.2/index.mdtext b/src/content/engine/2.2/index.mdtext index b5a6298..c35da4c 100644 --- a/src/content/engine/2.2/index.mdtext +++ b/src/content/engine/2.2/index.mdtext @@ -8,7 +8,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 2.2. +The current stable release version is version 2.3. The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). diff --git a/src/content/engine/2.3/developer-guide.mdtext b/src/content/engine/2.3/developer-guide.mdtext index d98cecb..ac2f0f3 100644 --- a/src/content/engine/2.3/developer-guide.mdtext +++ b/src/content/engine/2.3/developer-guide.mdtext @@ -1620,7 +1620,7 @@ Hello World example: ## Customizing the VTL parser -Since 2.2, Velocity Engine can use a custom parser. You need to generate your custom parser class, let's say `com.foo.MyCustomParser`, by copy pasting the content of the [velocity-custom-parser-example](https://dist.apache.org/repos/dist/dev/velocity/velocity-engine/2.3/velocity-custom-parser-example-2.3.pom) maven module pom file inside one of your own modules pom.xml, and then adapting its `<properties>` section. There's a minimal maven knowledge required to understand what you are doi [...] +Since 2.2, Velocity Engine can use a custom parser. You need to generate your custom parser class, let's say `com.foo.MyCustomParser`, by copy pasting the content of the [velocity-custom-parser-example](https://raw.githubusercontent.com/apache/velocity-engine/master/velocity-custom-parser-example/pom.xml) maven module pom file inside one of your own modules pom.xml, and then adapting its `<properties>` section. There's a minimal maven knowledge required to understand what you are doing, [...] This custom parser will let you configure the following VTL characters: diff --git a/src/content/engine/2.3/getting-started.mdtext b/src/content/engine/2.3/getting-started.mdtext index bf7df8a..8fbc2c8 100644 --- a/src/content/engine/2.3/getting-started.mdtext +++ b/src/content/engine/2.3/getting-started.mdtext @@ -13,23 +13,12 @@ The best place to start is with the examples provided in the distribution, and w ## Downloading Velocity -You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. For Velocity itself, source is included with the binary download. +You can download the latest release version of [Velocity Engine](/download.cgi#engine) or [Velocity Tools](/download.cgi#tools) from the main Apache Velocity download site. -If you want to download the latest source, you can do so via the Subversion (svn) source control system. +If you want to download the latest source, you can do so using git, see the [downloads page](/download.cgi). -You can also find published snapshots on the [Apache Snapshot Repository](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/). - -Instructions for building Velocity from source can be found in the [Build](build.html) document. +Instructions for building Velocity from source can be found in the [Site Building](build.html) document. ## API Documentation -Our API documentation is available [online](apidocs/), as part of the distribution package, an of course, you can generate it yourself from the included source code. - -If you would like to create a full set of detailed API documentation for Velocity, go to the `build` directory and run: - - :::shell - ant javadocs - -The docs will be found in the `/bin/apidocs/` directory. - -**Note:** Velocity uses the [Maven](http://maven.Apache.org) build tool for all code and documentation generation, so you will need to have it installed. +Our API documentation is available [online](apidocs/), you can generate it yourself from the included source code using the `mvn javadoc:aggregate` command. diff --git a/src/content/engine/2.3/source-repository.mdtext b/src/content/engine/2.3/source-repository.mdtext index fa20463..065bb6b 100644 --- a/src/content/engine/2.3/source-repository.mdtext +++ b/src/content/engine/2.3/source-repository.mdtext @@ -1,6 +1,6 @@ ## Overview -This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on Subversion use can be found at [Git documentation](https://git-scm.com/doc). +This project uses [Git](https://git-scm.com/) to manage its source code. Instructions on how to use git can be found at [Git documentation](https://git-scm.com/doc). ## Web Access diff --git a/src/content/engine/devel/developer-guide.mdtext b/src/content/engine/devel/developer-guide.mdtext index 85f616f..ac2f0f3 100644 --- a/src/content/engine/devel/developer-guide.mdtext +++ b/src/content/engine/devel/developer-guide.mdtext @@ -1620,7 +1620,7 @@ Hello World example: ## Customizing the VTL parser -Since 2.2, Velocity Engine can use a custom parser. You need to generate your custom parser class, let's say `com.foo.MyCustomParser`, by copy pasting the content of the [velocity-custom-parser-example](https://repository.apache.org/content/repositories/snapshots/org/apache/velocity/velocity-custom-parser-example/2.2-SNAPSHOT/velocity-custom-parser-example-2.2-20190908.141659-1.pom) maven module pom file inside one of your own modules pom.xml, and then adapting its `<properties>` section [...] +Since 2.2, Velocity Engine can use a custom parser. You need to generate your custom parser class, let's say `com.foo.MyCustomParser`, by copy pasting the content of the [velocity-custom-parser-example](https://raw.githubusercontent.com/apache/velocity-engine/master/velocity-custom-parser-example/pom.xml) maven module pom file inside one of your own modules pom.xml, and then adapting its `<properties>` section. There's a minimal maven knowledge required to understand what you are doing, [...] This custom parser will let you configure the following VTL characters: diff --git a/src/content/engine/devel/index.mdtext b/src/content/engine/devel/index.mdtext index b5a6298..c35da4c 100644 --- a/src/content/engine/devel/index.mdtext +++ b/src/content/engine/devel/index.mdtext @@ -8,7 +8,7 @@ You can check the [Velocity Template Language (VTL) reference](vtl-reference.htm ## Where do I get releases? -The current stable release version is version 2.2. +The current stable release version is version 2.3. The release distribution is available as a combined source/binary distribution in `tar.gz` and `zip` formats, and can be downloaded through the [Apache Mirror system](/download.cgi). diff --git a/src/content/engine/index.mdtext b/src/content/engine/index.mdtext index af9c48f..1c64ef8 100644 --- a/src/content/engine/index.mdtext +++ b/src/content/engine/index.mdtext @@ -6,13 +6,14 @@ Velocity permits you to use a simple yet powerful template language to reference ## Getting Started -The Velocity engine subproject contains the documentation to get started using the Velocity templating language and embedding Velocity into your own applications. Please select [the last released version](1.7) to get started. Once you are more familiar with Velocity or if you need a feature not yet released, you can check out the [Development Site](devel). +The Velocity engine subproject contains the documentation to get started using the Velocity templating language and embedding Velocity into your own applications. Please select [the last released version](2.3) to get started. Once you are more familiar with Velocity or if you need a feature not yet released, you can check out the [Development Site](devel). -+ [Engine 2.2](2.2) pages. ++ [Engine 2.3](2.3) pages. + [Engine Development Version](devel/) pages. ## Older Releases ++ [Engine 2.2 Release](2.2) + [Engine 2.1 Release](2.1) + [Engine 2.0 Release](2.0) + [Engine 1.7 Release](1.7) diff --git a/src/content/index.mdtext b/src/content/index.mdtext index 6eaaff9..eb39ec6 100644 --- a/src/content/index.mdtext +++ b/src/content/index.mdtext @@ -37,8 +37,8 @@ Apache Velocity offers the following projects: Project | Release Version | Alpha/Beta/RC Release Version --------|-----------------|------------------------------ -Velocity Engine | 2.2 | (currently none available) -Velocity Tools | 3.0 | (currently none available) +Velocity Engine | [2.3](engine/2.3) | (currently none available) +Velocity Tools | [3.1](tools/3.1) | (currently none available) The release distribution is available as a combined source/binary distribution in tar.gz and zip formats, and can be downloaded from [our download page](/download/cgi). diff --git a/src/content/left.nav b/src/content/left.nav index 69d69f5..645bfba 100644 --- a/src/content/left.nav +++ b/src/content/left.nav @@ -3,8 +3,8 @@ * [News](/news.html) * [Downloads](/download.cgi) ## Releases -* [Engine 2.2](/engine/2.2) -* [Tools 3.0](/tools/3.0) +* [Engine 2.3](/engine/2.3) +* [Tools 3.1](/tools/3.1) ## Development * [Engine](/engine/devel) * [Tools](/tools/devel) diff --git a/src/content/news.xml b/src/content/news.xml index 7c4fd9e..00f32c0 100644 --- a/src/content/news.xml +++ b/src/content/news.xml @@ -2,6 +2,58 @@ <news xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://velocity.apache.org/NEWS/1.0.0" xsi:schemaLocation="http://velocity.apache.org/NEWS/1.0.0 http://velocity.apache.org/site/tools/velocity-site-news/xsd/news-1.0.0.xsd"> <items> + <item id="tools31"> + <date>2021-02-27</date> + <headline>Velocity Tools 3.1 released</headline> + <categories> + <category>velocity</category> + <category>tools</category> + </categories> + <text><![CDATA[ + The Velocity developers are pleased to announce the release of Velocity Tools 3.1. + + VelocityTools is a collection of Velocity subprojects with a common goal of providing tools and infrastructure + for building both web and standalone applications using the Apache Velocity template engine. + + Main changes: + + * Added an optional 'factory' attribute to tools with the classname of a factory for creating new tools instances. + + * Added a new BreadcrumbTool meant to help displaying UI breadcrumb trails. + + * Fix potential XSS vulterability in VelocityViewServlet error handling. + + For a full list of changes, consult {{{Velocity Tools 3.1 Changes section}https://velocity.apache.org/tools/3.1/changes.html}} and {{{JIRA changelog}https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310130&version=12345408}. + + For notes on upgrading from earlier versions, see {{{Velocity Tools 3.1 Upgrading section}https://velocity.apache.org/tools/3.1/upgrading.html}}. + + Downloads of Velocity Tools 3.1 are available {{{http://velocity.apache.org/download.cgi#tools}here}}. + + ]]></text> + </item> + <item id="engine23"> + <date>2021-02-27</date> + <headline>Velocity Engine 2.3 released</headline> + <categories> + <category>velocity</category> + <category>engine</category> + </categories> + <text><![CDATA[ + The Velocity developers are pleased to announce the release of Velocity Engine 2.3. + + Main changes in this release: + + + Fix a minor security issue in user-edited templates applications: let SecureUberspector block methods on ClassLoader and subclasses. + + + New spring-velocity-support module for Velocity Engine integration in Spring Framework. + + For a full list of changes, consult {{{https://velocity.apache.org/engine/2.3/changes.html}Velocity Engine 2.3 Changes section}} and {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310104&version=12348601}JIRA changelog}}. + + For notes on upgrading, see {{{http://velocity.apache.org/engine/2.3/upgrading.html}Velocity Engine 2.3 Upgrading section}}. + + Downloads of 2.3 are available {{{http://velocity.apache.org/download.cgi#engine}here}}. + ]]></text> + </item> <item id="engine22"> <date>2020-02-02</date> <headline>Velocity Engine 2.2 released</headline> diff --git a/src/content/release-process.mdtext b/src/content/release-process.mdtext index dd241dc..4bcaf09 100644 --- a/src/content/release-process.mdtext +++ b/src/content/release-process.mdtext @@ -305,10 +305,17 @@ After a vote is finished, and it has been decided that is **at least of alpha qu src/content/left.nav src/content/news.xml src/content/${module}/index.mdtext - src/trunk/content/index.mdtext (status section) + src/content/index.mdtext (status section) + There are also several mentions of the *current releaase* in all releases specific pages which should be upgraded (at least for the engine ; something similar should be done for the tools - *TODO*). You can do so by adapting the following bash one-liner: + + :::shell + sed -ri -e 's/The current stable release version is version 2.2/The current stable release version is version 2.3/' $(find . -path "*/engine/*/index.mdtext") + + For the tools, update the links towards `tools.xml` configuration files in `generic.mdtext` and `view.mdtext`. + Change the content of the `changes_report` tag in `<module>/<version>/changes.mdtext` to `<module>/<version>` (for instance: `{{changes_report(engine/2.3)}}`). - + Push the changes into production. Check the resulting site for broken links diff --git a/src/content/tools/2.0/index.mdtext b/src/content/tools/2.0/index.mdtext index 98f780b..8eda945 100644 --- a/src/content/tools/2.0/index.mdtext +++ b/src/content/tools/2.0/index.mdtext @@ -32,11 +32,9 @@ Those already familiar with VelocityTools 1.x may be curious about the goals and These things could not have been accomplished without rewriting most of the core infrastructure and configuration code. At the same time, we wanted to make it easy for people to upgrade from the 1.x series. This led to the decision to aim for complete backwards compatibility. Granted much has been deprecated and those who directly used or extended the 1.x infrastructure will have to update their code in just a few releases, but for the time being they should be able to use 2.0 in thei [...] -## Subversion Repository +## Sources Repository -All VelocityTools project code is maintained in the Subversion repository which can be reached in a number of ways. The most direct method of accessing the repository is through a web browser, but to effectively work on the code, a [Subversion client](http://svn.tigris.org/links.html#clients) is required. - -Repository: [http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/](http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/). +All VelocityTools project code is maintained in the Apache gitbox repository and mirrored on github, see the [downloads section](/download.cgi). ## Helping Out diff --git a/src/content/tools/3.0/index.mdtext b/src/content/tools/3.0/index.mdtext index 3302c33..d23f16f 100644 --- a/src/content/tools/3.0/index.mdtext +++ b/src/content/tools/3.0/index.mdtext @@ -6,7 +6,7 @@ A Velocity "tool" is just a POJO (plain old java object) that is "useful" in a t The VelocityTools project is, first of all, a collection of such useful Java classes, as well as infrastructure to easily, automatically and transparently make these tools available to your Velocity templates. Other aims of the project include providing easy integration of Velocity into the view-layer of your web applications (via the [VelocityViewTag](view-tag.html), [VelocityViewServlet](view-servlet.html)) and the [Maven Plugin](maven-velocity-tools-plugin/index.html). -In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html. Each of these parts builds on the previous one and has its own JAR distribution. +In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html). Each of these parts builds on the previous one and has its own JAR distribution. ### GenericTools @@ -28,11 +28,9 @@ Velocity Tools 3.0 new features: See the [Upgrading section](upgrading.html) for a complete list of changes. -## Subversion Repository +## Sources Repository -All VelocityTools project code is maintained in the Subversion repository which can be reached in a number of ways. The most direct method of accessing the repository is through a web browser, but to effectively work on the code, a [Subversion client](http://svn.tigris.org/links.html#clients) is required. - -Repository: [http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/](http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/). +All VelocityTools project code is maintained in the Apache gitbox repository and mirrored on github, see the [downloads section](/download.cgi). ## Helping Out diff --git a/src/content/tools/3.1/generic.mdtext b/src/content/tools/3.1/generic.mdtext index af907bf..096a315 100644 --- a/src/content/tools/3.1/generic.mdtext +++ b/src/content/tools/3.1/generic.mdtext @@ -70,7 +70,7 @@ You can then create Velocity contexts with: ## Default Configuration -The default configuration provided for GenericTools is [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml?view=markup). It includes all of the tools listed [below](#tools). +The default configuration provided for GenericTools is [here](https://github.com/apache/velocity-tools/blob/8e7f20a4/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml). It includes all of the tools listed [below](#tools). ## Dependencies diff --git a/src/content/tools/3.1/index.mdtext b/src/content/tools/3.1/index.mdtext index 0d99142..62953ad 100644 --- a/src/content/tools/3.1/index.mdtext +++ b/src/content/tools/3.1/index.mdtext @@ -6,7 +6,7 @@ A Velocity "tool" is just a POJO (plain old java object) that is "useful" in a t The VelocityTools project is, first of all, a collection of such useful Java classes, as well as infrastructure to easily, automatically and transparently make these tools available to your Velocity templates. Other aims of the project include providing easy integration of Velocity into the view-layer of your web applications (via the [VelocityViewTag](view-tag.html), [VelocityViewServlet](view-servlet.html)) and the [Maven Plugin](maven-velocity-tools-plugin/index.html). -In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html. Each of these parts builds on the previous one and has its own JAR distribution. +In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html). Each of these parts builds on the previous one and has its own JAR distribution. ### GenericTools @@ -16,33 +16,18 @@ In recognition of these varying aims, the VelocityTools project is divided into [VelocityView](view.html) includes all of the [GenericTools](generic.html) structure and specialized tools for using Velocity in the view layer of web applications (Java EE projects). This includes the [VelocityViewServlet](view-servlet.html) or [VelocityLayoutServlet](view-layoutservlet.html) for processing Velocity template requests, the [VelocityViewTag](view-tag.html) for embedding Velocity in JSP and a [Maven plugin](maven-velocity-tools-plugin/index.html) to embed JSP tag libraries [...] -## What's new in 3.0 +## What's new in 3.1 -Velocity Tools 3.0 new features: +Velocity Tools 3.1 new features: -+ Use of Velocity Engine v2.0. -+ New generic [CollectionTool](apidocs/org/apache/velocity/tools/generic/CollectionTool.html) which replaces and enhances the former SortTool. -+ New generic [JsonTool](apidocs/org/apache/velocity/tools/generic/JsonTool.html) and view [JsonTool](apidocs/org/apache/velocity/tools/view/JsonTool.html). -+ New generic [LogTool](apidocs/org/apache/velocity/tools/generic/LogTool.html). -+ A [Maven plugin](maven-velocity-tools-plugin/index.html) to allow embedding of JSP tag libraries inside Velocity templates. ++ Added an optional 'factory' attribute to tools with the classname of a factory for creating new tools instances. ++ Added a new BreadcrumbTool meant to help displaying UI breadcrumb trails. See the [Upgrading section](upgrading.html) for a complete list of changes. -## Why 2.0? +## Sources Repository -Those already familiar with VelocityTools 1.x may be curious about the goals and motivations behind developing VelocityTools 2. In planning and developing the 2.0 release, there were three main goals: - -+ Transparent, on-demand tool instantiation (aka lazy loading for tools) - This allows you to have many tools available (even ones that are expensive to instantiate), but not waste time instantiating or initializing/configuring those you don't use for every request. -+ More accessible, reusable infrastructure - This allows easier access to tools outside of your templates and provides better means to integrate VelocityTools support into other web frameworks or even other view technologies (e.g. VelocityViewTag). -+ Simpler, more flexible toolbox [configuration](configuration.html) - Now you can configure via a [properties file](config-properties.html), [plain java](config-java.html), or really whatever you want (though perhaps with a bit more work). No [XML](config-xml.html) required anymore; though, if you do use it, it's now a lot better than it was. - -These things could not have been accomplished without rewriting most of the core infrastructure and configuration code. At the same time, we wanted to make it easy for people to upgrade from the 1.x series. This led to the decision to aim for complete backwards compatibility. Granted much has been deprecated and those who directly used or extended the 1.x infrastructure will have to update their code in just a few releases, but for the time being they should be able to use 2.0 in thei [...] - -## Subversion Repository - -All VelocityTools project code is maintained in the Subversion repository which can be reached in a number of ways. The most direct method of accessing the repository is through a web browser, but to effectively work on the code, a [Subversion client](http://svn.tigris.org/links.html#clients) is required. - -Repository: [http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/](http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/). +All VelocityTools project code is maintained in the Apache gitbox repository and mirrored on github, see the [downloads section](/download.cgi). ## Helping Out @@ -61,15 +46,13 @@ A few good places to get started include: + Working on unresolved tasks in [JIRA](http://issues.apache.org/jira/browse/VELTOOLS) + Contributing to the [VelocimacroLibrary](http://wiki.apache.org/velocity/VelocimacroLibrary) -Other project goals and proposals can be found in the project STATUS[http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/STATUS?view=markup] file. - ### Code When contributing code, it helps <strong>immensely</strong> if you follow through with the things on this checklist, especially the coding conventions. Keeping our code style consistent, our codebase stays easy to read and easy to patch. Adding javadoc (and examples therein) simplifies the documentation process and reduces confusion about the purpose of various methods and classes. Tests make sure that things work as expected, especially as development continues down the road. Of cours [...] **Checklist for Code Contributions**: -+ [Velocity coding conventions](http://wiki.apache.org/velocity/CodeStandards) ++ [Velocity coding conventions](https://wiki.apache.org/velocity/CodeStandards) + Javadoc included (the more detailed the better) + Examples included (in JavaDoc or as stand-alone template example) + Tests included (not required but <b>GREATLY</b> appreciated) diff --git a/src/content/tools/3.1/view.mdtext b/src/content/tools/3.1/view.mdtext index 186fd85..50eb257 100644 --- a/src/content/tools/3.1/view.mdtext +++ b/src/content/tools/3.1/view.mdtext @@ -27,7 +27,7 @@ Otherwise, see the [download page](/download.html#tools) for how to get the Velo ## Default Configuration -The default configuration provided for VelocityView is [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml?view=markup") and [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/resources/org/apache/velocity/tools/view/tools.xml?view=markup). +The default configuration provided for VelocityView is [here](https://github.com/apache/velocity-tools/blob/8e7f20a4/velocity-tools-view/src/main/resources/org/apache/velocity/tools/view/tools.xml). ## Dependencies diff --git a/src/content/tools/devel/generic.mdtext b/src/content/tools/devel/generic.mdtext index af907bf..f00541c 100644 --- a/src/content/tools/devel/generic.mdtext +++ b/src/content/tools/devel/generic.mdtext @@ -70,7 +70,7 @@ You can then create Velocity contexts with: ## Default Configuration -The default configuration provided for GenericTools is [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml?view=markup). It includes all of the tools listed [below](#tools). +The default configuration provided for GenericTools is [here](https://github.com/apache/velocity-tools/blob/master/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml). It includes all of the tools listed [below](#tools). ## Dependencies diff --git a/src/content/tools/devel/index.mdtext b/src/content/tools/devel/index.mdtext index 0d99142..62953ad 100644 --- a/src/content/tools/devel/index.mdtext +++ b/src/content/tools/devel/index.mdtext @@ -6,7 +6,7 @@ A Velocity "tool" is just a POJO (plain old java object) that is "useful" in a t The VelocityTools project is, first of all, a collection of such useful Java classes, as well as infrastructure to easily, automatically and transparently make these tools available to your Velocity templates. Other aims of the project include providing easy integration of Velocity into the view-layer of your web applications (via the [VelocityViewTag](view-tag.html), [VelocityViewServlet](view-servlet.html)) and the [Maven Plugin](maven-velocity-tools-plugin/index.html). -In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html. Each of these parts builds on the previous one and has its own JAR distribution. +In recognition of these varying aims, the VelocityTools project is divided into two parts: [GenericTools](generic.html) and [VelocityView](view.html). Each of these parts builds on the previous one and has its own JAR distribution. ### GenericTools @@ -16,33 +16,18 @@ In recognition of these varying aims, the VelocityTools project is divided into [VelocityView](view.html) includes all of the [GenericTools](generic.html) structure and specialized tools for using Velocity in the view layer of web applications (Java EE projects). This includes the [VelocityViewServlet](view-servlet.html) or [VelocityLayoutServlet](view-layoutservlet.html) for processing Velocity template requests, the [VelocityViewTag](view-tag.html) for embedding Velocity in JSP and a [Maven plugin](maven-velocity-tools-plugin/index.html) to embed JSP tag libraries [...] -## What's new in 3.0 +## What's new in 3.1 -Velocity Tools 3.0 new features: +Velocity Tools 3.1 new features: -+ Use of Velocity Engine v2.0. -+ New generic [CollectionTool](apidocs/org/apache/velocity/tools/generic/CollectionTool.html) which replaces and enhances the former SortTool. -+ New generic [JsonTool](apidocs/org/apache/velocity/tools/generic/JsonTool.html) and view [JsonTool](apidocs/org/apache/velocity/tools/view/JsonTool.html). -+ New generic [LogTool](apidocs/org/apache/velocity/tools/generic/LogTool.html). -+ A [Maven plugin](maven-velocity-tools-plugin/index.html) to allow embedding of JSP tag libraries inside Velocity templates. ++ Added an optional 'factory' attribute to tools with the classname of a factory for creating new tools instances. ++ Added a new BreadcrumbTool meant to help displaying UI breadcrumb trails. See the [Upgrading section](upgrading.html) for a complete list of changes. -## Why 2.0? +## Sources Repository -Those already familiar with VelocityTools 1.x may be curious about the goals and motivations behind developing VelocityTools 2. In planning and developing the 2.0 release, there were three main goals: - -+ Transparent, on-demand tool instantiation (aka lazy loading for tools) - This allows you to have many tools available (even ones that are expensive to instantiate), but not waste time instantiating or initializing/configuring those you don't use for every request. -+ More accessible, reusable infrastructure - This allows easier access to tools outside of your templates and provides better means to integrate VelocityTools support into other web frameworks or even other view technologies (e.g. VelocityViewTag). -+ Simpler, more flexible toolbox [configuration](configuration.html) - Now you can configure via a [properties file](config-properties.html), [plain java](config-java.html), or really whatever you want (though perhaps with a bit more work). No [XML](config-xml.html) required anymore; though, if you do use it, it's now a lot better than it was. - -These things could not have been accomplished without rewriting most of the core infrastructure and configuration code. At the same time, we wanted to make it easy for people to upgrade from the 1.x series. This led to the decision to aim for complete backwards compatibility. Granted much has been deprecated and those who directly used or extended the 1.x infrastructure will have to update their code in just a few releases, but for the time being they should be able to use 2.0 in thei [...] - -## Subversion Repository - -All VelocityTools project code is maintained in the Subversion repository which can be reached in a number of ways. The most direct method of accessing the repository is through a web browser, but to effectively work on the code, a [Subversion client](http://svn.tigris.org/links.html#clients) is required. - -Repository: [http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/](http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/). +All VelocityTools project code is maintained in the Apache gitbox repository and mirrored on github, see the [downloads section](/download.cgi). ## Helping Out @@ -61,15 +46,13 @@ A few good places to get started include: + Working on unresolved tasks in [JIRA](http://issues.apache.org/jira/browse/VELTOOLS) + Contributing to the [VelocimacroLibrary](http://wiki.apache.org/velocity/VelocimacroLibrary) -Other project goals and proposals can be found in the project STATUS[http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/STATUS?view=markup] file. - ### Code When contributing code, it helps <strong>immensely</strong> if you follow through with the things on this checklist, especially the coding conventions. Keeping our code style consistent, our codebase stays easy to read and easy to patch. Adding javadoc (and examples therein) simplifies the documentation process and reduces confusion about the purpose of various methods and classes. Tests make sure that things work as expected, especially as development continues down the road. Of cours [...] **Checklist for Code Contributions**: -+ [Velocity coding conventions](http://wiki.apache.org/velocity/CodeStandards) ++ [Velocity coding conventions](https://wiki.apache.org/velocity/CodeStandards) + Javadoc included (the more detailed the better) + Examples included (in JavaDoc or as stand-alone template example) + Tests included (not required but <b>GREATLY</b> appreciated) diff --git a/src/content/tools/devel/view.mdtext b/src/content/tools/devel/view.mdtext index 186fd85..df38897 100644 --- a/src/content/tools/devel/view.mdtext +++ b/src/content/tools/devel/view.mdtext @@ -27,7 +27,7 @@ Otherwise, see the [download page](/download.html#tools) for how to get the Velo ## Default Configuration -The default configuration provided for VelocityView is [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/resources/org/apache/velocity/tools/generic/tools.xml?view=markup") and [here](http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/resources/org/apache/velocity/tools/view/tools.xml?view=markup). +The default configuration provided for VelocityView is [here](https://github.com/apache/velocity-tools/blob/master/velocity-tools-view/src/main/resources/org/apache/velocity/tools/view/tools.xml). ## Dependencies diff --git a/src/content/tools/index.mdtext b/src/content/tools/index.mdtext index 698d76c..d460392 100644 --- a/src/content/tools/index.mdtext +++ b/src/content/tools/index.mdtext @@ -4,13 +4,14 @@ Velocity Tools is a set of tools that ease Velocity integration in standard and ## Getting Started -The Velocity Tools subproject contains the documentation to get started using the Velocity Tools. Please select [the last released version](3.0) to get started. Once you are more familiar with the Tools or if you need a feature not yet released, you can check out the [Development Site](devel). +The Velocity Tools subproject contains the documentation to get started using the Velocity Tools. Please select [the last released version](3.1) to get started. Once you are more familiar with the Tools or if you need a feature not yet released, you can check out the [Development Site](devel). -+ [Tools 3.0](3.0) pages. ++ [Tools 3.1](3.1) pages. + [Tools Development Version](devel/) pages. ## Older Releases ++ [Tools 3.0 Release](3.0) + [Tools 2.0 Release](2.0) + [Tools 1.4 Release](1.4) + [Tools 1.3 Release](1.3)