velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cbris...@apache.org
Subject svn commit: r1871672 - in /velocity/site/cms/trunk/content/engine: 2.2/configuration.mdtext 2.2/dependencies.mdtext 2.2/developer-guide.mdtext devel/configuration.mdtext devel/dependencies.mdtext devel/developer-guide.mdtext
Date Mon, 16 Dec 2019 18:03:56 GMT
Author: cbrisson
Date: Mon Dec 16 18:03:56 2019
New Revision: 1871672

URL: http://svn.apache.org/viewvc?rev=1871672&view=rev
Log:
[site/engine] Fix links and typos

Modified:
    velocity/site/cms/trunk/content/engine/2.2/configuration.mdtext
    velocity/site/cms/trunk/content/engine/2.2/dependencies.mdtext
    velocity/site/cms/trunk/content/engine/2.2/developer-guide.mdtext
    velocity/site/cms/trunk/content/engine/devel/configuration.mdtext
    velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext
    velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext

Modified: velocity/site/cms/trunk/content/engine/2.2/configuration.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.2/configuration.mdtext?rev=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.2/configuration.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.2/configuration.mdtext Mon Dec 16 18:03:56 2019
@@ -178,11 +178,11 @@ Be aware that it can have a (probably ve
 > Default character encoding for input (templates). UTF-8 if not specified.
 
 **`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.
+> Living Java instance, that must implement the `org.apache.velocity.runtime.resource.ResourceManager`
interface. 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`**
 
-> Replace the Velocity default Resource Manager class. A resource manager implementation
must implement the (`org.apache.velocity.runtime.resource.ResourceManager`)[apidocs/org/apache/velocity/runtime/resource/ResourceManager.html]
interface. A description of the requirements of a resource manager is out of scope for this
document. Implementors are encouraged to review the default implementation.
+> Replace the Velocity default Resource Manager class. A resource manager implementation
must implement the [`org.apache.velocity.runtime.resource.ResourceManager`](apidocs/org/apache/velocity/runtime/resource/ResourceManager.html)
interface. A description of the requirements of a resource manager is out of scope for this
document. Implementors are encouraged to review the default implementation.
 
 The following resource management configuration keys only apply to the default Resource Manager.
 
@@ -192,7 +192,7 @@ The following resource management config
 
 **`resource.manager.cache.class = org.apache.velocity.runtime.resource.ResourceCacheImpl`**
 
-> Replace the Velocity default Resource Cache class. A resource cache implementation must
implement the (`org.apache.velocity.runtime.resource.ResourceCache`)[apidocs/org/apache/velocity/runtime/resource/ResourceCache.html]
interface As with the resource manager. A description of the requirements of a resource manager
is out of scope for this document.  Implementors are encouraged to review the default implementation.
+> Replace the Velocity default Resource Cache class. A resource cache implementation must
implement the [`org.apache.velocity.runtime.resource.ResourceCache`](apidocs/org/apache/velocity/runtime/resource/ResourceCache.html)
interface As with the resource manager. A description of the requirements of a resource manager
is out of scope for this document.  Implementors are encouraged to review the default implementation.
 
 **`resource.manager.cache.default_size = 89`**
 
@@ -393,7 +393,7 @@ Introspection is the process of mapping
 ## String Interning
 
 **`runtime.string_interning = true`**
-> This property specifies whether to use Java (String interning)[https://en.wikipedia.org/wiki/String_interning]
on identifiers. This may save some memory when set to true, and run a little bit faster when
set to false.
+> This property specifies whether to use Java [String interning](https://en.wikipedia.org/wiki/String_interning)
on identifiers. This may save some memory when set to true, and run a little bit faster when
set to false.
 
 ## Space Gobbling
 

Modified: velocity/site/cms/trunk/content/engine/2.2/dependencies.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.2/dependencies.mdtext?rev=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.2/dependencies.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.2/dependencies.mdtext Mon Dec 16 18:03:56 2019
@@ -10,12 +10,12 @@ The following table lists all needed jar
 
 Jar name | Version | Compilation | Tests | Runtime | Comment
 ---------|---------|---------|-------|-------------|--------
-slf4j-api | 1.7.26 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime
+slf4j-api | 1.7.28 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime
 commons-lang | 3.8.1 | Yes | Yes | Yes |
 junit | 4.12 | No | Yes | No |
-hsqldb | 2.3.4 | No | Yes | No |
+hsqldb | 2.5.0 | No | Yes | No |
 commons-io | 2.6 | No | Yes | No |
-slf4j-simple | 1.7.26 | No | Yes | No | Your application will need *one* SLF4J binding, see
below
+slf4j-simple | 1.7.28 | No | Yes | No | Your application will need *one* SLF4J binding, see
below
 
 Here is a list of slf4j bindings:
 

Modified: velocity/site/cms/trunk/content/engine/2.2/developer-guide.mdtext
URL: http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.2/developer-guide.mdtext?rev=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.2/developer-guide.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.2/developer-guide.mdtext Mon Dec 16 18:03:56
2019
@@ -216,7 +216,8 @@ That's really all there is to basic cont
 
 ### Support for Iterative Objects for #foreach()
 
-As a programmer, you have great freedom in the objects that you put into the context.  But
as with most freedoms, this one comes with a little bit of responsibility, so understand what
Velocity supports, and any issues that may arise.  Velocity supports serveral types of collection
types  suitable for use in the VTL `#foreach()` directive.
+As a programmer, you have great freedom in the objects that you put into the context.  But
as with most freedoms, this one comes with a little bit of responsibility, so understand what
Velocity supports, and any issues that may arise. Velocity supports serveral types of collection
types suitable for use in the VTL `#foreach()` directive:
+
 + `Object []`  Regular object array, not much needs to be said here. Velocity will internally
wrap your array in a class that provides an Iterator interface,  but that shouldn't concern
you as the programmer, or the template author.  Of more interest, is the fact that Velocity
will now allow template authors to treat arrays as fixed-length lists. This means they may
call methods like `size()`, `isEmpty()` and `get(int)` as well as the `empty` property on
both arrays and standard java.util.List instances without concerning themselves about the
difference.
 + `java.util.Collection`  Velocity will use the `iterator()` method to get an Iterator to
use in the loop, so if you are implementing a Collection interface on your object, please
ensure that `iterator()` returns a working  Iterator.
 + `java.util.Map ` Here, Velocity depends upon the `values()` method of the interface to
get a `Collection` interface, on which `iterator()` is called to retrieve an Iterator for
the loop.
@@ -844,7 +845,7 @@ There are currently four kinds of resour
 
 The [VelocityTools](/tools/devel/) project also defines a [WebappResourceLoader](/tools/devel/apidocs/org/apache/velocity/tools/view/WebappResourceLoader.html),
active by default, which maps '/' to the root of the webapp.
 
-Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource
Manager is the main part of the resource (template and static content) management system,
and is responsible for taking application requests for templates, finding them in the available
resource loaders, and then optionally caching the parsed template. The Resource Cache is the
mechanism that the Resource Manager uses to cache templates for quick reuse. While the default
versions of these two facilities are suitable for most applications, it is possible to replace
the default resource manager and resource cache with custom implementations. See the (related
configuration options)[configuration.html#resource-management].
+Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource
Manager is the main part of the resource (template and static content) management system,
and is responsible for taking application requests for templates, finding them in the available
resource loaders, and then optionally caching the parsed template. The Resource Cache is the
mechanism that the Resource Manager uses to cache templates for quick reuse. While the default
versions of these two facilities are suitable for most applications, it is possible to replace
the default resource manager and resource cache with custom implementations. See the [related
configuration options](configuration.html#resource-management).
 
 ## Application Attributes
 
@@ -1031,9 +1032,9 @@ The following code shows how to register
 
 ## Customizing Introspection
 
-The [`runtime.introspector.uberspect` configuration property](configuration.html#Pluggable-Introspection]
property takes a list of Uberspector class names that constitute the Velocity introspection
chain. By means it, you can change the way context objects are introspected at runtime to
map VTL properties and methods to Java calls.
+The [`runtime.introspector.uberspect` configuration property](configuration.html#Pluggable-Introspection)
property takes a list of Uberspector class names that constitute the Velocity introspection
chain. By means it, you can change the way context objects are introspected at runtime to
map VTL properties and methods to Java calls.
 
-Here is the list of provided uberspectors (which are found in the (org.apache.velocity.util.introspection)[apidocs/org/apache/velocity/util/introspection/package-summary.html]
package).
+Here is the list of provided uberspectors (which are found in the [`org.apache.velocity.util.introspection`](apidocs/org/apache/velocity/util/introspection/package-summary.html)
package).
 
 ### Standard Uberspectors
 
@@ -1619,7 +1620,7 @@ Hello World example:
 
 ## Customizing the VTL parser
 
-Since 2.2, a 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.2/velocity-custom-parser-example-2.2.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 doing, but
basically it boils down to do merge the content of the `<properties>`, `<dependencies>`
and `<build>` sections in your target pom file.
+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.2/velocity-custom-parser-example-2.2.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 doing, but
basically it boils down to do merge the content of the `<properties>`, `<dependencies>`
and `<build>` sections in your target pom file.
 
 This custom parser will let you configure the following VTL characters:
 

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=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/configuration.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/configuration.mdtext Mon Dec 16 18:03:56
2019
@@ -178,11 +178,11 @@ Be aware that it can have a (probably ve
 > Default character encoding for input (templates). UTF-8 if not specified.
 
 **`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.
+> Living Java instance, that must implement the `org.apache.velocity.runtime.resource.ResourceManager`
interface. 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`**
 
-> Replace the Velocity default Resource Manager class. A resource manager implementation
must implement the (`org.apache.velocity.runtime.resource.ResourceManager`)[apidocs/org/apache/velocity/runtime/resource/ResourceManager.html]
interface. A description of the requirements of a resource manager is out of scope for this
document. Implementors are encouraged to review the default implementation.
+> Replace the Velocity default Resource Manager class. A resource manager implementation
must implement the [`org.apache.velocity.runtime.resource.ResourceManager`](apidocs/org/apache/velocity/runtime/resource/ResourceManager.html)
interface. A description of the requirements of a resource manager is out of scope for this
document. Implementors are encouraged to review the default implementation.
 
 The following resource management configuration keys only apply to the default Resource Manager.
 
@@ -192,7 +192,7 @@ The following resource management config
 
 **`resource.manager.cache.class = org.apache.velocity.runtime.resource.ResourceCacheImpl`**
 
-> Replace the Velocity default Resource Cache class. A resource cache implementation must
implement the (`org.apache.velocity.runtime.resource.ResourceCache`)[apidocs/org/apache/velocity/runtime/resource/ResourceCache.html]
interface As with the resource manager. A description of the requirements of a resource manager
is out of scope for this document.  Implementors are encouraged to review the default implementation.
+> Replace the Velocity default Resource Cache class. A resource cache implementation must
implement the [`org.apache.velocity.runtime.resource.ResourceCache`](apidocs/org/apache/velocity/runtime/resource/ResourceCache.html)
interface As with the resource manager. A description of the requirements of a resource manager
is out of scope for this document.  Implementors are encouraged to review the default implementation.
 
 **`resource.manager.cache.default_size = 89`**
 
@@ -393,7 +393,7 @@ Introspection is the process of mapping
 ## String Interning
 
 **`runtime.string_interning = true`**
-> This property specifies whether to use Java (String interning)[https://en.wikipedia.org/wiki/String_interning]
on identifiers. This may save some memory when set to true, and run a little bit faster when
set to false.
+> This property specifies whether to use Java [String interning](https://en.wikipedia.org/wiki/String_interning)
on identifiers. This may save some memory when set to true, and run a little bit faster when
set to false.
 
 ## Space Gobbling
 

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=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/dependencies.mdtext Mon Dec 16 18:03:56 2019
@@ -10,12 +10,12 @@ The following table lists all needed jar
 
 Jar name | Version | Compilation | Tests | Runtime | Comment
 ---------|---------|---------|-------|-------------|--------
-slf4j-api | 1.7.26 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime
+slf4j-api | 1.7.28 | Yes | Yes | Yes | you'll also need an slf4j binding at runtime
 commons-lang | 3.8.1 | Yes | Yes | Yes |
 junit | 4.12 | No | Yes | No |
-hsqldb | 2.3.4 | No | Yes | No |
+hsqldb | 2.5.0 | No | Yes | No |
 commons-io | 2.6 | No | Yes | No |
-slf4j-simple | 1.7.26 | No | Yes | No | Your application will need *one* SLF4J binding, see
below
+slf4j-simple | 1.7.28 | No | Yes | No | Your application will need *one* SLF4J binding, see
below
 
 Here is a list of slf4j bindings:
 

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=1871672&r1=1871671&r2=1871672&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext Mon Dec 16 18:03:56
2019
@@ -216,7 +216,8 @@ That's really all there is to basic cont
 
 ### Support for Iterative Objects for #foreach()
 
-As a programmer, you have great freedom in the objects that you put into the context.  But
as with most freedoms, this one comes with a little bit of responsibility, so understand what
Velocity supports, and any issues that may arise.  Velocity supports serveral types of collection
types  suitable for use in the VTL `#foreach()` directive.
+As a programmer, you have great freedom in the objects that you put into the context.  But
as with most freedoms, this one comes with a little bit of responsibility, so understand what
Velocity supports, and any issues that may arise. Velocity supports serveral types of collection
types suitable for use in the VTL `#foreach()` directive:
+
 + `Object []`  Regular object array, not much needs to be said here. Velocity will internally
wrap your array in a class that provides an Iterator interface,  but that shouldn't concern
you as the programmer, or the template author.  Of more interest, is the fact that Velocity
will now allow template authors to treat arrays as fixed-length lists. This means they may
call methods like `size()`, `isEmpty()` and `get(int)` as well as the `empty` property on
both arrays and standard java.util.List instances without concerning themselves about the
difference.
 + `java.util.Collection`  Velocity will use the `iterator()` method to get an Iterator to
use in the loop, so if you are implementing a Collection interface on your object, please
ensure that `iterator()` returns a working  Iterator.
 + `java.util.Map ` Here, Velocity depends upon the `values()` method of the interface to
get a `Collection` interface, on which `iterator()` is called to retrieve an Iterator for
the loop.
@@ -844,7 +845,7 @@ There are currently four kinds of resour
 
 The [VelocityTools](/tools/devel/) project also defines a [WebappResourceLoader](/tools/devel/apidocs/org/apache/velocity/tools/view/WebappResourceLoader.html),
active by default, which maps '/' to the root of the webapp.
 
-Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource
Manager is the main part of the resource (template and static content) management system,
and is responsible for taking application requests for templates, finding them in the available
resource loaders, and then optionally caching the parsed template. The Resource Cache is the
mechanism that the Resource Manager uses to cache templates for quick reuse. While the default
versions of these two facilities are suitable for most applications, it is possible to replace
the default resource manager and resource cache with custom implementations. See the (related
configuration options)[configuration.html#resource-management].
+Advanced users may also want to replace the Resource Manager or the Resource Cache: the Resource
Manager is the main part of the resource (template and static content) management system,
and is responsible for taking application requests for templates, finding them in the available
resource loaders, and then optionally caching the parsed template. The Resource Cache is the
mechanism that the Resource Manager uses to cache templates for quick reuse. While the default
versions of these two facilities are suitable for most applications, it is possible to replace
the default resource manager and resource cache with custom implementations. See the [related
configuration options](configuration.html#resource-management).
 
 ## Application Attributes
 
@@ -1031,9 +1032,9 @@ The following code shows how to register
 
 ## Customizing Introspection
 
-The [`runtime.introspector.uberspect` configuration property](configuration.html#Pluggable-Introspection]
property takes a list of Uberspector class names that constitute the Velocity introspection
chain. By means it, you can change the way context objects are introspected at runtime to
map VTL properties and methods to Java calls.
+The [`runtime.introspector.uberspect` configuration property](configuration.html#Pluggable-Introspection)
property takes a list of Uberspector class names that constitute the Velocity introspection
chain. By means it, you can change the way context objects are introspected at runtime to
map VTL properties and methods to Java calls.
 
-Here is the list of provided uberspectors (which are found in the (org.apache.velocity.util.introspection)[apidocs/org/apache/velocity/util/introspection/package-summary.html]
package).
+Here is the list of provided uberspectors (which are found in the [`org.apache.velocity.util.introspection`](apidocs/org/apache/velocity/util/introspection/package-summary.html)
package).
 
 ### Standard Uberspectors
 
@@ -1619,7 +1620,7 @@ Hello World example:
 
 ## Customizing the VTL parser
 
-Since 2.2, a 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. There's a minimal maven knowledge required to understand what you are doing, but
basically it boils down to do merge the content of the `<properties>`, `<dependencies>`
and `<build>` sections in your target pom file.
+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. There's a minimal maven knowledge required to understand what you are doing, but
basically it boils down to do merge the content of the `<properties>`, `<dependencies>`
and `<build>` sections in your target pom file.
 
 This custom parser will let you configure the following VTL characters:
 



Mime
View raw message