geirm 01/10/19 04:15:11
Modified: xdocs developer-guide.xml user-guide.xml
docs developer-guide.html user-guide.html
Log:
documented VM autoload feature.
Revision Changes Path
1.58 +12 -0 jakarta-velocity/xdocs/developer-guide.xml
Index: developer-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/developer-guide.xml,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -r1.57 -r1.58
--- developer-guide.xml 2001/09/26 11:45:00 1.57
+++ developer-guide.xml 2001/10/19 11:15:11 1.58
@@ -1902,6 +1902,18 @@
</p>
<p>
+<code>velocimacro.library.autoreload = false</code><br/>
+Controls Velocimacro library autoloading. When set to <code>true</code>
+the source Velocimacro library for an invoked Velocimacro will be checked
+for changes, and reloaded if necessary. This allows you to change and
+test Velocimacro libraries without having to restart your application or
+servlet container, just like you can with regular templates.
+This mode only works when caching is <i>off</i>
+in the resource loaders (e.g. <code>file.resource.loader.cache = false</code> ).
+This feature is intended for development, not for production.
+</p>
+
+<p>
<strong>String Interpolation</strong>
</p>
1.52 +41 -0 jakarta-velocity/xdocs/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/user-guide.xml,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -r1.51 -r1.52
--- user-guide.xml 2001/10/11 03:44:46 1.51
+++ user-guide.xml 2001/10/19 11:15:11 1.52
@@ -2006,6 +2006,47 @@
</p>
+<strong>What is Velocimacro Autoreloading?</strong>
+
+ <p>
+ There is a property, meant to be used in <i>development</i>,
+ not production :
+ </p>
+
+ <p>
+ <code>velocimacro.library.autoreload</code>
+ </p>
+
+ <p>
+ which defaults to false. When set to true <em>along with</em>
+ </p>
+
+ <p>
+ <code><type>.resource.loader.cache = false</code>
+ </p>
+
+ <p>
+ (where <type> is the name of the resource loader that you
+ are using, such as 'file') then the Velocity engine will automatically
+ reload changes to your Velocimacro library files when you make them,
+ so you do not have to dump the servlet engine (or application) or do
+ other tricks to have your Velocimacros reloaded.
+ </p>
+
+ <p>
+ Here is what a simple set of configuration properties would look like.
+ </p>
+
+ <source><![CDATA[
+ file.resource.loader.path = templates
+ file.resource.loader.cache = false
+ velocimacro.library.autoreload = true
+ ]]></source>
+
+ <p>
+ Don't keep this on in production.
+ </p>
+
</subsection>
</section>
1.80 +11 -0 jakarta-velocity/docs/developer-guide.html
Index: developer-guide.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/developer-guide.html,v
retrieving revision 1.79
retrieving revision 1.80
diff -u -r1.79 -r1.80
--- developer-guide.html 2001/09/26 11:45:01 1.79
+++ developer-guide.html 2001/10/19 11:15:11 1.80
@@ -2301,6 +2301,17 @@
Velocimacro.
</p>
<p>
+<code>velocimacro.library.autoreload = false</code><br />
+Controls Velocimacro library autoloading. When set to <code>true</code>
+the source Velocimacro library for an invoked Velocimacro will be checked
+for changes, and reloaded if necessary. This allows you to change and
+test Velocimacro libraries without having to restart your application or
+servlet container, just like you can with regular templates.
+This mode only works when caching is <i>off</i>
+in the resource loaders (e.g. <code>file.resource.loader.cache = false</code> ).
+This feature is intended for development, not for production.
+</p>
+ <p>
<strong>String Interpolation</strong>
</p>
<p>
1.55 +50 -0 jakarta-velocity/docs/user-guide.html
Index: user-guide.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/user-guide.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- user-guide.html 2001/10/11 03:44:47 1.54
+++ user-guide.html 2001/10/19 11:15:11 1.55
@@ -3640,6 +3640,56 @@
To get around this, simply use the <code>velocimacro.library</code>
facility to have Velocity load your VMs at startup.
</p>
+ <strong>What is Velocimacro
Autoreloading?</strong>
+ <p>
+ There is a property, meant to be used in <i>development</i>,
+ not production :
+ </p>
+ <p>
+ <code>velocimacro.library.autoreload</code>
+ </p>
+ <p>
+ which defaults to false. When set to true <em>along with</em>
+ </p>
+ <p>
+ <code><type>.resource.loader.cache = false</code>
+ </p>
+ <p>
+ (where <type> is the name of the resource loader that you
+ are using, such as 'file') then the Velocity engine will automatically
+ reload changes to your Velocimacro library files when you make them,
+ so you do not have to dump the servlet engine (or application) or do
+ other tricks to have your Velocimacros reloaded.
+ </p>
+ <p>
+ Here is what a simple set of configuration properties would look like.
+ </p>
+ <div align="left">
+ <table cellspacing="4" cellpadding="0" border="0">
+ <tr>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ <tr>
+ <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#ffffff"><pre>
+ file.resource.loader.path = templates
+ file.resource.loader.cache = false
+ velocimacro.library.autoreload = true
+ </pre></td>
+ <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ <tr>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
+ <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
+ </tr>
+ </table>
+ </div>
+ <p>
+ Don't keep this on in production.
+ </p>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
