Author: cbrisson Date: Fri Dec 9 23:42:54 2016 New Revision: 1773489 URL: http://svn.apache.org/viewvc?rev=1773489&view=rev Log: [site] update engine dependencies and upgrading pages
Modified: velocity/site/cms/trunk/content/engine/2.0/dependencies.mdtext velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext Modified: velocity/site/cms/trunk/content/engine/2.0/dependencies.mdtext URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.0/dependencies.mdtext?rev=1773489&r1=1773488&r2=1773489&view=diff ============================================================================== --- velocity/site/cms/trunk/content/engine/2.0/dependencies.mdtext (original) +++ velocity/site/cms/trunk/content/engine/2.0/dependencies.mdtext Fri Dec 9 23:42:54 2016 @@ -2,21 +2,20 @@ Title: Apache Velocity Engine Dependenci ## Velocity Dependencies -When building from sources, Maven should fetch all needed dependencies. At runtime, velocity only needs slf4j-api, and one of the slf4j bindings (needed classes from commons-lang and commons-collections are incorporated using ["shading"](https://maven.apache.org/plugins/maven-shade-plugin/)). +When building from sources, Maven should fetch all needed dependencies. At runtime, velocity only needs commons-lang, slf4j-api, and one of the slf4j bindings. The following table lists all needed jars. Jar name | Version | Compilation | Tests | Runtime | Comment ---------|---------|---------|-------|-------------|-------- slf4j-api | 1.7.21 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime -commons-collections | 3.2.2 | Yes | No | No | -commons-lang | 3.5 | Yes | No | No | +commons-lang | 3.5 | Yes | Yes | Yes | junit | 4.12 | No | Yes | No | hsqldb | 2.3.4 | No | Yes | No | commons-io | 2.5 | No | Yes | No | slf4j-simple | 1.7.21 | No | Yes | No | Your application will need *one* SLF4J binding, see below -At runtime, Velocity Engine only requires the SLF4J API jar, and will require an SLF4J binding to be present in the path. Typically, one of: +Here is a list of slf4j bindings: + [AVSL](http://software.clapper.org/avsl/) - âA Very Simple Loggerâ + [SLF4J JDK14 Adapter](http://www.slf4j.org/api/org/slf4j/impl/JDK14LoggerAdapter.html) - redirect logs towards Java 1.4+ logging framework Modified: velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext?rev=1773489&r1=1773488&r2=1773489&view=diff ============================================================================== --- velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext (original) +++ velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext Fri Dec 9 23:42:54 2016 @@ -24,10 +24,10 @@ Read below for futher details. + the reference could be successfully evaluated but resulted in a null value + the reference is tested for validity inside an #if / #elseif statement The 1.x behavior did send invalid reference events in all those cases. -+ The `ResourceLoader` class has been deprecated in favor of a `ResourceLoader2` class, in which the `InputStream ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader ResourceLoader.getResourceReader(String name, String encoding)`. Since `ResourceLoader` inherits from `ResourceLoader2`, the change remains backward compatible, but custom resource loaders should be upgraded to avoid deprecation warnings. ++ The `ResourceLoader` class API has replaced InputStream getters by Reader getters: `InputStream ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader ResourceLoader.getResourceReader(String name, String encoding)`. + the default encoding ('ISO-8859-1' in 1.x) is now UTF-8. + the MethodException event handler now receives an additional argument providing template name and location infos. -+ all occurences of the class org.apache.commons.collections.ExtendedProperties in the initialization API have been replaced by org.apache.velocity.util.ExtProperties. ++ Initialization methods in Velocity and VelocityEngine taking an ExtendedProperties have been removed (but `setProperties(Properties)` methods are still here). All occurences of the org.apache.commons.collections.ExtendedProperties class in the runtime internal initialization API have been replaced by org.apache.velocity.util.ExtProperties. + the macros are now using a 'call by sharing' convention (which means that all arguments are evaluated once at start, and that the macro receives a copy of the reference to each argument). + the `UberspectLoggable` interface has been removed. @@ -41,9 +41,10 @@ Read below for futher details. ### Dependencies changes: + Velocity now requires a JDK version of 1.7 or higher. -+ commons-lang, commons-collections and commons-logging aren't needed any more at runtime. -+ there's a new runtime dependency, slf4j-api 1.7.12 -+ you'll need an [SLF4J binding](dependencies.html) ++ commons-collections and commons-logging aren't needed any more at runtime. ++ there's a new runtime dependency, slf4j-api 1.7.12. ++ you'll need an [SLF4J binding](dependencies.html). ++ commons-lang has to be upgraded to 3.5. ## Upgrading from Velocity 1.6.x to Velocity 1.7.x Modified: velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext?rev=1773489&r1=1773488&r2=1773489&view=diff ============================================================================== --- velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext (original) +++ velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext Fri Dec 9 23:42:54 2016 @@ -2,21 +2,20 @@ Title: Apache Velocity Engine Dependenci ## Velocity Dependencies -When building from sources, Maven should fetch all needed dependencies. At runtime, velocity only needs slf4j-api, and one of the slf4j bindings (needed classes from commons-lang and commons-collections are incorporated using ["shading"](https://maven.apache.org/plugins/maven-shade-plugin/)). +When building from sources, Maven should fetch all needed dependencies. At runtime, velocity only needs commons-lang, slf4j-api, and one of the slf4j bindings. The following table lists all needed jars. Jar name | Version | Compilation | Tests | Runtime | Comment ---------|---------|---------|-------|-------------|-------- slf4j-api | 1.7.21 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime -commons-collections | 3.2.2 | Yes | No | No | -commons-lang | 3.5 | Yes | No | No | +commons-lang | 3.5 | Yes | Yes | Yes | junit | 4.12 | No | Yes | No | hsqldb | 2.3.4 | No | Yes | No | commons-io | 2.5 | No | Yes | No | slf4j-simple | 1.7.21 | No | Yes | No | Your application will need *one* SLF4J binding, see below -At runtime, Velocity Engine only requires the SLF4J API jar, and will require an SLF4J binding to be present in the path. Typically, one of: +Here is a list of slf4j bindings: + [AVSL](http://software.clapper.org/avsl/) - âA Very Simple Loggerâ + [SLF4J JDK14 Adapter](http://www.slf4j.org/api/org/slf4j/impl/JDK14LoggerAdapter.html) - redirect logs towards Java 1.4+ logging framework @@ -26,4 +25,3 @@ At runtime, Velocity Engine only require + [LogBack](http://logback.qos.ch/) - full featured logging framework + [WebApp SLF4J Logger](https://github.com/arkanovicz/webapp-slf4j-logger) - redirects logs towards the J2EE container log - Modified: velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext?rev=1773489&r1=1773488&r2=1773489&view=diff ============================================================================== --- velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext (original) +++ velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext Fri Dec 9 23:42:54 2016 @@ -24,10 +24,10 @@ Read below for futher details. + the reference could be successfully evaluated but resulted in a null value + the reference is tested for validity inside an #if / #elseif statement The 1.x behavior did send invalid reference events in all those cases. -+ The `ResourceLoader` class has been deprecated in favor of a `ResourceLoader2` class, in which the `InputStream ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader ResourceLoader.getResourceReader(String name, String encoding)`. Since `ResourceLoader` inherits from `ResourceLoader2`, the change remains backward compatible, but custom resource loaders should be upgraded to avoid deprecation warnings. ++ The `ResourceLoader` class API has replaced InputStream getters by Reader getters: `InputStream ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader ResourceLoader.getResourceReader(String name, String encoding)`. + the default encoding ('ISO-8859-1' in 1.x) is now UTF-8. + the MethodException event handler now receives an additional argument providing template name and location infos. -+ all occurences of the class org.apache.commons.collections.ExtendedProperties in the initialization API have been replaced by org.apache.velocity.util.ExtProperties. ++ Initialization methods in Velocity and VelocityEngine taking an ExtendedProperties have been removed (but `setProperties(Properties)` methods are still here). All occurences of the org.apache.commons.collections.ExtendedProperties class in the runtime internal initialization API have been replaced by org.apache.velocity.util.ExtProperties. + the macros are now using a 'call by sharing' convention (which means that all arguments are evaluated once at start, and that the macro receives a copy of the reference to each argument). + the `UberspectLoggable` interface has been removed. @@ -41,9 +41,10 @@ Read below for futher details. ### Dependencies changes: + Velocity now requires a JDK version of 1.7 or higher. -+ commons-lang, commons-collections and commons-logging aren't needed any more at runtime. -+ there's a new runtime dependency, slf4j-api 1.7.12 -+ you'll need an [SLF4J binding](dependencies.html) ++ commons-collections and commons-logging aren't needed any more at runtime. ++ there's a new runtime dependency, slf4j-api 1.7.12. ++ you'll need an [SLF4J binding](dependencies.html). ++ commons-lang has to be upgraded to 3.5. ## Upgrading from Velocity 1.6.x to Velocity 1.7.x