Author: cbrisson
Date: Fri Nov 11 20:41:00 2016
New Revision: 1769341
URL: http://svn.apache.org/viewvc?rev=1769341&view=rev
Log:
[site] document logging reeng
Modified:
velocity/site/cms/trunk/content/css/site.css
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/developer-guide.mdtext
velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext
Modified: velocity/site/cms/trunk/content/css/site.css
URL:
http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/css/site.css?rev=1769341&r1=1769340&r2=1769341&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/css/site.css (original)
+++ velocity/site/cms/trunk/content/css/site.css Fri Nov 11 20:41:00 2016
@@ -156,7 +156,7 @@ ol, ul, dd
li, dt, dd
{
- margin: 0;
+ margin: 0 0 0.2em 0;
}
li > ul, li > ol, dd > dl
@@ -213,7 +213,7 @@ a > img
#leftnav h2 { margin: 0.1em 0 0.1em 0; font-size: 1.1em;}
#leftnav a.headerlink { display: none; }
#leftnav ul { list-style: none; padding-left: 0; margin: 0.1em 0 0.4em 0; }
-#leftnav li { line-height: 1.2em; }
+#leftnav li { line-height: 1.2em; margin: 0; }
#bottom-nav { text-align: center; }
#bottom-nav img { margin: 0.2em 0; }
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=1769341&r1=1769340&r2=1769341&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 Fri Nov
11 20:41:00 2016
@@ -506,7 +506,16 @@ Since version 2.0, Velocity has switched
All you have to do to enable logging is to make sure that your classpath
contains the slf4j-api jar, and one and only one slf4j binding jar towards your
favourite logsystem or facade. See the [dependecies](#dependencies) section for
a list of SLF4J bindings.
-By default, Velocity will use a logger tagged for the
org.apache.velocity.app.Velocity class. You can customize this logger in two
ways:
+By default, Velocity will use a base logger named `org.apache.velocity`, and
several children loggers (whose name is appended to the base logger name):
+
++ `directive`, and `directive.`*`[directivename]`* for all logs related to VTL
directives
++ `parser` for parser logs
++ `loader`, and `loader.`*`[loadername]`* for resource loaders logs
++ `macro` for macro-related logs
++ `rendering` for everything related to actual rendering of templates,
including introspection and method calls
++ `event` for logs emitted by the event cartridge.
+
+You can customize this logger in two ways:
+ By programmatically giving Velocity a living instance of an orf.slf4j.Logger
object, using the runtime.log.instance property key.
+ By configuring the name of the logger to be used by your velocity instance,
using the runtime.log.name property key. It can be done from the
velocity.properties file, if present.
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=1769341&r1=1769340&r2=1769341&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext Fri Nov 11
20:41:00 2016
@@ -17,21 +17,19 @@ Read below for futher details.
### Behavior / API changes:
-+ velocity is now using the SLF4J logging facade. Hence, all methods accepting
or returning a logger now use the org.slf4j.Logger object.
++ velocity is now using the SLF4J logging facade. Hence, all methods accepting
or returning a logger now use the org.slf4j.Logger object. Velocity uses a
logger name of `org.apache.velocity` (configurable with the `runtime.log.name`
configuration entry), and [several other childen
loggers](developer-guide.html#logging).
+ the internal Context API now enforces String keys everywhere, this may break
custom Context implementations at compile-time.
+ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met:
-
+ the reference is a quiet reference
+ the reference could be successfully evaluated but resulted in a null
value
+ the reference is tested for validity inside an #if / #elseif statement
-
The 1.x behavior did send invalid reference events in all those cases.
-
+ The `ResourceLoader` class has been deprecated in favor of a
`ResourceLoader2` class, in which the `InputStream
ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader
ResourceLoader.getResourceReader(String name, String encoding)`. Since
`ResourceLoader` inherits from `ResourceLoader2`, the change remains backward
compatible, but custom resource loaders should be upgraded to avoid
deprecattion warnings.
+ the default encoding ('ISO-8859-1' in 1.x) is now read from the standard
`file.encoding` Java system property.
+ the MethodException event handler now receives an additional argument
providing template name and location infos.
+ all occurences of the class
org.apache.commons.collections.ExtendedProperties in the initialization API
have been replaced by org.apache.velocity.util.ExtProperties.
+ the macros are now using a 'call by sharing' convention (which means that
all arguments are evaluated once at start, and that the macro receives a copy
of the reference to each argument).
++ the `UberspectLoggable` interface has been removed.
### VTL Changes:
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=1769341&r1=1769340&r2=1769341&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext
(original)
+++ velocity/site/cms/trunk/content/engine/devel/developer-guide.mdtext Fri Nov
11 20:41:00 2016
@@ -506,7 +506,16 @@ Since version 2.0, Velocity has switched
All you have to do to enable logging is to make sure that your classpath
contains the slf4j-api jar, and one and only one slf4j binding jar towards your
favourite logsystem or facade. See the [dependecies](#dependencies) section for
a list of SLF4J bindings.
-By default, Velocity will use a logger tagged for the
org.apache.velocity.app.Velocity class. You can customize this logger in two
ways:
+By default, Velocity will use a base logger named `org.apache.velocity`, and
several children loggers (whose name is appended to the base logger name):
+
++ `directive`, and `directive.`*`[directivename]`* for all logs related to VTL
directives
++ `parser` for parser logs
++ `loader`, and `loader.`*`[loadername]`* for resource loaders logs
++ `macro` for macro-related logs
++ `rendering` for everything related to actual rendering of templates,
including introspection and method calls
++ `event` for logs emitted by the event cartridge.
+
+You can customize this logger in two ways:
+ By programmatically giving Velocity a living instance of an orf.slf4j.Logger
object, using the runtime.log.instance property key.
+ By configuring the name of the logger to be used by your velocity instance,
using the runtime.log.name property key. It can be done from the
velocity.properties file, if present.
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=1769341&r1=1769340&r2=1769341&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext Fri Nov 11
20:41:00 2016
@@ -17,21 +17,19 @@ Read below for futher details.
### Behavior / API changes:
-+ velocity is now using the SLF4J logging facade. Hence, all methods accepting
or returning a logger now use the org.slf4j.Logger object.
++ velocity is now using the SLF4J logging facade. Hence, all methods accepting
or returning a logger now use the org.slf4j.Logger object. Velocity uses a
logger name of `org.apache.velocity` (configurable with the `runtime.log.name`
configuration entry), and [several other childen
loggers](developer-guide.html#logging).
+ the internal Context API now enforces String keys everywhere, this may break
custom Context implementations at compile-time.
+ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met:
-
+ the reference is a quiet reference
+ the reference could be successfully evaluated but resulted in a null
value
+ the reference is tested for validity inside an #if / #elseif statement
-
The 1.x behavior did send invalid reference events in all those cases.
-
+ The `ResourceLoader` class has been deprecated in favor of a
`ResourceLoader2` class, in which the `InputStream
ResourceLoader.getResourceStream(String name)` has been replaced by a `Reader
ResourceLoader.getResourceReader(String name, String encoding)`. Since
`ResourceLoader` inherits from `ResourceLoader2`, the change remains backward
compatible, but custom resource loaders should be upgraded to avoid
deprecattion warnings.
+ the default encoding ('ISO-8859-1' in 1.x) is now read from the standard
`file.encoding` Java system property.
+ the MethodException event handler now receives an additional argument
providing template name and location infos.
+ all occurences of the class
org.apache.commons.collections.ExtendedProperties in the initialization API
have been replaced by org.apache.velocity.util.ExtProperties.
+ the macros are now using a 'call by sharing' convention (which means that
all arguments are evaluated once at start, and that the macro receives a copy
of the reference to each argument).
++ the `UberspectLoggable` interface has been removed.
### VTL Changes:
