You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2018/07/18 23:27:24 UTC
svn commit: r1836244 [9/31] - in /poi/site/publish: ./ components/
components/diagram/ components/document/ components/hmef/ components/hpbf/
components/hpsf/ components/hsmf/ components/oxml4j/ components/poifs/
components/poifs/images/ components/sli...
Copied: poi/site/publish/components/index.html (from r1836243, poi/site/publish/overview.html)
URL: http://svn.apache.org/viewvc/poi/site/publish/components/index.html?p2=poi/site/publish/components/index.html&p1=poi/site/publish/overview.html&r1=1836243&r2=1836244&rev=1836244&view=diff
==============================================================================
--- poi/site/publish/overview.html (original)
+++ poi/site/publish/components/index.html Wed Jul 18 23:27:21 2018
@@ -1,280 +1,301 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.9">
+<meta name="Forrest-skin-name" content="pelt">
<title>Apache POI - Component Overview</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/favicon.ico">
</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="https://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="https://donate.apache.org/"><img border="0" class="logoImage" alt="Support Apache" src="resources/images/support-asf.png" width="120" height="120" title="Your donation helps The Apache Software Foundation ensure its community-driven software remains available to billions of users at absolutely no cost."></a><a href="https://poi.apache.org/"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/pb-poi.png" width="120" height="120" title="Apache POI - the Java API for Microsoft Documents"></a>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="https://www.apache.org">Apache Software Foundation</a> > <a href="https://poi.apache.org">Apache POI</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="https://www.apache.org"><img class="logoImage" alt="Apache Software Foundation" src="../images/group-logo.png" title="The Apache Software Foundation is a cornerstone of the modern Open Source software ecosystem – supporting some of the most widely used and important software solutions powering today's Internet economy."></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="https://poi.apache.org"><img class="logoImage" alt="Apache POI" src="../images/project-logo.png" title="Apache POI is well-known in the Java field as a library for reading and writing Microsoft Office file formats, such as Excel, PowerPoint, Word, Visio, Publisher and Outlook. It supports both the older (OLE2) and new (OOXML - Office Open XML) formats."></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="poi.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
</div>
-</td>
-<!--================= end Project Logo ==================-->
-</tr>
-</tbody>
-</table>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../help/index.html">Help</a>
+</li>
+<li class="current">
+<a class="selected" href="../components/index.html">Component APIs</a>
+</li>
+<li>
+<a class="unselected" href="../devel/index.html">Getting Involved</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Component APIs</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
</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="https://www.apache.org/">Apache</a> | <a href="https://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 class="menuitem">
+<a href="../apidocs/index.html">Javadocs</a>
</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 onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">Excel (HSSF/XSSF)</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/spreadsheet/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="download.html">Download</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/quick-guide.html">Quick Guide</a>
</div>
-
-<div class="menuItem">
-<span class="menuSelected">Components</span>
+<div class="menuitem">
+<a href="../components/spreadsheet/how-to.html">HOWTO</a>
</div>
-
-<div class="menuItem">
-<a href="text-extraction.html">Text Extraction</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/converting.html">HSSF to SS Converting</a>
</div>
-
-<div class="menuItem">
-<a href="encryption.html">Encryption support</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/formula.html">Formula Support</a>
</div>
-
-<div class="menuItem">
-<a href="casestudies.html">Case Studies</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/eval.html">Formula Evaluation</a>
</div>
-
-<div class="menuItem">
-<a href="related-projects.html">Related projects</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/eval-devguide.html">Eval Dev Guide</a>
</div>
-
-<div class="menuItem">
-<a href="legal.html">Legal</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/examples.html">Examples</a>
</div>
-
+<div class="menuitem">
+<a href="../components/spreadsheet/use-case.html">Use Case</a>
</div>
-<div class="menu">
-<span class="menuLabel">Help</span>
-
-<div class="menuItem">
-<a href="apidocs/index.html">Javadocs</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/diagrams.html">Pictorial Docs</a>
</div>
-
-<div class="menuItem">
-<a href="faq.html">FAQ</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/limitations.html">Limitations</a>
</div>
-
-<div class="menuItem">
-<a href="mailinglists.html">Mailing Lists</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/user-defined-functions.html">User Defined Functions</a>
</div>
-
-<div class="menuItem">
-<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/excelant.html">ExcelAnt Tests</a>
</div>
-
-<div class="menuItem">
-<a href="changes.html">Changelog</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/hacking-hssf.html">Hacking HSSF</a>
</div>
-
+<div class="menuitem">
+<a href="../components/spreadsheet/record-generator.html">Record Generator</a>
</div>
-<div class="menu">
-<span class="menuLabel">Getting Involved</span>
-
-<div class="menuItem">
-<a href="subversion.html">Subversion Repository</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/chart.html">Charts</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 onclick="SwitchMenu('menu_1.1.4', '../skin/')" id="menu_1.1.4Title" class="menutitle">PowerPoint (HSLF/XSLF)</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/slideshow/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="who.html">Who We Are</a>
+<div class="menuitem">
+<a href="../components/slideshow/quick-guide.html">Quick Guide</a>
</div>
-
+<div class="menuitem">
+<a href="../components/slideshow/how-to-shapes.html">HSLF Cookbook</a>
</div>
-<div class="menu">
-<span class="menuLabel">Component APIs</span>
-
-<div class="menuItem">
-<a href="spreadsheet/index.html">Excel (SS=HSSF+XSSF+SXSSF)</a>
+<div class="menuitem">
+<a href="../components/slideshow/xslf-cookbook.html">XSLF Cookbook</a>
</div>
-
-<div class="menuItem">
-<a href="slideshow/index.html">PowerPoint (SL=HSLF+XSLF)</a>
+<div class="menuitem">
+<a href="../components/slideshow/ppt-file-format.html">PPT File Format</a>
</div>
-
-<div class="menuItem">
-<a href="document/index.html">Word (WP=HWPF+XWPF)</a>
</div>
-
-<div class="menuItem">
-<a href="hsmf/index.html">Outlook (HSMF)</a>
+<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Word (HWPF/XWPF)</div>
+<div id="menu_1.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/document/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="diagram/index.html">Visio (HDGF+XDGF)</a>
+<div class="menuitem">
+<a href="../components/document/quick-guide.html">HWPF Quick Guide</a>
</div>
-
-<div class="menuItem">
-<a href="hpbf/index.html">Publisher (HPBF)</a>
+<div class="menuitem">
+<a href="../components/document/quick-guide-xwpf.html">XWPF Quick Guide</a>
</div>
-
+<div class="menuitem">
+<a href="../components/document/docoverview.html">HWPF Format</a>
</div>
-<div class="menu">
-<span class="menuLabel">Low-level Component APIs</span>
-
-<div class="menuItem">
-<a href="poifs/index.html">OLE2 Filesystem (POIFS)</a>
+<div class="menuitem">
+<a href="../components/document/projectplan.html">HWPF Project plan</a>
</div>
-
-<div class="menuItem">
-<a href="hpsf/index.html">OLE2 Document Props (HPSF)</a>
</div>
-
-<div class="menuItem">
-<a href="hmef/index.html">TNEF (HMEF) for winmail.dat</a>
+<div class="menuitem">
+<a href="../components/hsmf/index.html">Outlook (HSMF)</a>
</div>
-
-<div class="menuItem">
-<a href="oxml4j/index.html">OpenXML4J (OOXML)</a>
+<div class="menuitem">
+<a href="../components/diagram/index.html">Visio (HDGF+XDGF)</a>
</div>
-
-<div class="menuItem">
-<a href="logging.html">Logging framework</a>
+<div onclick="SwitchMenu('menu_1.1.8', '../skin/')" id="menu_1.1.8Title" class="menutitle">Publisher (HPBF)</div>
+<div id="menu_1.1.8" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/hpbf/index.html">Overview</a>
</div>
-
+<div class="menuitem">
+<a href="../components/hpbf/file-format.html">File Format</a>
</div>
-<div class="menu">
-<span class="menuLabel">Apache Wide</span>
-
-<div class="menuItem">
-<a href="https://www.apache.org/">Apache Software Foundation</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/licenses/">License</a>
+<div onclick="SwitchMenu('menu_1.1.9', '../skin/')" id="menu_1.1.9Title" class="menutitle">OLE2 Filesystem (POIFS)</div>
+<div id="menu_1.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/poifs/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+<div class="menuitem">
+<a href="../components/poifs/how-to.html">How To</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+<div class="menuitem">
+<a href="../components/poifs/embeded.html">Embedded Documents</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/security/">Security</a>
+<div class="menuitem">
+<a href="../components/poifs/fileformat.html">File System Documentation</a>
</div>
-
+<div class="menuitem">
+<a href="../components/poifs/usecases.html">Use Cases</a>
</div>
-<center>
-<a href="https://www.apache.org/events/current-event.html"><img src="https://www.apache.org/events/current-event-125x125.png"></a>
-</center>
+<div class="menuitem">
+<a href="../components/poifs/design.html">Design</a>
</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 - Component Overview</h1>
+<div onclick="SwitchMenu('menu_1.1.10', '../skin/')" id="menu_1.1.10Title" class="menutitle">OLE2 Document Props (HPSF)</div>
+<div id="menu_1.1.10" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/hpsf/index.html">Overview</a>
</div>
-<div class="h3">
-
-
+<div class="menuitem">
+<a href="../components/hpsf/how-to.html">How To</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/thumbnails.html">Thumbnails</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/internals.html">Internals</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/todo.html">To Do</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../components/hmef/index.html">TNEF (HMEF) for winmail.dat</a>
+</div>
+<div class="menuitem">
+<a href="../components/oxml4j/index.html">OpenXML4J (OOXML)</a>
+</div>
+<div class="menuitem">
+<a href="../components/logging.html">Logging framework</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+<a href="https://www.apache.org/events/current-event.html"><img border="0" title="Apache Event" alt="Apache Event - logo" src="http://www.apache.org/events/current-event-125x125.png" style="width: 125px;height: 125px;"></a>
+</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="https://donate.apache.org/"><img border="0" title="Support Apache" alt="Support Apache - logo" src="../images/support-asf.png" style="width: 125px;height: 125px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<h1>Apache POI - Component Overview</h1>
+<div id="front-matter"></div>
<a name="Apache+POI+Project+Components"></a>
-<div class="h3">
-<h3>Apache POI Project Components<a title="Permanent link" class="headerlink" href="#Apache+POI+Project+Components">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Apache POI Project Components</h2>
+<div class="section">
<p>The Apache POI project is the master project for developing pure
Java ports of file formats based on Microsoft's OLE 2 Compound
Document Format. OLE 2 Compound Document Format is used by
Microsoft Office Documents, as well as by programs using MFC
property sets to serialize their document objects.
</p>
-
<p>Apache POI is also the master project for developing pure
Java ports of file formats based on Office Open XML (ooxml).
OOXML is part of an ECMA / ISO standardisation effort. This
@@ -284,142 +305,88 @@ if (VERSION > 3) {
and is also under the
<a href="https://msdn.microsoft.com/en-us/openspecifications/default">Microsoft OSP</a>.
</p>
-
-
-
<a name="POIFS+for+OLE+2+Documents"></a>
-<div class="h4">
-<h4>POIFS for OLE 2 Documents<a title="Permanent link" class="headerlink" href="#POIFS+for+OLE+2+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">POIFS for OLE 2 Documents</h3>
<p>
POIFS is the oldest and most stable part of POI. It is our port of the OLE 2 Compound Document Format to
pure Java. It supports both read and write functionality. All of our components for the binary (non-XML)
Microsoft Office formats ultimately rely on it by
definition. Please see <a href="./poifs/index.html">the POIFS project page</a> for more information.
</p>
-
-
<a name="HSSF+and+XSSF+for+Excel+Documents"></a>
-<div class="h4">
-<h4>HSSF and XSSF for Excel Documents<a title="Permanent link" class="headerlink" href="#HSSF+and+XSSF+for+Excel+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HSSF and XSSF for Excel Documents</h3>
<p>
HSSF is our port of the Microsoft Excel 97 (-2003) file format (BIFF8) to pure
Java. XSSF is our port of the Microsoft Excel XML (2007+) file format (OOXML) to
pure Java. SS is a package that provides common support for both formats with a common API.
They both support read and write capability. Please see
- <a href="./spreadsheet/index.html">the HSSF+XSSF project page</a> for more
+ <a href="../components/spreadsheet/">the HSSF+XSSF project page</a> for more
information.
</p>
-
-
<a name="HWPF+and+XWPF+for+Word+Documents"></a>
-<div class="h4">
-<h4>HWPF and XWPF for Word Documents<a title="Permanent link" class="headerlink" href="#HWPF+and+XWPF+for+Word+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HWPF and XWPF for Word Documents</h3>
<p>
HWPF is our port of the Microsoft Word 97 (-2003) file format to pure
Java. It supports read, and limited write capabilities. It also provides
simple text extraction support for the older Word 6 and Word 95 formats.
- Please see <a href="./document/index.html">the HWPF project page for more
+ Please see <a href="../components/document/">the HWPF project page for more
information</a>. This component remains in early stages of
development. It can already read and write simple files.
</p>
-
<p>
We are also working on the XWPF for the WordprocessingML (2007+) format from the
OOXML specification. This provides read and write support for simpler
files, along with text extraction capabilities.
</p>
-
-
<a name="HSLF+and+XSLF+for+PowerPoint+Documents"></a>
-<div class="h4">
-<h4>HSLF and XSLF for PowerPoint Documents<a title="Permanent link" class="headerlink" href="#HSLF+and+XSLF+for+PowerPoint+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HSLF and XSLF for PowerPoint Documents</h3>
<p>
HSLF is our port of the Microsoft PowerPoint 97(-2003) file format to pure
- Java. It supports read and write capabilities. Please see <a href="./slideshow/index.html">the HSLF project page for more
+ Java. It supports read and write capabilities. Please see <a href="../components/slideshow/">the HSLF project page for more
information</a>.
</p>
-
<p>
We are also working on the XSLF for the PresentationML (2007+) format from the
OOXML specification.
</p>
-
-
<a name="HPSF+for+OLE+2+Document+Properties"></a>
-<div class="h4">
-<h4>HPSF for OLE 2 Document Properties<a title="Permanent link" class="headerlink" href="#HPSF+for+OLE+2+Document+Properties">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HPSF for OLE 2 Document Properties</h3>
<p>
HPSF is our port of the OLE 2 property set format to pure
Java. Property sets are mostly use to store a document's properties
(title, author, date of last modification etc.), but they can be used
for application-specific purposes as well.
</p>
-
<p>
HPSF supports both reading and writing of properties.
</p>
-
<p>
Please see <a href="./hpsf/index.html">the HPSF project
page</a> for more information.
</p>
-
-
<a name="HDGF+and+XDGF+for+Visio+Documents"></a>
-<div class="h4">
-<h4>HDGF and XDGF for Visio Documents<a title="Permanent link" class="headerlink" href="#HDGF+and+XDGF+for+Visio+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HDGF and XDGF for Visio Documents</h3>
<p>
HDGF is our port of the Microsoft Visio 97(-2003) file format to pure
Java. It currently only supports reading at a very low level, and
simple text extraction. Please see <a href="./diagram/index.html">the HDGF / Diagram project page for more
information</a>.
</p>
-
<p>
XDGF is our port of the Microsoft Visio XML (.vsdx) file format to pure
Java. It has slightly more support than HDGF. Please see <a href="./diagram/index.html">the XDGF / Diagram project page for more
information</a>.
</p>
-
-
<a name="HPBF+for+Publisher+Documents"></a>
-<div class="h4">
-<h4>HPBF for Publisher Documents<a title="Permanent link" class="headerlink" href="#HPBF+for+Publisher+Documents">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HPBF for Publisher Documents</h3>
<p>
HPBF is our port of the Microsoft Publisher 98(-2007) file format to pure
Java. It currently only supports reading at a low level for around
half of the file parts, and simple text extraction. Please see <a href="./hpbf/index.html">the HPBF project page for more
information</a>.
</p>
-
-
<a name="HMEF+for+TNEF+%28winmail.dat%29+Outlook+Attachments"></a>
-<div class="h4">
-<h4>HMEF for TNEF (winmail.dat) Outlook Attachments<a title="Permanent link" class="headerlink" href="#HMEF+for+TNEF+%28winmail.dat%29+Outlook+Attachments">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HMEF for TNEF (winmail.dat) Outlook Attachments</h3>
<p>
HMEF is our port of the Microsoft TNEF (Transport Neutral Encoding
Format) file format to pure Java. TNEF is sometimes used by Outlook
@@ -428,14 +395,8 @@ if (VERSION > 3) {
we hope to add text and attachment extraction. Please see <a href="./hmef/index.html">the HMEF project page for more
information</a>.
</p>
-
-
<a name="HSMF+for+Outlook+Messages"></a>
-<div class="h4">
-<h4>HSMF for Outlook Messages<a title="Permanent link" class="headerlink" href="#HSMF+for+Outlook+Messages">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">HSMF for Outlook Messages</h3>
<p>
HSMF is our port of the Microsoft Outlook message file format to pure
Java. It currently only some of the textual content of MSG files, and
@@ -444,29 +405,23 @@ if (VERSION > 3) {
Please see <a href="./hsmf/index.html">the HSMF project page for more
information</a>.
</p>
-
<p>
Microsoft has recently added the Outlook file format to its OSP. More information
is now available making implementing this API an easier task.
</p>
-
-
+</div>
<a name="components"></a>
-<div class="h3">
-<h3>Component Map<a title="Permanent link" class="headerlink" href="#components">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Component Map</h2>
+<div class="section">
<p>
The Apache POI distribution consists of support for many document file formats. This support is provided
in several Jar files. Not all of the Jars are needed for every format. The following tables
show the relationships between POI components, Maven repository tags, and the project's Jar files.
</p>
-
<table class="ForrestTable" cellspacing="1" cellpadding="4">
-<tr class="b">
+<tr>
<th colspan="1" rowspan="1">Component</th>
<th colspan="1" rowspan="1">Application type</th>
@@ -475,7 +430,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1"><a href="./poifs/index.html">POIFS</a></td>
<td colspan="1" rowspan="1">OLE2 Filesystem</td>
@@ -484,7 +439,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1"><a href="./hpsf/index.html">HPSF</a></td>
<td colspan="1" rowspan="1">OLE2 Property Sets</td>
@@ -493,34 +448,34 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
-<td colspan="1" rowspan="1"><a href="./spreadsheet/index.html">HSSF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/spreadsheet/">HSSF</a></td>
<td colspan="1" rowspan="1">Excel XLS</td>
<td colspan="1" rowspan="1"><em>poi</em></td>
<td colspan="1" rowspan="1">For HSSF only, if common SS is needed see below</td>
</tr>
-<tr class="b">
+<tr>
-<td colspan="1" rowspan="1"><a href="./slideshow/index.html">HSLF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/slideshow/">HSLF</a></td>
<td colspan="1" rowspan="1">PowerPoint PPT</td>
<td colspan="1" rowspan="1"><em>poi-scratchpad</em></td>
<td colspan="1" rowspan="1"> </td>
</tr>
-<tr class="a">
+<tr>
-<td colspan="1" rowspan="1"><a href="./document/index.html">HWPF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/document/">HWPF</a></td>
<td colspan="1" rowspan="1">Word DOC</td>
<td colspan="1" rowspan="1"><em>poi-scratchpad</em></td>
<td colspan="1" rowspan="1"> </td>
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1"><a href="./diagram/index.html">HDGF</a></td>
<td colspan="1" rowspan="1">Visio VSD</td>
@@ -529,7 +484,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1"><a href="./hpbf/index.html">HPBF</a></td>
<td colspan="1" rowspan="1">Publisher PUB</td>
@@ -538,7 +493,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1"><a href="./hsmf/index.html">HSMF</a></td>
<td colspan="1" rowspan="1">Outlook MSG</td>
@@ -547,7 +502,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1">DDF</td>
<td colspan="1" rowspan="1">Escher common drawings</td>
@@ -556,7 +511,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1">HWMF</td>
<td colspan="1" rowspan="1">WMF drawings</td>
@@ -565,7 +520,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1"><a href="./oxml4j/index.html">OpenXML4J</a></td>
<td colspan="1" rowspan="1">OOXML</td>
@@ -576,34 +531,34 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
-<td colspan="1" rowspan="1"><a href="./spreadsheet/index.html">XSSF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/spreadsheet/">XSSF</a></td>
<td colspan="1" rowspan="1">Excel XLSX</td>
<td colspan="1" rowspan="1"><em>poi-ooxml</em></td>
<td colspan="1" rowspan="1"> </td>
</tr>
-<tr class="a">
+<tr>
-<td colspan="1" rowspan="1"><a href="./slideshow/index.html">XSLF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/slideshow/">XSLF</a></td>
<td colspan="1" rowspan="1">PowerPoint PPTX</td>
<td colspan="1" rowspan="1"><em>poi-ooxml</em></td>
<td colspan="1" rowspan="1"> </td>
</tr>
-<tr class="b">
+<tr>
-<td colspan="1" rowspan="1"><a href="./document/index.html">XWPF</a></td>
+<td colspan="1" rowspan="1"><a href="../components/document/">XWPF</a></td>
<td colspan="1" rowspan="1">Word DOCX</td>
<td colspan="1" rowspan="1"><em>poi-ooxml</em></td>
<td colspan="1" rowspan="1"> </td>
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1"><a href="./diagram/index.html">XDGF</a></td>
<td colspan="1" rowspan="1">Visio VSDX</td>
@@ -612,7 +567,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1"><a href="./slideshow/index.html">Common SL</a></td>
<td colspan="1" rowspan="1">PowerPoint PPT and PPTX</td>
@@ -622,9 +577,9 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
-<td colspan="1" rowspan="1"><a href="./spreadsheet/index.html">Common SS</a></td>
+<td colspan="1" rowspan="1"><a href="../components/spreadsheet/">Common SS</a></td>
<td colspan="1" rowspan="1">Excel XLS and XLSX</td>
<td colspan="1" rowspan="1"><em>poi-ooxml</em></td>
<td colspan="1" rowspan="1">WorkbookFactory and friends all require poi-ooxml, not just core poi</td>
@@ -632,22 +587,17 @@ if (VERSION > 3) {
</tr>
</table>
-
-
<p>
<br>
</p>
-
-
<p>
This table maps artifacts into the jar file name. "version-yyyymmdd" is
the POI version stamp. You can see what the latest stamp is on the
- <a href="./download.html">downloads page</a>.
+ <a href="../download.html">downloads page</a>.
</p>
-
<table class="ForrestTable" cellspacing="1" cellpadding="4">
-<tr class="b">
+<tr>
<th colspan="1" rowspan="1">Maven artifactId</th>
<th colspan="1" rowspan="1">Prerequisites</th>
@@ -655,7 +605,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1">poi</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#artifactdetails|commons-logging|commons-logging|1.2|jar">commons-logging</a>,
@@ -668,7 +618,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1">poi-scratchpad</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#search|gav|1|g:org.apache.poi AND a:poi">poi</a></td>
@@ -676,7 +626,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1">poi-ooxml</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#search|gav|1|g:org.apache.poi AND a:poi">poi</a>,
@@ -686,7 +636,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1">poi-ooxml-schemas</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#artifactdetails|org.apache.xmlbeans|xmlbeans|2.6.0|jar">xmlbeans</a></td>
@@ -694,7 +644,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1">poi-examples</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#search|gav|1|g:org.apache.poi AND a:poi">poi</a>,
@@ -705,7 +655,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<td colspan="1" rowspan="1">ooxml-schemas</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#artifactdetails|org.apache.xmlbeans|xmlbeans|2.6.0|jar">xmlbeans</a></td>
@@ -713,7 +663,7 @@ if (VERSION > 3) {
</tr>
-<tr class="a">
+<tr>
<td colspan="1" rowspan="1">ooxml-security</td>
<td colspan="1" rowspan="1"><a href="https://search.maven.org/#artifactdetails|org.apache.xmlbeans|xmlbeans|2.6.0|jar">xmlbeans</a>
@@ -729,40 +679,35 @@ if (VERSION > 3) {
</tr>
</table>
-
-
<p> </p>
-
-<div class="frame note">
+<div class="note">
<div class="label">Note</div>
<div class="content">
+<!-- remove this note after 4.0.0 release, as this will be old news then -->
Apache commons-collections4 was added as a dependency in POI 3.15 beta 3.<br>
Apache commons-math3 was added as a dependency in POI 4.0.0.
</div>
</div>
-
<p>
poi-ooxml requires poi-ooxml-schemas. This is a substantially smaller
version of the ooxml-schemas jar (ooxml-schemas-1.3.jar for POI 3.14 or
later, ooxml-schemas-1.1.jar for POI 3.7 up to POI 3.13, ooxml-schemas-1.0.jar
for POI 3.5 and 3.6).
- The larger ooxml-schemas jar is <a href="faq.html#faq-N10025">normally</a>
+ The larger ooxml-schemas jar is <a href="../help/index.html#faq-N10025">normally</a>
only required for development. Similarly, the ooxml-security jar, which contains
all of the classes relating to encryption and signing, is normally only
required for development. A subset of its contents are in poi-ooxml-schemas.
This JAR is ooxml-security-1.1.jar for POI 3.14 onwards and ooxml-security-1.0.jar
prior to that.
</p>
-
<p>
The OOXML jars require a stax implementation, but now that Apache
POI requires Java 6, that dependency is provided by the JRE and no additional
stax jars are required. The OOXML jars used to require DOM4J, but
the code has now been changed to use JAXP and no additional dom4j
- jars are required. By the way, look at this <a href="faq.html#faq-N1017E">FAQ</a>
+ jars are required. By the way, look at this <a href="../help/index.html#faq-N1017E">FAQ</a>
if you have problems when using a non-Oracle JDK.
</p>
-
<p>
The ooxml schemas jars are compiled with <a href="https://xmlbeans.apache.org/">Apache XMLBeans</a> 2.3, and so
can be used at runtime with any version of XMLBeans from 2.3 or newer.
@@ -770,28 +715,20 @@ if (VERSION > 3) {
with Apache POI, and that is the version now shipped in the binary
release packages.
If you have issues with redefined classes with XMLBeans 2.6, ask
- on the <a href="mailinglists.html">developer mailing list</a> for solutions.
+ on the <a href="../help/index.html">developer mailing list</a> for solutions.
</p>
-
+</div>
<a name="Examples"></a>
-<div class="h3">
-<h3>Examples<a title="Permanent link" class="headerlink" href="#Examples">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Examples</h2>
+<div class="section">
<p>
Small sample programs using the POI API are available in the
<a href="https://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/">src/examples</a>
(<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/">viewvc</a>) directory of the source distribution.
</p>
-
<a name="POI+Browser"></a>
-<div class="h4">
-<h4>POI Browser<a title="Permanent link" class="headerlink" href="#POI+Browser">#</a>
-</h4>
-</div>
-
+<h3 class="boxed">POI Browser</h3>
<p>
The POI Browser is a very simple Swing GUI tool that displays the
internal structure of a Microsoft Office file and especially the
@@ -800,89 +737,69 @@ if (VERSION > 3) {
source code</a>
(<a href="https://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/poifs/poibrowser/POIBrowser.java">viewvc</a>).
</p>
-
-
<p>
All of the examples are included in POI distributions as a poi-examples artifact.
</p>
-
+</div>
<a name="Running+POI+on+other+JVM+languages"></a>
-<div class="h3">
-<h3>Running POI on other JVM languages<a title="Permanent link" class="headerlink" href="#Running+POI+on+other+JVM+languages">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Running POI on other JVM languages</h2>
+<div class="section">
<p>
POI can be run on most languages that run on the JVM. For code examples,
see <a href="poi-jvm-languages.html">Running POI on other JVM languages</a>
</p>
-
+</div>
<a name="Contributed+Software"></a>
-<div class="h3">
-<h3>Contributed Software<a title="Permanent link" class="headerlink" href="#Contributed+Software">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Contributed Software</h2>
+<div class="section">
<p>
Besides the "official" components outlined above there is some further
software distributed with POI. This is called "contributed" software. It
is not explicitly recommended or even maintained by the POI team, but
it might still be useful to you.
</p>
-
<p>
See <a href="poi-ruby.html">POI Ruby Bindings</a> and other code in the
<a href="http://svn.apache.org/repos/asf/poi/trunk/src/contrib/">poi-contrib module</a>
</p>
-
-
-
-
-<div id="authors" align="right">by Andrew C. Oliver, Rainer Klute, David Fisher</div>
</div>
+
+<p align="right">
+<font size="-2">by Andrew C. Oliver, Rainer Klute, David Fisher</font>
+</p>
</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </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">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
<div class="copyright">
- Copyright © 2002-2018 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>
+ Copyright ©
+ 2001-2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>
</div>
-<!--================= end Credits ==================-->
-</td>
-</tr>
-</tbody>
-</table>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/check/referer"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@poi.apache.org?subject=Feedback%C2%A0components/index.html">dev@poi.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
</div>
-<!--================= end Footer ==================-->
</body>
</html>
Copied: poi/site/publish/components/logging.html (from r1836243, poi/site/publish/logging.html)
URL: http://svn.apache.org/viewvc/poi/site/publish/components/logging.html?p2=poi/site/publish/components/logging.html&p1=poi/site/publish/logging.html&r1=1836243&r2=1836244&rev=1836244&view=diff
==============================================================================
--- poi/site/publish/logging.html (original)
+++ poi/site/publish/components/logging.html Wed Jul 18 23:27:21 2018
@@ -1,355 +1,359 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.9">
+<meta name="Forrest-skin-name" content="pelt">
<title>Apache POI - Logging Framework</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/favicon.ico">
</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="https://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="https://donate.apache.org/"><img border="0" class="logoImage" alt="Support Apache" src="resources/images/support-asf.png" width="120" height="120" title="Your donation helps The Apache Software Foundation ensure its community-driven software remains available to billions of users at absolutely no cost."></a><a href="https://poi.apache.org/"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/pb-poi.png" width="120" height="120" title="Apache POI - the Java API for Microsoft Documents"></a>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="https://www.apache.org">Apache Software Foundation</a> > <a href="https://poi.apache.org">Apache POI</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="https://www.apache.org"><img class="logoImage" alt="Apache Software Foundation" src="../images/group-logo.png" title="The Apache Software Foundation is a cornerstone of the modern Open Source software ecosystem – supporting some of the most widely used and important software solutions powering today's Internet economy."></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="https://poi.apache.org"><img class="logoImage" alt="Apache POI" src="../images/project-logo.png" title="Apache POI is well-known in the Java field as a library for reading and writing Microsoft Office file formats, such as Excel, PowerPoint, Word, Visio, Publisher and Outlook. It supports both the older (OLE2) and new (OOXML - Office Open XML) formats."></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="poi.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
</div>
-</td>
-<!--================= end Project Logo ==================-->
-</tr>
-</tbody>
-</table>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../help/index.html">Help</a>
+</li>
+<li class="current">
+<a class="selected" href="../components/index.html">Component APIs</a>
+</li>
+<li>
+<a class="unselected" href="../devel/index.html">Getting Involved</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Component APIs</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../components/index.html">Overview</a>
</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="https://www.apache.org/">Apache</a> | <a href="https://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 class="menuitem">
+<a href="../apidocs/index.html">Javadocs</a>
</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 onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">Excel (HSSF/XSSF)</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/spreadsheet/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="download.html">Download</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/quick-guide.html">Quick Guide</a>
</div>
-
-<div class="menuItem">
-<a href="overview.html">Components</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/how-to.html">HOWTO</a>
</div>
-
-<div class="menuItem">
-<a href="text-extraction.html">Text Extraction</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/converting.html">HSSF to SS Converting</a>
</div>
-
-<div class="menuItem">
-<a href="encryption.html">Encryption support</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/formula.html">Formula Support</a>
</div>
-
-<div class="menuItem">
-<a href="casestudies.html">Case Studies</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/eval.html">Formula Evaluation</a>
</div>
-
-<div class="menuItem">
-<a href="related-projects.html">Related projects</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/eval-devguide.html">Eval Dev Guide</a>
</div>
-
-<div class="menuItem">
-<a href="legal.html">Legal</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/examples.html">Examples</a>
</div>
-
+<div class="menuitem">
+<a href="../components/spreadsheet/use-case.html">Use Case</a>
</div>
-<div class="menu">
-<span class="menuLabel">Help</span>
-
-<div class="menuItem">
-<a href="apidocs/index.html">Javadocs</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/diagrams.html">Pictorial Docs</a>
</div>
-
-<div class="menuItem">
-<a href="faq.html">FAQ</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/limitations.html">Limitations</a>
</div>
-
-<div class="menuItem">
-<a href="mailinglists.html">Mailing Lists</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/user-defined-functions.html">User Defined Functions</a>
</div>
-
-<div class="menuItem">
-<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/excelant.html">ExcelAnt Tests</a>
</div>
-
-<div class="menuItem">
-<a href="changes.html">Changelog</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/hacking-hssf.html">Hacking HSSF</a>
</div>
-
+<div class="menuitem">
+<a href="../components/spreadsheet/record-generator.html">Record Generator</a>
</div>
-<div class="menu">
-<span class="menuLabel">Getting Involved</span>
-
-<div class="menuItem">
-<a href="subversion.html">Subversion Repository</a>
+<div class="menuitem">
+<a href="../components/spreadsheet/chart.html">Charts</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 onclick="SwitchMenu('menu_1.1.4', '../skin/')" id="menu_1.1.4Title" class="menutitle">PowerPoint (HSLF/XSLF)</div>
+<div id="menu_1.1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/slideshow/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="who.html">Who We Are</a>
+<div class="menuitem">
+<a href="../components/slideshow/quick-guide.html">Quick Guide</a>
</div>
-
+<div class="menuitem">
+<a href="../components/slideshow/how-to-shapes.html">HSLF Cookbook</a>
</div>
-<div class="menu">
-<span class="menuLabel">Component APIs</span>
-
-<div class="menuItem">
-<a href="spreadsheet/index.html">Excel (SS=HSSF+XSSF+SXSSF)</a>
+<div class="menuitem">
+<a href="../components/slideshow/xslf-cookbook.html">XSLF Cookbook</a>
</div>
-
-<div class="menuItem">
-<a href="slideshow/index.html">PowerPoint (SL=HSLF+XSLF)</a>
+<div class="menuitem">
+<a href="../components/slideshow/ppt-file-format.html">PPT File Format</a>
</div>
-
-<div class="menuItem">
-<a href="document/index.html">Word (WP=HWPF+XWPF)</a>
</div>
-
-<div class="menuItem">
-<a href="hsmf/index.html">Outlook (HSMF)</a>
+<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Word (HWPF/XWPF)</div>
+<div id="menu_1.1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/document/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="diagram/index.html">Visio (HDGF+XDGF)</a>
+<div class="menuitem">
+<a href="../components/document/quick-guide.html">HWPF Quick Guide</a>
</div>
-
-<div class="menuItem">
-<a href="hpbf/index.html">Publisher (HPBF)</a>
+<div class="menuitem">
+<a href="../components/document/quick-guide-xwpf.html">XWPF Quick Guide</a>
</div>
-
+<div class="menuitem">
+<a href="../components/document/docoverview.html">HWPF Format</a>
</div>
-<div class="menu">
-<span class="menuLabel">Low-level Component APIs</span>
-
-<div class="menuItem">
-<a href="poifs/index.html">OLE2 Filesystem (POIFS)</a>
+<div class="menuitem">
+<a href="../components/document/projectplan.html">HWPF Project plan</a>
</div>
-
-<div class="menuItem">
-<a href="hpsf/index.html">OLE2 Document Props (HPSF)</a>
</div>
-
-<div class="menuItem">
-<a href="hmef/index.html">TNEF (HMEF) for winmail.dat</a>
+<div class="menuitem">
+<a href="../components/hsmf/index.html">Outlook (HSMF)</a>
</div>
-
-<div class="menuItem">
-<a href="oxml4j/index.html">OpenXML4J (OOXML)</a>
+<div class="menuitem">
+<a href="../components/diagram/index.html">Visio (HDGF+XDGF)</a>
</div>
-
-<div class="menuItem">
-<span class="menuSelected">Logging framework</span>
+<div onclick="SwitchMenu('menu_1.1.8', '../skin/')" id="menu_1.1.8Title" class="menutitle">Publisher (HPBF)</div>
+<div id="menu_1.1.8" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/hpbf/index.html">Overview</a>
</div>
-
+<div class="menuitem">
+<a href="../components/hpbf/file-format.html">File Format</a>
</div>
-<div class="menu">
-<span class="menuLabel">Apache Wide</span>
-
-<div class="menuItem">
-<a href="https://www.apache.org/">Apache Software Foundation</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/licenses/">License</a>
+<div onclick="SwitchMenu('menu_1.1.9', '../skin/')" id="menu_1.1.9Title" class="menutitle">OLE2 Filesystem (POIFS)</div>
+<div id="menu_1.1.9" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/poifs/index.html">Overview</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+<div class="menuitem">
+<a href="../components/poifs/how-to.html">How To</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/foundation/thanks.html">Thanks</a>
+<div class="menuitem">
+<a href="../components/poifs/embeded.html">Embedded Documents</a>
</div>
-
-<div class="menuItem">
-<a href="https://www.apache.org/security/">Security</a>
+<div class="menuitem">
+<a href="../components/poifs/fileformat.html">File System Documentation</a>
</div>
-
+<div class="menuitem">
+<a href="../components/poifs/usecases.html">Use Cases</a>
</div>
-<center>
-<a href="https://www.apache.org/events/current-event.html"><img src="https://www.apache.org/events/current-event-125x125.png"></a>
-</center>
+<div class="menuitem">
+<a href="../components/poifs/design.html">Design</a>
</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 onclick="SwitchMenu('menu_1.1.10', '../skin/')" id="menu_1.1.10Title" class="menutitle">OLE2 Document Props (HPSF)</div>
+<div id="menu_1.1.10" class="menuitemgroup">
+<div class="menuitem">
+<a href="../components/hpsf/index.html">Overview</a>
</div>
-<div class="h3">
-
-
-
+<div class="menuitem">
+<a href="../components/hpsf/how-to.html">How To</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/thumbnails.html">Thumbnails</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/internals.html">Internals</a>
+</div>
+<div class="menuitem">
+<a href="../components/hpsf/todo.html">To Do</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../components/hmef/index.html">TNEF (HMEF) for winmail.dat</a>
+</div>
+<div class="menuitem">
+<a href="../components/oxml4j/index.html">OpenXML4J (OOXML)</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Logging framework</div>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2">
+<a href="https://donate.apache.org/"><img border="0" title="Support Apache" alt="Support Apache - logo" src="../images/support-asf.png" style="width: 125px;height: 125px;"></a>
+</div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<h1>Apache POI - Logging Framework</h1>
+<div id="front-matter"></div>
<a name="Introduction"></a>
-<div class="h3">
-<h3>Introduction<a title="Permanent link" class="headerlink" href="#Introduction">#</a>
-</h3>
-</div>
-
-
+<h2 class="boxed">Introduction</h2>
+<div class="section">
<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<a title="Permanent link" class="headerlink" href="#Enable+logging">#</a>
-</h3>
</div>
+<a name="Enable+logging"></a>
+<h2 class="boxed">Enable logging</h2>
+<div class="section">
<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>
-
+</div>
<a name="Available+logger+implementations"></a>
-<div class="h3">
-<h3>Available logger implementations<a title="Permanent link" class="headerlink" href="#Available+logger+implementations">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Available logger implementations</h2>
+<div class="section">
<p>
The following logger implementations are provided by POI:
</p>
-
<table class="ForrestTable" cellspacing="1" cellpadding="4">
-<tr class="b">
+<tr>
<th colspan="1" rowspan="1">Class</th>
<th colspan="1" rowspan="1">Type</th>
</tr>
-<tr class="a">
+<tr>
<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">
+<tr>
<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">
+<tr>
<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,
@@ -357,7 +361,7 @@ if (VERSION > 3) {
</tr>
-<tr class="b">
+<tr>
<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>
@@ -365,34 +369,26 @@ if (VERSION > 3) {
</tr>
</table>
-
+</div>
<a name="Sending+logs+to+a+different+log+framework"></a>
-<div class="h3">
-<h3>Sending logs to a different log framework<a title="Permanent link" class="headerlink" href="#Sending+logs+to+a+different+log+framework">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Sending logs to a different log framework</h2>
+<div class="section">
<p>
You can send logs to other logging frameworks by implementing the interface <em>org.apache.poi.util.POILogger</em>.
</p>
-
+</div>
<a name="Implementation+details"></a>
-<div class="h3">
-<h3>Implementation details<a title="Permanent link" class="headerlink" href="#Implementation+details">#</a>
-</h3>
-</div>
-
+<h2 class="boxed">Implementation details</h2>
+<div class="section">
<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
@@ -401,51 +397,37 @@ if (VERSION > 3) {
<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>
+
+<p align="right">
+<font size="-2">by Dominik Stadler</font>
+</p>
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </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-2018 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>
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
</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 class="copyright">
+ Copyright ©
+ 2001-2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>
</div>
-<!--================= end Credits ==================-->
-</td>
-</tr>
-</tbody>
-</table>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:dev@poi.apache.org?subject=Feedback%C2%A0components/logging.html">dev@poi.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
</div>
-<!--================= end Footer ==================-->
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org