You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by cb...@apache.org on 2017/07/18 08:52:39 UTC
svn commit: r1802254 - in /velocity/site/cms/trunk/content/engine:
2.0/configuration.mdtext 2.0/developer-guide.mdtext 2.0/upgrading.mdtext
devel/configuration.mdtext devel/developer-guide.mdtext
devel/upgrading.mdtext
Author: cbrisson
Date: Tue Jul 18 08:52:39 2017
New Revision: 1802254
URL: http://svn.apache.org/viewvc?rev=1802254&view=rev
Log:
[site/engine] A few formatting and spelling fixes
Modified:
velocity/site/cms/trunk/content/engine/2.0/configuration.mdtext
velocity/site/cms/trunk/content/engine/2.0/developer-guide.mdtext
velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext
velocity/site/cms/trunk/content/engine/devel/configuration.mdtext
velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext
Modified: velocity/site/cms/trunk/content/engine/2.0/configuration.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.0/configuration.mdtext?rev=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.0/configuration.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.0/configuration.mdtext Tue Jul 18 08:52:39 2017
@@ -103,7 +103,7 @@ Below are listed the configuration keys
## Resource Management
-**`resource.manager.instance = null`
+**`resource.manager.instance = null`**
> Living Java instance, that must implement the interface org.apache.velocity.runtime.resource.ResourceManager. This property can only be set programmatically, and takes precedence over the next property. It is otherwise used by Velocity to store its actual resource manager once instanciated.
**`resource.manager.class = org.apache.velocity.runtime.resource.ResourceManagerImpl`**
Modified: velocity/site/cms/trunk/content/engine/2.0/developer-guide.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.0/developer-guide.mdtext?rev=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.0/developer-guide.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.0/developer-guide.mdtext Tue Jul 18 08:52:39 2017
@@ -806,9 +806,9 @@ There are currently four kinds of resour
+ **FileResourceLoader :** This loader gets resources from the filesystem. Its configuration properties include:
- + `file.resource.loader.path` = <path to root of templates>
+ + `file.resource.loader.path` = <path to root of templates> [ , <path to root of templates> ... ]
+ `file.resource.loader.cache` = true/false
- + `file.resource.loader.modificationCheckInterval` = <seconds between checks>
+ + `file.resource.loader.modificationCheckInterval` = <seconds between checks>
This is the default loader (except when using VelocityTools, see below), and is configured, by default to get templates from the 'current directory'. In the case of using Velocity with servlets, this can be a problem as you don't want to have to keep your templates in the directory from which you start your servlet engine. See the documentation for your servlet or web framework (for example [VelocityViewServlet](/tools/devel/view-servlet.html)) for more info on how to configure the location of the Velocity templates.
@@ -817,10 +817,10 @@ There are currently four kinds of resour
+ **ClasspathResourceLoader :** This loader gets resources from the classloader. In general, this means that the ClasspathResourceLoader will load templates placed in the classpath (in jars, for example) While the classpath is a source of great pain and suffering in general, it is a very useful mechanism when working on a Servlet Spec 2.2 (or newer) compliant servlet runner. <a href="http://jakarta.apache.org/tomcat/" class="externalLink">Tomcat</a> is an example of such. To use this loader effectively, all you must do is jar your templates, and put that jar into the WEB-INF/lib directory of your webapp. There are no configuration options to worry about, nor is the absolute vs. relative path an issue, as it is with Jar and File resource loaders. Again, please note that the ClasspathResourceLoader is not only for use with a servlet container, but can be used in any application context.
+ **URLResourceLoader :** This loader gets resources from a URL connection. Its configuration properties include:
-
- + `url.resource.loader.root` = <root URL path of templates>
+
+ + `url.resource.loader.root` = <root URL path of templates> [ , <root URL path of templates> ... ]
+ `url.resource.loader.cache` = true/false
- + `url.resource.loader.modificationCheckInterval` = <seconds between checks>
+ + `url.resource.loader.modificationCheckInterval` = <seconds between checks>
This loader simply downloads resources from configured URLs. It works much like the FileResourceLoader, however, it can pull templates down from any valid URL to which the application can create a connection.
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=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext Tue Jul 18 08:52:39 2017
@@ -11,7 +11,7 @@ For busy people: To maximize backward co
runtime.conversion.handler = none
space.gobbling = bc
-and check the [Dependencies change](#dependencies-changes) below.
+and check the [Dependency changes](#dependencies-changes) below.
Read below for futher details.
@@ -39,7 +39,7 @@ Read below for futher details.
+ method arguments are now converted as needed between all main basic Java standard types (booleans, numbers and strings). If you want to revert to the 1.x behavior, set the property `runtime.conversion.handler = none`.
+ space gobbling (to control the indentation of generated code) is now configurable via the `space.gobbing` configuration key, which can take the following values: `none`, `bc` (aka. backward compatible), `lines` and `structured`. See the related documentation section for details. To maximize backward compatibility with 1.x, set it to `bc`.
-### Dependencies changes:
+### Dependency changes:
+ Velocity now requires a JDK version of 1.7 or higher.
+ commons-collections and commons-logging aren't needed any more at runtime.
Modified: velocity/site/cms/trunk/content/engine/devel/configuration.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/devel/configuration.mdtext?rev=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/configuration.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/configuration.mdtext Tue Jul 18 08:52:39 2017
@@ -103,7 +103,7 @@ Below are listed the configuration keys
## Resource Management
-**`resource.manager.instance = null`
+**`resource.manager.instance = null`**
> Living Java instance, that must implement the interface org.apache.velocity.runtime.resource.ResourceManager. This property can only be set programmatically, and takes precedence over the next property. It is otherwise used by Velocity to store its actual resource manager once instanciated.
**`resource.manager.class = org.apache.velocity.runtime.resource.ResourceManagerImpl`**
Modified: velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext?rev=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext Tue Jul 18 08:52:39 2017
@@ -806,9 +806,9 @@ There are currently four kinds of resour
+ **FileResourceLoader :** This loader gets resources from the filesystem. Its configuration properties include:
- + `file.resource.loader.path` = <path to root of templates>
+ + `file.resource.loader.path` = <path to root of templates> [ , <path to root of templates> ... ]
+ `file.resource.loader.cache` = true/false
- + `file.resource.loader.modificationCheckInterval` = <seconds between checks>
+ + `file.resource.loader.modificationCheckInterval` = <seconds between checks>
This is the default loader (except when using VelocityTools, see below), and is configured, by default to get templates from the 'current directory'. In the case of using Velocity with servlets, this can be a problem as you don't want to have to keep your templates in the directory from which you start your servlet engine. See the documentation for your servlet or web framework (for example [VelocityViewServlet](/tools/devel/view-servlet.html)) for more info on how to configure the location of the Velocity templates.
@@ -817,10 +817,10 @@ There are currently four kinds of resour
+ **ClasspathResourceLoader :** This loader gets resources from the classloader. In general, this means that the ClasspathResourceLoader will load templates placed in the classpath (in jars, for example) While the classpath is a source of great pain and suffering in general, it is a very useful mechanism when working on a Servlet Spec 2.2 (or newer) compliant servlet runner. <a href="http://jakarta.apache.org/tomcat/" class="externalLink">Tomcat</a> is an example of such. To use this loader effectively, all you must do is jar your templates, and put that jar into the WEB-INF/lib directory of your webapp. There are no configuration options to worry about, nor is the absolute vs. relative path an issue, as it is with Jar and File resource loaders. Again, please note that the ClasspathResourceLoader is not only for use with a servlet container, but can be used in any application context.
+ **URLResourceLoader :** This loader gets resources from a URL connection. Its configuration properties include:
-
- + `url.resource.loader.root` = <root URL path of templates>
+
+ + `url.resource.loader.root` = <root URL path of templates> [ , <root URL path of templates> ... ]
+ `url.resource.loader.cache` = true/false
- + `url.resource.loader.modificationCheckInterval` = <seconds between checks>
+ + `url.resource.loader.modificationCheckInterval` = <seconds between checks>
This loader simply downloads resources from configured URLs. It works much like the FileResourceLoader, however, it can pull templates down from any valid URL to which the application can create a connection.
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=1802254&r1=1802253&r2=1802254&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext Tue Jul 18 08:52:39 2017
@@ -11,7 +11,7 @@ For busy people: To maximize backward co
runtime.conversion.handler = none
space.gobbling = bc
-and check the [Dependencies change](#dependencies-changes) below.
+and check the [Dependency changes](#dependencies-changes) below.
Read below for futher details.
@@ -39,7 +39,7 @@ Read below for futher details.
+ method arguments are now converted as needed between all main basic Java standard types (booleans, numbers and strings). If you want to revert to the 1.x behavior, set the property `runtime.conversion.handler = none`.
+ space gobbling (to control the indentation of generated code) is now configurable via the `space.gobbing` configuration key, which can take the following values: `none`, `bc` (aka. backward compatible), `lines` and `structured`. See the related documentation section for details. To maximize backward compatibility with 1.x, set it to `bc`.
-### Dependencies changes:
+### Dependency changes:
+ Velocity now requires a JDK version of 1.7 or higher.
+ commons-collections and commons-logging aren't needed any more at runtime.