Author: centic
Date: Mon Feb 22 11:07:10 2016
New Revision: 1731623
URL: http://svn.apache.org/viewvc?rev=1731623&view=rev
Log:
Rename menu-item to "Changelog"
Add new top-level page which describes the logging framework in more detail as
it is a general feature and not related to HSSF/XSSF only. Also move
information from other pages into it
Removed the "utils" section as it was unreachable anyway and contents from the
only page is now included in logging.xml
List XDocReport in related projects
Added:
poi/site/publish/logging.html
poi/site/src/documentation/content/xdocs/logging.xml
Removed:
poi/site/src/documentation/content/xdocs/utils/
Modified:
poi/site/publish/casestudies.html
poi/site/publish/changes.html
poi/site/publish/download.html
poi/site/publish/encryption.html
poi/site/publish/faq.html
poi/site/publish/guidelines.html
poi/site/publish/howtobuild.html
poi/site/publish/index.html
poi/site/publish/legal.html
poi/site/publish/mailinglists.html
poi/site/publish/overview.html
poi/site/publish/poi-ruby.html
poi/site/publish/related-projects.html
poi/site/publish/spreadsheet/how-to.html
poi/site/publish/subversion.html
poi/site/publish/text-extraction.html
poi/site/publish/todo.html
poi/site/publish/who.html
poi/site/src/documentation/content/xdocs/book.xml
poi/site/src/documentation/content/xdocs/related-projects.xml
poi/site/src/documentation/content/xdocs/spreadsheet/how-to.xml
Modified: poi/site/publish/casestudies.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/casestudies.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/casestudies.html (original)
+++ poi/site/publish/casestudies.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/changes.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/changes.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/changes.html (original)
+++ poi/site/publish/changes.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<span class="menuSelected">Changes Log</span>
+<span class="menuSelected">Changelog</span>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/download.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/download.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/download.html (original)
+++ poi/site/publish/download.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/encryption.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/encryption.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/encryption.html (original)
+++ poi/site/publish/encryption.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/faq.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/faq.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/faq.html (original)
+++ poi/site/publish/faq.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/guidelines.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/guidelines.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/guidelines.html (original)
+++ poi/site/publish/guidelines.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/howtobuild.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/howtobuild.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/howtobuild.html (original)
+++ poi/site/publish/howtobuild.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/index.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/index.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/index.html (original)
+++ poi/site/publish/index.html Mon Feb 22 11:07:10 2016
@@ -116,7 +116,7 @@ if (VERSION > 3) {
<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI";>Bug
Database</a>
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
<div class="menu">
@@ -166,6 +166,9 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
<span class="menuLabel">Apache Wide</span>
Modified: poi/site/publish/legal.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/legal.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/legal.html (original)
+++ poi/site/publish/legal.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Added: poi/site/publish/logging.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/logging.html?rev=1731623&view=auto
==============================================================================
--- poi/site/publish/logging.html (added)
+++ poi/site/publish/logging.html Mon Feb 22 11:07:10 2016
@@ -0,0 +1,439 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--*** This is a generated file. Do not edit. ***-->
+<link rel="stylesheet" href="skin/tigris.css" type="text/css">
+<link rel="stylesheet" href="skin/mysite.css" type="text/css">
+<link rel="stylesheet" href="skin/site.css" type="text/css">
+<link media="print" rel="stylesheet" href="skin/print.css" type="text/css">
+<title>Apache POI - Logging Framework</title>
+</head>
+<body bgcolor="white" class="composite">
+<!--================= start Banner ==================-->
+<div id="banner">
+<table width="100%" cellpadding="8" cellspacing="0" summary="banner"
border="0">
+<tbody>
+<tr>
+<!--================= start Group Logo ==================-->
+<td width="50%" align="left">
+<div class="groupLogo">
+<a href="http://www.apache.org";><img border="0" class="logoImage" alt="The
Apache Software Foundation" src="resources/images/asf_logo.png"></a>
+</div>
+</td>
+<!--================= end Group Logo ==================-->
+<!--================= start Project Logo ==================--><td width="50%"
align="right">
+<div align="right" class="projectLogo">
+<a href="http://poi.apache.org/";><img border="0" class="logoImage" alt="Apache
POI" src="resources/images/pb-poi.png"></a>
+</div>
+</td>
+<!--================= end Project Logo ==================-->
+</tr>
+</tbody>
+</table>
+</div>
+<!--================= end Banner ==================-->
+<!--================= start Main ==================-->
+<table width="100%" cellpadding="0" cellspacing="0" border="0" summary="nav"
id="breadcrumbs">
+<tbody>
+<!--================= start Status ==================-->
+<tr class="status">
+<td>
+<!--================= start BreadCrumb ==================--><a
href="http://www.apache.org/";>Apache</a> | <a
href="http://poi.apache.org/";>POI</a><a href=""></a>
+<!--================= end BreadCrumb ==================--></td><td id="tabs">
+<!--================= start Tabs ==================-->
+<div class="tab">
+<span class="selectedTab"><a class="base-selected"
href="index.html">Home</a></span> | <script language="Javascript"
type="text/javascript">
+function printit() {
+if (window.print) {
+ window.print() ;
+} else {
+ var WebBrowser = '<OBJECT ID="WebBrowser1" WIDTH="0" HEIGHT="0"
CLASSID="CLSID:8856F961-340A-11D0-A96B-00C04FD705A2"></OBJECT>';
+document.body.insertAdjacentHTML('beforeEnd', WebBrowser);
+ WebBrowser1.ExecWB(6, 2);//Use a 1 vs. a 2 for a prompting dialog box
WebBrowser1.outerHTML = "";
+}
+}
+</script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+ document.write(' <a title="PRINT this page OUT"
href="javascript:printit()">PRINT</a>');
+}
+</script>
+</div>
+<!--================= end Tabs ==================-->
+</td>
+</tr>
+</tbody>
+</table>
+<!--================= end Status ==================-->
+<table id="main" width="100%" cellpadding="8" cellspacing="0" summary=""
border="0">
+<tbody>
+<tr valign="top">
+<!--================= start Menu ==================-->
+<td id="leftcol">
+<div id="navcolumn">
+<div class="menuBar">
+<div class="menu">
+<span class="menuLabel">Overview</span>
+
+<div class="menuItem">
+<a href="index.html">Home</a>
+</div>
+
+<div class="menuItem">
+<a href="download.html">Download</a>
+</div>
+
+<div class="menuItem">
+<a href="overview.html">Components</a>
+</div>
+
+<div class="menuItem">
+<a href="text-extraction.html">Text Extraction</a>
+</div>
+
+<div class="menuItem">
+<a href="encryption.html">Encryption support</a>
+</div>
+
+<div class="menuItem">
+<a href="casestudies.html">Case Studies</a>
+</div>
+
+<div class="menuItem">
+<a href="related-projects.html">Related projects</a>
+</div>
+
+<div class="menuItem">
+<a href="legal.html">Legal</a>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">Help</span>
+
+<div class="menuItem">
+<a href="apidocs/index.html">Javadocs</a>
+</div>
+
+<div class="menuItem">
+<a href="faq.html">FAQ</a>
+</div>
+
+<div class="menuItem">
+<a href="mailinglists.html">Mailing Lists</a>
+</div>
+
+<div class="menuItem">
+<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI";>Bug
Database</a>
+</div>
+
+<div class="menuItem">
+<a href="changes.html">Changelog</a>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">Getting Involved</span>
+
+<div class="menuItem">
+<a href="subversion.html">Subversion Repository</a>
+</div>
+
+<div class="menuItem">
+<a href="howtobuild.html">How To Build</a>
+</div>
+
+<div class="menuItem">
+<a href="guidelines.html">Contribution Guidelines</a>
+</div>
+
+<div class="menuItem">
+<a href="who.html">Who We Are</a>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">Component APIs</span>
+
+<div class="menuItem">
+<a href="spreadsheet/index.html">Excel (SS=HSSF+XSSF)</a>
+</div>
+
+<div class="menuItem">
+<a href="document/index.html">Word (HWPF+XWPF)</a>
+</div>
+
+<div class="menuItem">
+<a href="slideshow/index.html">PowerPoint (HSLF+XSLF)</a>
+</div>
+
+<div class="menuItem">
+<a href="oxml4j/index.html">OpenXML4J (OOXML)</a>
+</div>
+
+<div class="menuItem">
+<a href="poifs/index.html">OLE2 Filesystem (POIFS)</a>
+</div>
+
+<div class="menuItem">
+<a href="hpsf/index.html">OLE2 Document Props (HPSF)</a>
+</div>
+
+<div class="menuItem">
+<a href="hsmf/index.html">Outlook (HSMF)</a>
+</div>
+
+<div class="menuItem">
+<a href="hdgf/index.html">Visio (HDGF)</a>
+</div>
+
+<div class="menuItem">
+<a href="hmef/index.html">TNEF (HMEF)</a>
+</div>
+
+<div class="menuItem">
+<a href="hpbf/index.html">Publisher (HPBF)</a>
+</div>
+
+<div class="menuItem">
+<span class="menuSelected">Logging framework</span>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">Apache Wide</span>
+
+<div class="menuItem">
+<a href="http://www.apache.org/";>Apache Software Foundation</a>
+</div>
+
+<div class="menuItem">
+<a href="http://www.apache.org/licenses/";>License</a>
+</div>
+
+<div class="menuItem">
+<a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a>
+</div>
+
+<div class="menuItem">
+<a href="http://www.apache.org/foundation/thanks.html";>Thanks</a>
+</div>
+
+<div class="menuItem">
+<a href="http://www.apache.org/security/";>Security</a>
+</div>
+
+</div>
+</div>
+</div>
+<form target="_blank" action="https://www.google.com/search"; method="get">
+<table summary="search" border="0" cellspacing="0" cellpadding="0">
+<tr>
+<td><img height="1" width="1" alt="" src="skin/images/spacer.gif"
class="spacer"></td><td nowrap="nowrap">
+ Search Apache POI<br>
+<input value="poi.apache.org" name="sitesearch" type="hidden"><input size="10"
name="q" id="query" type="text"><img height="1" width="5" alt=""
src="skin/images/spacer.gif" class="spacer"><input name="Search" value="GO"
type="submit"></td><td><img height="1" width="1" alt=""
src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td colspan="3"><img height="7" width="1" alt="" src="skin/images/spacer.gif"
class="spacer"></td>
+</tr>
+<tr>
+<td class="bottom-left-thick"></td><td bgcolor="#a5b6c6"><img height="1"
width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td
class="bottom-right-thick"></td>
+</tr>
+</table>
+</form>
+</td>
+<!--================= end Menu ==================-->
+<!--================= start Content ==================--><td>
+<div id="bodycol">
+<div class="app">
+<div align="center">
+<h1>Apache POI - Logging Framework</h1>
+</div>
+<div class="h3">
+
+
+
+
+<a name="Introduction"></a>
+<div class="h3">
+<h3>Introduction</h3>
+</div>
+
+
+<p>
+ POI uses a custom logging framework which allows to configure
where logs are sent to.
+ </p>
+
+<p>
+ Logging in POI is used only as a debugging mechanism, not a
normal runtime
+ logging system. Logging on level debug/info is ONLY for
autopsie type debugging, and should
+ NEVER be enabled on a production system.
+ </p>
+
+<p>
+ The framework is extensible so that you can send log messages
to any logging framework
+ that your application uses.
+ </p>
+
+<p>
+ A number of default logging implementations are supported by
POI out-of-the-box and can be selected via a
+ system property.
+ </p>
+
+
+<a name="Enable+logging"></a>
+<div class="h3">
+<h3>Enable logging</h3>
+</div>
+
+<p>
+ By default, logging is disabled in POI. Sometimes it might be
useful
+ to enable logging to see some debug messages printed out which can
+ help in analyzing problems.
+ </p>
+
+<p>
+ You can select the logging framework by setting the system
property <em>org.apache.poi.util.POILogger</em> during application startup or
by calling System.setProperty():
+ </p>
+
+<pre class="code">
+ System.setProperty("org.apache.poi.util.POILogger",
"org.apache.poi.util.CommonsLogger" );
+ </pre>
+
+<p>
+ Note: You need to call <em>setProperty()</em> before any POI
functionality is invoked as the logger is only initialized during startup.
+ </p>
+
+
+<a name="Available+logger+implementations"></a>
+<div class="h3">
+<h3>Available logger implementations</h3>
+</div>
+
+<p>
+ The following logger implementations are provided by POI:
+ </p>
+
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr class="b">
+
+<th colspan="1" rowspan="1">Class</th>
+ <th colspan="1" rowspan="1">Type</th>
+
+</tr>
+
+<tr class="a">
+
+<td colspan="1" rowspan="1">org.apache.poi.util.SystemOutLogger</td>
+ <td colspan="1" rowspan="1">Sends log output to the system
console</td>
+
+</tr>
+
+<tr class="b">
+
+<td colspan="1" rowspan="1">org.apache.poi.util.NullLogger</td>
+ <td colspan="1" rowspan="1">Default logger, does not log
anything</td>
+
+</tr>
+
+<tr class="a">
+
+<td colspan="1" rowspan="1">org.apache.poi.util.CommonsLogger</td>
+ <td colspan="1" rowspan="1">Allows to use <a
href="https://commons.apache.org/proper/commons-logging/";>Apache Commons
Logging</a> for logging. This can use JDK1.4 logging,
+ log4j, logkit, ...</td>
+
+</tr>
+
+<tr class="b">
+
+<td colspan="1" rowspan="1">org.apache.poi.util.DummyPOILogger</td>
+ <td colspan="1" rowspan="1">Simple logger which will keep all
log-lines in memory for later analysis. Used primarily for testing. Note: this
may cause a memory leak if used in production application!</td>
+
+</tr>
+
+</table>
+
+
+<a name="Sending+logs+to+a+different+log+framework"></a>
+<div class="h3">
+<h3>Sending logs to a different log framework</h3>
+</div>
+
+<p>
+ You can send logs to other logging frameworks by implementing
the interface <em>org.apache.poi.util.POILogger</em>.
+ </p>
+
+
+<a name="Implementation+details"></a>
+<div class="h3">
+<h3>Implementation details</h3>
+</div>
+
+<p>
+ Every class uses a <span class="codefrag">POILogger</span> to
log, and gets it using a static method
+ of the <span class="codefrag">POILogFactory</span> .
+ </p>
+
+<p>
+ Each class in POI can log using a <span
class="codefrag">POILogger</span>, which is an abstract class.
+ We decided to make our own logging facade because:</p>
+
+<ol>
+
+<li>we need to log many values and we put many methods in this class to
facilitate the
+ programmer, without having him write string
concatenations;</li>
+
+<li>we need to be able to use POI without any logger package present.</li>
+
+</ol>
+
+
+
+
+<div id="authors" align="right">by Dominik Stadler</div>
+</div>
+</div>
+</div>
+</td>
+<!--================= end Content ==================-->
+</tr>
+</tbody>
+</table>
+<!--================= end Main ==================-->
+<!--================= start Footer ==================-->
+<div id="footer">
+<table summary="footer" cellspacing="0" cellpadding="4" width="100%"
border="0">
+<tbody>
+<tr>
+<!--================= start Copyright ==================-->
+<td colspan="2">
+<div align="center">
+<div class="copyright">
+ Copyright © 2002-2016 The Apache Software Foundation.
All rights reserved.<br>
+ Apache, Apache POI, and the Apache POI logo are registered
trademarks or
+ trademarks of The Apache Software Foundation in the U.S. and/or
other countries.
+ </div>
+</div>
+</td>
+<!--================= end Copyright ==================-->
+</tr>
+<tr>
+<td align="left">
+<!--================= start Host ==================-->
+<!--================= end Host ==================--></td><td align="right">
+<!--================= start Credits ==================-->
+<div align="right">
+<div class="credit"></div>
+</div>
+<!--================= end Credits ==================-->
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<!--================= end Footer ==================-->
+</body>
+</html>
Modified: poi/site/publish/mailinglists.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/mailinglists.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/mailinglists.html (original)
+++ poi/site/publish/mailinglists.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/overview.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/overview.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/overview.html (original)
+++ poi/site/publish/overview.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/poi-ruby.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/poi-ruby.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/poi-ruby.html (original)
+++ poi/site/publish/poi-ruby.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/related-projects.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/related-projects.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/related-projects.html (original)
+++ poi/site/publish/related-projects.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
@@ -415,7 +419,19 @@ if (VERSION > 3) {
Available under the Apache License, Version 2.0.
</p>
-
+
+<a name="XDocReport"></a>
+<div class="h4">
+<h4>XDocReport</h4>
+</div>
+
+<p>
+
+<a href="https://github.com/opensagres/xdocreport";>XDocReport</a> is a Java
API to merge XML document created with MS Office (docx) or OpenOffice (odt),
+ LibreOffice (odt) with a Java model to generate report and
convert it if you need to another format (PDF, XHTML...).
+ XDocReport code is license under MIT license but the
samples are licensed under LGPL license.
+ </p>
+
Modified: poi/site/publish/spreadsheet/how-to.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/spreadsheet/how-to.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/spreadsheet/how-to.html (original)
+++ poi/site/publish/spreadsheet/how-to.html Mon Feb 22 11:07:10 2016
@@ -1134,37 +1134,6 @@ most likely fail. No big deal. </li>
</ul>
-<a name="Logging+facility"></a>
-<div class="h4">
-<h4>Logging facility</h4>
-</div>
-
-<p>POI can dynamically select its logging implementation. POI tries to
- create a logger using the System property named
"org.apache.poi.util.POILogger".
- Out of the box this can be set to one of three values:
- </p>
-
-<ul>
-
-<li>org.apache.poi.util.CommonsLogger</li>
-
-<li>org.apache.poi.util.NullLogger</li>
-
-<li>org.apache.poi.util.SystemOutLogger</li>
-
-</ul>
-
-<p>
- If the property is not defined or points to an invalid classthen the
NullLogger is used.
- </p>
-
-<p>
- Refer to the commons logging package level javadoc for more
information concerning how to
- <a
href="http://jakarta.apache.org/commons/logging/api/index.html";>configure
commons logging.</a>
-
-</p>
-
-
<a name="HSSF+Developer%27s+Tools"></a>
<div class="h4">
<h4>HSSF Developer's Tools</h4>
Modified: poi/site/publish/subversion.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/subversion.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/subversion.html (original)
+++ poi/site/publish/subversion.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/text-extraction.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/text-extraction.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/text-extraction.html (original)
+++ poi/site/publish/text-extraction.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/todo.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/todo.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/todo.html (original)
+++ poi/site/publish/todo.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/publish/who.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/who.html?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/publish/who.html (original)
+++ poi/site/publish/who.html Mon Feb 22 11:07:10 2016
@@ -130,7 +130,7 @@ if (VERSION > 3) {
</div>
<div class="menuItem">
-<a href="changes.html">Changes Log</a>
+<a href="changes.html">Changelog</a>
</div>
</div>
@@ -196,6 +196,10 @@ if (VERSION > 3) {
<div class="menuItem">
<a href="hpbf/index.html">Publisher (HPBF)</a>
</div>
+
+<div class="menuItem">
+<a href="logging.html">Logging framework</a>
+</div>
</div>
<div class="menu">
Modified: poi/site/src/documentation/content/xdocs/book.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/book.xml?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/book.xml (original)
+++ poi/site/src/documentation/content/xdocs/book.xml Mon Feb 22 11:07:10 2016
@@ -40,7 +40,7 @@
<menu-item label="FAQ" href="faq.html"/>
<menu-item label="Mailing Lists" href="mailinglists.html"/>
<menu-item label="Bug Database"
href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI"/>
- <menu-item label="Changes Log" href="changes.html"/>
+ <menu-item label="Changelog" href="changes.html"/>
</menu>
<menu label="Getting Involved">
@@ -61,6 +61,7 @@
<menu-item label="Visio (HDGF)" href="hdgf/index.html"/>
<menu-item label="TNEF (HMEF)" href="hmef/index.html"/>
<menu-item label="Publisher (HPBF)" href="hpbf/index.html"/>
+ <menu-item label="Logging framework" href="logging.html"/>
</menu>
<menu label="Apache Wide">
Added: poi/site/src/documentation/content/xdocs/logging.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/logging.xml?rev=1731623&view=auto
==============================================================================
--- poi/site/src/documentation/content/xdocs/logging.xml (added)
+++ poi/site/src/documentation/content/xdocs/logging.xml Mon Feb 22 11:07:10
2016
@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ====================================================================
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ====================================================================
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN"
"./dtd/document-v13.dtd">
+
+<document>
+ <header>
+ <title>Apache POI - Logging Framework</title>
+ <authors>
+ <person id="DS" name="Dominik Stadler" email="[email protected]"/>
+ </authors>
+ </header>
+
+ <body>
+ <section>
+ <title>Introduction</title>
+ <p>
+ POI uses a custom logging framework which allows to configure
where logs are sent to.
+ </p>
+ <p>
+ Logging in POI is used only as a debugging mechanism, not a
normal runtime
+ logging system. Logging on level debug/info is ONLY for
autopsie type debugging, and should
+ NEVER be enabled on a production system.
+ </p>
+ <p>
+ The framework is extensible so that you can send log messages
to any logging framework
+ that your application uses.
+ </p>
+ <p>
+ A number of default logging implementations are supported by
POI out-of-the-box and can be selected via a
+ system property.
+ </p>
+ </section>
+ <section><title>Enable logging</title>
+ <p>
+ By default, logging is disabled in POI. Sometimes it might be
useful
+ to enable logging to see some debug messages printed out which can
+ help in analyzing problems.
+ </p>
+ <p>
+ You can select the logging framework by setting the system
property <em>org.apache.poi.util.POILogger</em> during application startup or
by calling System.setProperty():
+ </p>
+ <source>
+ System.setProperty("org.apache.poi.util.POILogger",
"org.apache.poi.util.CommonsLogger" );
+ </source>
+ <p>
+ Note: You need to call <em>setProperty()</em> before any POI
functionality is invoked as the logger is only initialized during startup.
+ </p>
+ </section>
+ <section><title>Available logger implementations</title>
+ <p>
+ The following logger implementations are provided by POI:
+ </p>
+ <table>
+ <tr>
+ <th>Class</th>
+ <th>Type</th>
+ </tr>
+ <tr>
+ <td>org.apache.poi.util.SystemOutLogger</td>
+ <td>Sends log output to the system console</td>
+ </tr>
+ <tr>
+ <td>org.apache.poi.util.NullLogger</td>
+ <td>Default logger, does not log anything</td>
+ </tr>
+ <tr>
+ <td>org.apache.poi.util.CommonsLogger</td>
+ <td>Allows to use <link
href="https://commons.apache.org/proper/commons-logging/";>Apache Commons
Logging</link> for logging. This can use JDK1.4 logging,
+ log4j, logkit, ...</td>
+ </tr>
+ <tr>
+ <td>org.apache.poi.util.DummyPOILogger</td>
+ <td>Simple logger which will keep all log-lines in memory for
later analysis. Used primarily for testing. Note: this may cause a memory leak
if used in production application!</td>
+ </tr>
+ </table>
+ </section>
+ <section><title>Sending logs to a different log framework</title>
+ <p>
+ You can send logs to other logging frameworks by implementing
the interface <em>org.apache.poi.util.POILogger</em>.
+ </p>
+ </section>
+ <section><title>Implementation details</title>
+ <p>
+ Every class uses a <code>POILogger</code> to log, and gets it
using a static method
+ of the <code>POILogFactory</code> .
+ </p>
+ <p>
+ Each class in POI can log using a <code>POILogger</code>,
which is an abstract class.
+ We decided to make our own logging facade because:</p>
+ <ol>
+ <li>we need to log many values and we put many methods in this
class to facilitate the
+ programmer, without having him write string
concatenations;</li>
+ <li>we need to be able to use POI without any logger package
present.</li>
+ </ol>
+ </section>
+ </body>
+ <footer>
+ <legal>
+ Copyright (c) @year@ The Apache Software Foundation All rights
reserved.
+ <br />
+ Apache POI, POI, Apache, the Apache feather logo, and the Apache
+ POI project logo are trademarks of The Apache Software Foundation.
+ </legal>
+ </footer>
+</document>
Modified: poi/site/src/documentation/content/xdocs/related-projects.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/related-projects.xml?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/related-projects.xml (original)
+++ poi/site/src/documentation/content/xdocs/related-projects.xml Mon Feb 22
11:07:10 2016
@@ -109,7 +109,13 @@
Available under the Apache License, Version 2.0.
</p>
</section>
-
+ <section><title>XDocReport</title>
+ <p>
+ <link
href="https://github.com/opensagres/xdocreport";>XDocReport</link> is a Java API
to merge XML document created with MS Office (docx) or OpenOffice (odt),
+ LibreOffice (odt) with a Java model to generate report and
convert it if you need to another format (PDF, XHTML...).
+ XDocReport code is license under MIT license but the
samples are licensed under LGPL license.
+ </p>
+ </section>
</section>
</body>
<footer>
Modified: poi/site/src/documentation/content/xdocs/spreadsheet/how-to.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/spreadsheet/how-to.xml?rev=1731623&r1=1731622&r2=1731623&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/spreadsheet/how-to.xml (original)
+++ poi/site/src/documentation/content/xdocs/spreadsheet/how-to.xml Mon Feb 22
11:07:10 2016
@@ -831,24 +831,6 @@ Failing this test is not necessarily a b
most likely fail. No big deal. </li>
</ul>
</section>
- <section><title>Logging facility</title>
- <p>POI can dynamically select its logging implementation. POI tries to
- create a logger using the System property named
"org.apache.poi.util.POILogger".
- Out of the box this can be set to one of three values:
- </p>
- <ul>
- <li>org.apache.poi.util.CommonsLogger</li>
- <li>org.apache.poi.util.NullLogger</li>
- <li>org.apache.poi.util.SystemOutLogger</li>
- </ul>
- <p>
- If the property is not defined or points to an invalid classthen the
NullLogger is used.
- </p>
- <p>
- Refer to the commons logging package level javadoc for more
information concerning how to
- <link
href="http://jakarta.apache.org/commons/logging/api/index.html";>configure
commons logging.</link>
- </p>
- </section>
<section><title>HSSF Developer's Tools</title>
<p>HSSF has a number of tools useful for developers to debug/develop
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
