Author: cbrisson
Date: Sat Sep 10 16:12:40 2016
New Revision: 1760191
URL: http://svn.apache.org/viewvc?rev=1760191&view=rev
Log:
docfix for VELOCITY-780
Modified:
velocity/site/cms/trunk/content/engine/devel/configuration.mdtext
velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
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=1760191&r1=1760190&r2=1760191&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/configuration.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/configuration.mdtext Sat Sep
10 16:12:40 2016
@@ -115,13 +115,15 @@ The following resource management config
> *Multi-valued key. Will accept CSV for value.* Public name of a resource
> loader to be used. This public name will then be used in the specification
> of the specific properties for that resource loader. Note that as a
> multi-valued key, it's possible to pass a value like "file, string" (sans
> quotes), indicating that following will be configuration values for two
> loaders.
+> Please note than [VelocityTools](tools/devel) will override the default
value and set it to `webapp`.
+
** *name*`.loader.description = Velocity File Resource Loader`**
> Description string for the given loader.
** *name*`.resource.loader.class =
org.apache.velocity.runtime.resource.loader.FileResourceLoader`**
-> Name of implementation class for the loader. The default loader is the file
loader.
+> Name of implementation class for the loader. The default loader is the [file
resource
loader](/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/FileResourceLoader.html)
(or the [webapp resource
loader](/tools/devel/apidocs/org/apache/velocity/tools/view/WebappResourceLoader.html)
for VelocityTools).
** *name*`.resource.loader.path = .`**
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=1760191&r1=1760190&r2=1760191&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
(original)
+++ velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext Sat Sep
10 16:12:40 2016
@@ -798,7 +798,7 @@ There are currently four kinds of resour
+ `file.resource.loader.cache` = true/false
+ `file.resource.loader.modificationCheckInterval` = <seconds between
checks>
- This is the default loader, 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.
+ 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.
+ **JarResourceLoader :** This loader gets resource from specific jar files.
It is very similar to the FileResourceLoader, except that you have the
convenience of bundling your templates into jars. The properties are
identical, except for `jar.resource.loader.path`, where you provide the full
location of the jar(s) you wish to load resources from. To specify a jar for
the loader.path you use the standard JAR URL syntax of
`java.net.JarURLConnection`.
@@ -814,6 +814,8 @@ There are currently four kinds of resour
+ **DataSourceResourceLoader :** This loader will load resources from a
DataSource such as a database. This loader is only available under JDK 1.4 and
later. For more information on this loader, please see the javadoc for the
class `org.apache.velocity.runtime.resource.loader.DataSourceResourceLoader`.
+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].
## Application Attributes
