aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs
diff options
context:
space:
mode:
authorJeremias Maerki <jeremias@apache.org>2008-04-15 10:19:44 +0000
committerJeremias Maerki <jeremias@apache.org>2008-04-15 10:19:44 +0000
commitf993b978c0dfc1ed4c336c97b29eef9b80caf187 (patch)
treecc8f4e9efe0b67e57b120813e6100f214075216b /src/documentation/content/xdocs
parent3b525dc8b0c9278d0449c6d59a08dcaa24b3c7a5 (diff)
downloadxmlgraphics-fop-f993b978c0dfc1ed4c336c97b29eef9b80caf187.tar.gz
xmlgraphics-fop-f993b978c0dfc1ed4c336c97b29eef9b80caf187.zip
Adjust information on logging given the availability of the event package.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@648206 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs')
-rw-r--r--src/documentation/content/xdocs/trunk/embedding.xml32
1 files changed, 21 insertions, 11 deletions
diff --git a/src/documentation/content/xdocs/trunk/embedding.xml b/src/documentation/content/xdocs/trunk/embedding.xml
index b2c802db7..9ed42dd9d 100644
--- a/src/documentation/content/xdocs/trunk/embedding.xml
+++ b/src/documentation/content/xdocs/trunk/embedding.xml
@@ -175,17 +175,6 @@ try {
processing run anymore. The log output of multiple, simultaneously running FOP instances
is sent to the same logger.
</p>
- <note>
- We know this may be an issue in multi-threaded server environments if you'd like to
- know what's going on in every single FOP processing run. We're planning to add an
- additional feedback facility to FOP which can be used to obtain all sorts of specific
- feedback (validation messages, layout problems etc.). "Static logging" is mainly
- interesting for a developer working on FOP and for advanced users who are debugging
- FOP. We don't consider the logging output to be useful to normal FOP users. Please
- have some patience until we can add this feature or jump in and help us build it. We've
- set up a <a href="http://wiki.apache.org/xmlgraphics-fop/ProcessingFeedback">Wiki page</a>
- which documents what we're going to build.
- </note>
<p>
By default, <a href="ext:commons-logging">Jakarta Commons Logging</a> uses
JDK logging (available in JDKs 1.4 or higher) as its backend. You can configure Commons
@@ -193,6 +182,27 @@ try {
<a href="ext:commons-logging">documentation for Jakarta Commons Logging</a> on
how to configure alternative backends.
</p>
+ <p>
+ As a result of the above we differentiate between to kinds of "logging":
+ </p>
+ <ul>
+ <li>(FOP-)Developer-oriented logging</li>
+ <li><a href="events.html">User/Integrator-oriented feedback</a> (NEW!)</li>
+ </ul>
+ <p>
+ The use of "feedback" instead of "logging" is intentional. Most people were using
+ log output as a means to get feedback from events within FOP. Therefore, FOP now
+ includes an <code>event</code> package which can be used to receive feedback from
+ the layout engine and other components within FOP <strong>per rendering run</strong>.
+ This feedback is not just some
+ text but event objects with parameters so these events can be interpreted by code.
+ Of course, there is a facility to turn these events into normal human-readable
+ messages. For details, please read on on the <a href="events.html">Events page</a>.
+ This leaves normal logging to be mostly a thing used by the FOP developers
+ although anyone can surely activate certain logging categories but the feedback
+ from the loggers won't be separated by processing runs. If this is required,
+ the <a href="events.html">Events subsystem</a> is the right approach.
+ </p>
</section>
<section id="render">