Author: cbrisson
Date: Mon Jul 18 21:47:38 2016
New Revision: 1753320
URL: http://svn.apache.org/viewvc?rev=1753320&view=rev
Log:
[site] updated configuration documentation with new property
context.autoreference.key
Modified:
velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
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=1753320&r1=1753319&r2=1753320&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
(original)
+++ velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext Mon Jul
18 21:47:38 2016
@@ -803,7 +803,7 @@ Below are listed the configuration keys
> This is the number of seconds between modification checks when caching is
> turned on. When this is an integer > 0, this represents the number of
> seconds between checks to see if the template was modified. If the template
> has been modified since last check, then it is reloaded and reparsed.
> Otherwise nothing is done. When <= 0, no modification checks will take
> place, and assuming that the property `cache` (above) is true, once a
> template is loaded and parsed the first time it is used, it will not be
> checked or reloaded after that until the application or servlet engine is
> restarted.
-To illustrate, here is an example taken right from the default Velocity
properties, showing how setting up the FileResourceLoader is managed
+> To illustrate, here is an example taken right from the default Velocity
properties, showing how setting up the FileResourceLoader is managed
resource.loader = file
@@ -891,9 +891,15 @@ To illustrate, here is an example taken
`runtime.introspector.uberspect =
org.apache.velocity.util.introspection.UberspectImpl`
-This property sets the 'Uberspector', the introspection package that handles
all introspection strategies for Velocity. You can specify a comma-separated
list of Uberspector classes, in which case all Uberspectors are chained. The
default chaining behaviour is to return the first non-null value for each
introspection call among all provided uberspectors. You can modify this
behaviour (for instance to restrict access to some methods) by subclassing
org.apache.velocity.util.introspection.AbstractChainableUberspector (or
implementing directly
org.apache.velocity.util.introspection.ChainableUberspector). This allows you
to create more interesting rules or patterns for Uberspection, rather than just
returning the first non-null value.
+> This property sets the 'Uberspector', the introspection package that handles
all introspection strategies for Velocity. You can specify a comma-separated
list of Uberspector classes, in which case all Uberspectors are chained. The
default chaining behaviour is to return the first non-null value for each
introspection call among all provided uberspectors. You can modify this
behaviour (for instance to restrict access to some methods) by subclassing
org.apache.velocity.util.introspection.AbstractChainableUberspector (or
implementing directly
org.apache.velocity.util.introspection.ChainableUberspector). This allows you
to create more interesting rules or patterns for Uberspection, rather than just
returning the first non-null value.
+>
+> Some alternate Uberspectors are provided. You would for instance use
`runtime.introspector.uberspect =
org.apache.velocity.util.introspection.SecureUberspector` to avoid template
authors to instanciate new classes or to use reflection, or use
`runtime.introspector.uberspect =
org.apache.velocity.util.introspection.UberspectImpl,
org.apache.velocity.util.introspection.UberspectPublicFields` to expose Java
public fields in your templates.
+
+### Context
+
+`context.autoreference.key = *name*`
-Some alternate Uberspectors are provided. You would for instance use
`runtime.introspector.uberspect =
org.apache.velocity.util.introspection.SecureUberspector` to avoid template
authors to instanciate new classes or to use reflection, or use
`runtime.introspector.uberspect =
org.apache.velocity.util.introspection.UberspectImpl,
org.apache.velocity.util.introspection.UberspectPublicFields` to expose Java
public fields in your templates.
+> This property has no default value. If present, the Context object will
become accessible from the templates under the provided name. For instance,
with the configuration `context.autoreference.key = self`, `$self` will contain
the context itself. This feature is meant to be used for debugging purposes.
## Configuring Logging
