You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ye...@apache.org on 2012/12/19 10:27:39 UTC
svn commit: r1423805 [3/18] - in /poi/site/publish: ./ hdgf/ hmef/ hpbf/
hpsf/ hsmf/ hwpf/ images/ oxml4j/ poifs/ poifs/images/ resources/
resources/images/ skin/ skin/css/ skin/images/ slideshow/ spreadsheet/
spreadsheet/images/
Propchange: poi/site/publish/changes.html
------------------------------------------------------------------------------
svn:executable = *
Added: poi/site/publish/changes.rss
URL: http://svn.apache.org/viewvc/poi/site/publish/changes.rss?rev=1423805&view=auto
==============================================================================
Binary file - no diff available.
Propchange: poi/site/publish/changes.rss
------------------------------------------------------------------------------
svn:executable = *
Propchange: poi/site/publish/changes.rss
------------------------------------------------------------------------------
svn:mime-type = application/xml
Added: poi/site/publish/download.html
URL: http://svn.apache.org/viewvc/poi/site/publish/download.html?rev=1423805&view=auto
==============================================================================
--- poi/site/publish/download.html (added)
+++ poi/site/publish/download.html Wed Dec 19 09:27:20 2012
@@ -0,0 +1,517 @@
+<!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 - Download Release Artifacts</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://poi.apache.org"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/group-logo.jpg"></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="POI" src="resources/images/project-logo.jpg"></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">
+<span class="menuSelected">Download</span>
+</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="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="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+</div>
+
+<div class="menuItem">
+<a href="changes.html">Changes Log</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="hwpf/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>
+<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="http://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 - Download Release Artifacts</h1>
+</div>
+<div class="h3">
+
+
+
+
+<a name="Available+Downloads"></a>
+<div class="h3">
+<h3>Available Downloads</h3>
+</div>
+
+<p>
+ This page provides instructions on how to download and verify the
+ Apache POI release artifacts. Apache POI is a pure Java library for
+ manipulating Microsoft Documents, for more information please see
+ <a href="index.html">the project homepage</a>.
+ </p>
+
+<ul>
+
+<li>
+<a href="download.html#POI-3.9">The latest stable release is Apache POI 3.9</a>
+</li>
+
+<li>
+<a href="download.html#archive">Archives of all prior releases</a>
+</li>
+
+</ul>
+
+<p>
+ Apache POI releases are available under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
+ See the NOTICE file contained in each release artifact for applicable copyright attribution notices.
+ </p>
+
+<p>
+ To insure that you have downloaded the true release you should <a href="download.html#verify">verify the integrity</a>
+ of the files using the signatures and checksums available from this page.
+ </p>
+
+
+
+<a name="POI-3.9"></a>
+<div class="h3">
+<h3>3 December 2012 - POI 3.9 available</h3>
+</div>
+
+<p>The Apache POI team is pleased to announce the release of 3.9.
+ This includes a large number of bug fixes and enhancements.
+ </p>
+
+<p>A full list of changes is available in the <a href="changes.html">change log</a>.
+ People interested should also follow the <a href="mailinglists.html">dev list</a> to track progress.</p>
+
+<p>
+ The POI source release as well as the pre-built binary deployment packages are listed below.
+ Pre-built versions of all <a href="index.html#components">POI components</a> are available in the central Maven repository
+ under Group ID "org.apache.poi" and Version "3.9".
+ </p>
+
+<a name="Binary+Distribution"></a>
+<div class="h4">
+<h4>Binary Distribution</h4>
+</div>
+
+<ul>
+
+<li>
+<a href="http://www.apache.org/dyn/closer.cgi/poi/release/bin/poi-bin-3.9-20121203.tar.gz">poi-bin-3.9-20121203.tar.gz</a> (
+ 16MB, <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.tar.gz.asc">signed</a>)
+ <br>
+ MD5 checksum: <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.tar.gz.md5">
+ 09c4dfd63317bb9eb37fe12d6febea74</a>
+
+<br>
+ SHA1 checksum: <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.tar.gz.sha1">
+ 5e5747efebd65623bed5b8562b30fae24f75b198</a>
+
+</li>
+
+<li>
+<a href="http://www.apache.org/dyn/closer.cgi/poi/release/bin/poi-bin-3.9-20121203.zip">poi-bin-3.9-20121203.zip</a> (
+ 23MB, <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.zip.asc">signed</a>)
+ <br>
+ MD5 checksum: <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.zip.md5">
+ 24aea12578d5745dfb8eba9d185b9136</a>
+
+<br>
+ SHA1 checksum: <a href="http://www.apache.org/dist/poi/release/bin/poi-bin-3.9-20121203.zip.sha1">
+ 231e738b40175a40c51af5549c82d554bf13f97e</a>
+
+</li>
+
+</ul>
+
+
+<a name="Source+Distribution"></a>
+<div class="h4">
+<h4>Source Distribution</h4>
+</div>
+
+<ul>
+
+<li>
+<a href="http://www.apache.org/dyn/closer.cgi/poi/release/src/poi-src-3.9-20121203.tar.gz">poi-src-3.9-20121203.tar.gz</a> (
+ 48MB, <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.tar.gz.asc">signed</a>)
+ <br>
+ MD5 checksum: <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.tar.gz.md5">
+ fe12cf4620340f61dd42e43f6087a336</a>
+
+<br>
+ SHA1 checksum: <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.tar.gz.sha1">
+ 3a8660b9c99111b72365269e23fefae5e6bdcf4b</a>
+
+</li>
+
+<li>
+<a href="http://www.apache.org/dyn/closer.cgi/poi/release/src/poi-src-3.9-20121203.zip">poi-src-3.9-20121203.zip</a> (
+ 58MB, <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.zip.asc">signed</a>)
+ <br>
+ MD5 checksum: <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.zip.md5">
+ c08d4bf7a7f63a29bedcb2b5b2d61efa</a>
+
+<br>
+ SHA1 checksum: <a href="http://www.apache.org/dist/poi/release/src/poi-src-3.9-20121203.zip.sha1">
+ 8bdb2cac1b3bfd7dd816ba574b0f20c52a8092ed</a>
+
+</li>
+
+</ul>
+
+
+
+
+<a name="verify"></a>
+<div class="h3">
+<h3>Verify</h3>
+</div>
+
+<p>
+ It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures.
+ Please read <a href="http://httpd.apache.org/dev/verification.html">Verifying Apache HTTP Server Releases</a>
+ for more information on why you should verify our releases. This page provides detailed instructions which you can use for POI artifacts.
+ </p>
+
+<p>
+ The PGP signatures can be verified using PGP or GPG. First download the KEYS file as well as the .asc signature files
+ for the relevant release packages. Make sure you get these files from the main distribution directory,
+ rather than from a mirror. Then verify the signatures using
+ </p>
+
+<pre class="code">
+% pgpk -a KEYS
+% pgpv poi-X.Y.Z.jar.asc
+ </pre>
+
+<p>or</p>
+
+<pre class="code">
+% pgp -ka KEYS
+% pgp poi-X.Y.Z.jar.asc
+ </pre>
+
+<p>or</p>
+
+<pre class="code">
+% gpg --import KEYS
+% gpg --verify poi-X.Y.Z.jar.asc
+ </pre>
+
+<p>Sample verification of poi-bin-3.5-FINAL-20090928.tar.gz</p>
+
+<pre class="code">
+% gpg --import KEYS
+gpg: key 12DAE9BE: "Glen Stampoultzis <glens at apache dot org>" not changed
+gpg: key 4CEED75F: "Nick Burch <nick at gagravarr dot org>" not changed
+gpg: key 84B5A42E: "Rainer Klute <rainer.klute at gmx dot de>" not changed
+gpg: key F5BB52CD: "Yegor Kozlov <yegor.kozlov at gmail dot com>" not changed
+gpg: Total number processed: 4
+gpg: unchanged: 4
+% gpg --verify poi-bin-3.5-FINAL-20090928.tar.gz.asc
+gpg: Signature made Mon Sep 28 10:28:25 2009 PDT using DSA key ID F5BB52CD
+gpg: Good signature from "Yegor Kozlov <yegor.kozlov at gmail dot com>"
+gpg: aka "Yegor Kozlov <yegor at dinom dot ru>"
+gpg: aka "Yegor Kozlov <yegor at apache dot org>"
+Primary key fingerprint: 7D77 0C77 6CE7 754E E6AF 23AA 6934 0A02 F5BB 52CD
+% gpg --fingerprint F5BB52CD
+pub 1024D/F5BB52CD 2007-06-18 [expires: 2012-06-16]
+ Key fingerprint = 7D77 0C77 6CE7 754E E6AF 23AA 6934 0A02 F5BB 52CD
+uid Yegor Kozlov <yegor.kozlov at gmail dot com>
+uid Yegor Kozlov <yegor at dinom dot ru>
+uid Yegor Kozlov <yegor at apache dot org>
+sub 4096g/7B45A98A 2007-06-18 [expires: 2012-06-16]
+ </pre>
+
+
+<a name="archive"></a>
+<div class="h3">
+<h3>Release Archives</h3>
+</div>
+
+<p>
+ Apache POI became a top level project in June 2007 and POI 3.0 aritfacts were re-released.
+ Prior to that date POI was a sub-project of <a href="http://jakarta.apache.org/">Apache Jakarta.</a>
+
+</p>
+
+<ul>
+
+<li>
+<a href="http://archive.apache.org/dist/poi/release/bin/">Binary Artifacts</a>
+</li>
+
+<li>
+<a href="http://archive.apache.org/dist/poi/release/src/">Source Artifacts</a>
+</li>
+
+<li>
+<a href="http://archive.apache.org/dist/poi/">Keys</a>
+</li>
+
+<li>
+<a href="http://archive.apache.org/dist/jakarta/poi/release/">Artifacts from prior to 3.0</a>
+</li>
+
+</ul>
+
+
+
+
+</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-2012 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.
+ </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>
Propchange: poi/site/publish/download.html
------------------------------------------------------------------------------
svn:executable = *
Added: poi/site/publish/encryption.html
URL: http://svn.apache.org/viewvc/poi/site/publish/encryption.html?rev=1423805&view=auto
==============================================================================
--- poi/site/publish/encryption.html (added)
+++ poi/site/publish/encryption.html Wed Dec 19 09:27:20 2012
@@ -0,0 +1,360 @@
+<!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 - Encryption support</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://poi.apache.org"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/group-logo.jpg"></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="POI" src="resources/images/project-logo.jpg"></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">
+<span class="menuSelected">Encryption support</span>
+</div>
+
+<div class="menuItem">
+<a href="casestudies.html">Case Studies</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="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+</div>
+
+<div class="menuItem">
+<a href="changes.html">Changes Log</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="hwpf/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>
+<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="http://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 - Encryption support</h1>
+</div>
+<div class="h3">
+
+
+
+
+<a name="Overview"></a>
+<div class="h3">
+<h3>Overview</h3>
+</div>
+
+<p>Apache POI contains support for reading few variants of encrypted office files: </p>
+
+<ul>
+
+<li>XLS - RC4 Encryption</li>
+
+<li>XML-based formats (XLSX, DOCX and etc) - AES and Agile Encryption</li>
+
+</ul>
+
+
+<p>Some "write-protected" files are encrypted with build-in password, POI can read that files too.</p>
+
+
+
+<a name="XLS"></a>
+<div class="h3">
+<h3>XLS</h3>
+</div>
+
+<p>When HSSF receive encrypted file, it tries to decode it with MSOffice build-in password.
+ Use static method setCurrentUserPassword(String password) of org.apache.poi.hssf.record.crypto.Biff8EncryptionKey to
+ set password. It sets thread local variable. Do not forget to reset it to null after text extraction.
+ </p>
+
+
+
+<a name="XML-based+formats"></a>
+<div class="h3">
+<h3>XML-based formats</h3>
+</div>
+
+<p>XML-based formats are stored in OLE-package stream "EncryptedPackage". Use org.apache.poi.poifs.crypt.Decryptor
+ to decode file:</p>
+
+
+<pre class="code">
+EncryptionInfo info = new EncryptionInfo(filesystem);
+Decryptor d = Decryptor.getInstance(info);
+
+try {
+ if (!d.verifyPassword(password)) {
+ throw new RuntimeException("Unable to process: document is encrypted");
+ }
+
+ InputStream dataStream = d.getDataStream(filesystem);
+
+ // parse dataStream
+
+} catch (GeneralSecurityException ex) {
+ throw new RuntimeException("Unable to process encrypted document", ex);
+}
+ </pre>
+
+
+<p>If you want to read file encrypted with build-in password, use Decryptor.DEFAULT_PASSWORD.</p>
+
+
+
+
+
+<div id="authors" align="right">by Maxim Valyanskiy</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-2012 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.
+ </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>
Propchange: poi/site/publish/encryption.html
------------------------------------------------------------------------------
svn:executable = *
Added: poi/site/publish/faq.html
URL: http://svn.apache.org/viewvc/poi/site/publish/faq.html?rev=1423805&view=auto
==============================================================================
--- poi/site/publish/faq.html (added)
+++ poi/site/publish/faq.html Wed Dec 19 09:27:20 2012
@@ -0,0 +1,751 @@
+<!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>Frequently Asked Questions</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://poi.apache.org"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/group-logo.jpg"></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="POI" src="resources/images/project-logo.jpg"></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="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">
+<span class="menuSelected">FAQ</span>
+</div>
+
+<div class="menuItem">
+<a href="mailinglists.html">Mailing Lists</a>
+</div>
+
+<div class="menuItem">
+<a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+</div>
+
+<div class="menuItem">
+<a href="changes.html">Changes Log</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="hwpf/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>
+<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="http://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>Frequently Asked Questions</h1>
+</div>
+<div class="h3">
+<a name="Questions"></a>
+<div class="h3">
+<h3>Questions</h3>
+</div>
+<ol>
+<li>
+<a name="faq-N10006-menu"></a><a href="#faq-N10006">
+ My code uses some new feature, compiles fine but fails when live with a "MethodNotFoundException" or "IncompatibleClassChangeError"
+ </a>
+</li>
+<li>
+<a name="faq-N10019-menu"></a><a href="#faq-N10019">
+ My code uses the scratchpad, compiles fine but fails to run with a "MethodNotFoundException"
+ </a>
+</li>
+<li>
+<a name="faq-N10025-menu"></a><a href="#faq-N10025">
+ I'm using the poi-ooxml-schemas jar, but my code is failing with "java.lang.NoClassDefFoundError: org/openxmlformats/schemas/*something*"
+ </a>
+</li>
+<li>
+<a name="faq-N1005A-menu"></a><a href="#faq-N1005A">
+ Why is reading a simple sheet taking so long?
+ </a>
+</li>
+<li>
+<a name="faq-N10066-menu"></a><a href="#faq-N10066">
+ What is the HSSF "eventmodel"?
+ </a>
+</li>
+<li>
+<a name="faq-N10072-menu"></a><a href="#faq-N10072">
+ Why can't read the document I created using Star Office 5.1?
+ </a>
+</li>
+<li>
+<a name="faq-N1007E-menu"></a><a href="#faq-N1007E">
+ Why am I getting an exception each time I attempt to read my spreadsheet?
+ </a>
+</li>
+<li>
+<a name="faq-N1008D-menu"></a><a href="#faq-N1008D">
+ How do you tell if a spreadsheet cell contains a date?
+ </a>
+</li>
+<li>
+<a name="faq-N1009D-menu"></a><a href="#faq-N1009D">
+ I'm trying to stream an XLS file from a servlet and I'm having some trouble. What's the problem?
+ </a>
+</li>
+<li>
+<a name="faq-N100C7-menu"></a><a href="#faq-N100C7">
+ I want to set a cell format (Data format of a cell) of a excel sheet as ###,###,###.#### or ###,###,###.0000. Is it possible using POI ?
+ </a>
+</li>
+<li>
+<a name="faq-N100D7-menu"></a><a href="#faq-N100D7">
+ I want to set a cell format (Data format of a cell) of a excel sheet as text. Is it possible using POI ?
+ </a>
+</li>
+<li>
+<a name="faq-N100E3-menu"></a><a href="#faq-N100E3">
+ How do I add a border around a merged cell?
+ </a>
+</li>
+<li>
+<a name="faq-N100EF-menu"></a><a href="#faq-N100EF">
+ I am using styles when creating a workbook in POI, but Excel refuses to open the file, complaining about "Too Many Styles".
+ </a>
+</li>
+<li>
+<a name="faq-N10109-menu"></a><a href="#faq-N10109">
+ An OLE2 ("binary") file is giving me problems, but I can't share it. How can I investigate the problem on my own?
+ </a>
+</li>
+<li>
+<a name="faq-N10123-menu"></a><a href="#faq-N10123">
+ An OOXML ("xml") file is giving me problems, but I can't share it. How can I investigate the problem on my own?
+ </a>
+</li>
+</ol>
+<a name="Answers"></a>
+<div class="h3">
+<h3>Answers</h3>
+</div>
+<a name="faq-N10006"></a>
+<div class="h4">
+<h4>1.
+ My code uses some new feature, compiles fine but fails when live with a "MethodNotFoundException" or "IncompatibleClassChangeError"
+ </h4>
+</div>
+
+<p>You almost certainly have an older version of POI
+ on your classpath. Quite a few runtimes and other packages
+ will ship an older version of POI, so this is an easy problem
+ to hit without your realising.</p>
+
+<p>The best way to identify the offending earlier jar file is
+ with a few lines of java. These will load one of the core POI
+ classes, and report where it came from.</p>
+
+<pre class="code">
+ClassLoader classloader =
+ org.apache.poi.poifs.filesystem.POIFSFileSystem.class.getClassLoader();
+URL res = classloader.getResource(
+ "org/apache/poi/poifs/filesystem/POIFSFileSystem.class");
+String path = res.getPath();
+System.out.println("Core POI came from " + path);
+ </pre>
+
+<a name="faq-N10019"></a>
+<div class="h4">
+<h4>2.
+ My code uses the scratchpad, compiles fine but fails to run with a "MethodNotFoundException"
+ </h4>
+</div>
+
+<p>You almost certainly have an older version earlier on your
+ classpath. See the prior answer.</p>
+
+<a name="faq-N10025"></a>
+<div class="h4">
+<h4>3.
+ I'm using the poi-ooxml-schemas jar, but my code is failing with "java.lang.NoClassDefFoundError: org/openxmlformats/schemas/*something*"
+ </h4>
+</div>
+
+<p>To use the new OOXML file formats, POI requires a jar containing
+ the file format XSDs, as compiled by
+ <a href="http://xmlbeans.apache.org/">XMLBeans</a>. These
+ XSDs, once compiled into Java classes, live in the
+ <em>org.openxmlformats.schemas</em> namespace.</p>
+
+<p>There are two jar files available, as described in
+ <a href="/overview.html">the components overview section</a>.
+ The <em>full jar of all of the schemas is ooxml-schemas-1.1.jar</em>,
+ and it is currently around 15mb. The <em>smaller poi-ooxml-schemas
+ jar</em> is only about 4mb. This latter jar file only contains the
+ typically used parts though.</p>
+
+<p>Many users choose to use the smaller poi-ooxml-schemas jar to save
+ space. However, the poi-ooxml-schemas jar only contains the XSDs and
+ classes that are typically used, as identified by the unit tests.
+ Every so often, you may try to use part of the file format which
+ isn't included in the minimal poi-ooxml-schemas jar. In this case,
+ you should switch to the full ooxml-schemas-1.1.jar. Longer term,
+ you may also wish to submit a new unit test which uses the extra
+ parts of the XSDs, so that a future poi-ooxml-schemas jar will
+ include them.</p>
+
+<p>There are a number of ways to get the full ooxml-schemas-1.1.jar.
+ If you are a maven user, see the
+ <a href="/overview.html">the components overview section</a>
+ for the artifact details to have maven download it for you.
+ If you download the source release of POI, and/or checkout the
+ source code from <a href="/subversion.html">subversion</a>,
+ then you can run the ant task "compile-ooxml-xsds" to have the
+ OOXML schemas downloaded and compiled for you (This will also
+ give you the XMLBeans generated source code, in case you wish to
+ look at this). Finally, you can download the jar by hand from the
+ <a href="http://www.ibiblio.org/maven/org.apache.poi/jars/">POI
+ Maven Repository</a>.</p>
+
+<p>Note that for POI 3.5 and 3.6, the full ooxml schemas jar was
+ named ooxml-schemas-1.0.jar. For POI 3.7, the filename was bumped
+ to ooxml-schemas-1.1.jar when generics support was added. You can
+ use ooxml-schemas-1.1.jar with POI 3.5 and 3.6 if you wish, but
+ POI 3.7 won't wokr with ooxml-schemas-1.0.jar (it needs thew newer
+ one).</p>
+
+<a name="faq-N1005A"></a>
+<div class="h4">
+<h4>4.
+ Why is reading a simple sheet taking so long?
+ </h4>
+</div>
+
+<p>You've probably enabled logging. Logging is intended only for
+ autopsy style debugging. Having it enabled will reduce performance
+ by a factor of at least 100. Logging is helpful for understanding
+ why POI can't read some file or developing POI itself. Important
+ errors are thrown as exceptions, which means you probably don't need
+ logging.</p>
+
+<a name="faq-N10066"></a>
+<div class="h4">
+<h4>5.
+ What is the HSSF "eventmodel"?
+ </h4>
+</div>
+
+<p>The SS eventmodel package is an API for reading Excel files without loading the whole spreadsheet into memory. It does
+ require more knowledge on the part of the user, but reduces memory consumption by more than
+ tenfold. It is based on the AWT event model in combination with SAX. If you need read-only
+ access, this is the best way to do it.</p>
+
+<a name="faq-N10072"></a>
+<div class="h4">
+<h4>6.
+ Why can't read the document I created using Star Office 5.1?
+ </h4>
+</div>
+
+<p>Star Office 5.1 writes some records using the older BIFF standard. This causes some problems
+ with POI which supports only BIFF8.</p>
+
+<a name="faq-N1007E"></a>
+<div class="h4">
+<h4>7.
+ Why am I getting an exception each time I attempt to read my spreadsheet?
+ </h4>
+</div>
+
+<p>It's possible your spreadsheet contains a feature that is not currently supported by POI.
+ If you encounter this then please create the simplest file that demonstrates the trouble and submit it to
+ <a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bugzilla.</a>
+</p>
+
+<a name="faq-N1008D"></a>
+<div class="h4">
+<h4>8.
+ How do you tell if a spreadsheet cell contains a date?
+ </h4>
+</div>
+
+<p>Excel stores dates as numbers therefore the only way to determine if a cell is
+ actually stored as a date is to look at the formatting. There is a helper method
+ in HSSFDateUtil that checks for this.
+ Thanks to Jason Hoffman for providing the solution.</p>
+
+<pre class="code">
+ case HSSFCell.CELL_TYPE_NUMERIC:
+ double d = cell.getNumericCellValue();
+ // test if a date!
+ if (HSSFDateUtil.isCellDateFormatted(cell)) {
+ // format in form of M/D/YY
+ cal.setTime(HSSFDateUtil.getJavaDate(d));
+ cellText =
+ (String.valueOf(cal.get(Calendar.YEAR))).substring(2);
+ cellText = cal.get(Calendar.MONTH)+1 + "/" +
+ cal.get(Calendar.DAY_OF_MONTH) + "/" +
+ cellText;
+ }
+ </pre>
+
+<a name="faq-N1009D"></a>
+<div class="h4">
+<h4>9.
+ I'm trying to stream an XLS file from a servlet and I'm having some trouble. What's the problem?
+ </h4>
+</div>
+
+<p>
+ The problem usually manifests itself as the junk characters being shown on
+ screen. The problem persists even though you have set the correct mime type.
+ </p>
+
+<p>
+ The short answer is, don't depend on IE to display a binary file type properly if you stream it via a
+ servlet. Every minor version of IE has different bugs on this issue.
+ </p>
+
+<p>
+ The problem in most versions of IE is that it does not use the mime type on
+ the HTTP response to determine the file type; rather it uses the file extension
+ on the request. Thus you might want to add a
+ <strong>.xls</strong> to your request
+ string. For example
+ <em>http://yourserver.com/myServelet.xls?param1=xx</em>. This is
+ easily accomplished through URL mapping in any servlet container. Sometimes
+ a request like
+ <em>http://yourserver.com/myServelet?param1=xx&dummy=file.xls</em> is also
+ known to work.
+ </p>
+
+<p>
+ To guarantee opening the file properly in Excel from IE, write out your file to a
+ temporary file under your web root from your servelet. Then send an http response
+ to the browser to do a client side redirection to your temp file. (Note that using a
+ server side redirect using RequestDispatcher will not be effective in this case)
+ </p>
+
+<p>
+ Note also that when you request a document that is opened with an
+ external handler, IE sometimes makes two requests to the webserver. So if your
+ generating process is heavy, it makes sense to write out to a temporary file, so that multiple
+ requests happen for a static file.
+ </p>
+
+<p>
+ None of this is particular to Excel. The same problem arises when you try to
+ generate any binary file dynamically to an IE client. For example, if you generate
+ pdf files using
+ <a href="http://xml.apache.org/fop">FOP</a>, you will come across many of the same issues.
+ </p>
+
+
+<a name="faq-N100C7"></a>
+<div class="h4">
+<h4>10.
+ I want to set a cell format (Data format of a cell) of a excel sheet as ###,###,###.#### or ###,###,###.0000. Is it possible using POI ?
+ </h4>
+</div>
+
+<p>
+ Yes. You first need to get a DataFormat object from the workbook and call getFormat with the desired format. Some examples are <a href="spreadsheet/quick-guide.html#DataFormats">here</a>.
+ </p>
+
+<a name="faq-N100D7"></a>
+<div class="h4">
+<h4>11.
+ I want to set a cell format (Data format of a cell) of a excel sheet as text. Is it possible using POI ?
+ </h4>
+</div>
+
+<p>
+ Yes. This is a built-in format for excel that you can get from DataFormat object using the format string "@". Also, the string "text" will alias this format.
+ </p>
+
+<a name="faq-N100E3"></a>
+<div class="h4">
+<h4>12.
+ How do I add a border around a merged cell?
+ </h4>
+</div>
+
+<p>Add blank cells around where the cells normally would have been and set the borders individually for each cell.
+ We will probably enhance HSSF in the future to make this process easier.</p>
+
+<a name="faq-N100EF"></a>
+<div class="h4">
+<h4>13.
+ I am using styles when creating a workbook in POI, but Excel refuses to open the file, complaining about "Too Many Styles".
+ </h4>
+</div>
+
+<p>You just create the styles OUTSIDE of the loop in which you create cells.</p>
+
+<p>GOOD:</p>
+
+<pre class="code">
+ HSSFWorkbook wb = new HSSFWorkbook();
+ HSSFSheet sheet = wb.createSheet("new sheet");
+ HSSFRow row = null;
+
+ // Aqua background
+ HSSFCellStyle style = wb.createCellStyle();
+ style.setFillBackgroundColor(HSSFColor.AQUA.index);
+ style.setFillPattern(HSSFCellStyle.BIG_SPOTS);
+ HSSFCell cell = row.createCell((short) 1);
+ cell.setCellValue("X");
+ cell.setCellStyle(style);
+
+ // Orange "foreground",
+ // foreground being the fill foreground not the font color.
+ style = wb.createCellStyle();
+ style.setFillForegroundColor(HSSFColor.ORANGE.index);
+ style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
+
+ for (int x = 0; x < 1000; x++) {
+
+ // Create a row and put some cells in it. Rows are 0 based.
+ row = sheet.createRow((short) k);
+
+ for (int y = 0; y < 100; y++) {
+ cell = row.createCell((short) k);
+ cell.setCellValue("X");
+ cell.setCellStyle(style);
+ }
+ }
+
+ // Write the output to a file
+ FileOutputStream fileOut = new FileOutputStream("workbook.xls");
+ wb.write(fileOut);
+ fileOut.close();
+ </pre>
+
+<p>BAD:</p>
+
+<pre class="code">
+ HSSFWorkbook wb = new HSSFWorkbook();
+ HSSFSheet sheet = wb.createSheet("new sheet");
+ HSSFRow row = null;
+
+ for (int x = 0; x < 1000; x++) {
+ // Aqua background
+ HSSFCellStyle style = wb.createCellStyle();
+ style.setFillBackgroundColor(HSSFColor.AQUA.index);
+ style.setFillPattern(HSSFCellStyle.BIG_SPOTS);
+ HSSFCell cell = row.createCell((short) 1);
+ cell.setCellValue("X");
+ cell.setCellStyle(style);
+
+ // Orange "foreground",
+ // foreground being the fill foreground not the font color.
+ style = wb.createCellStyle();
+ style.setFillForegroundColor(HSSFColor.ORANGE.index);
+ style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
+
+ // Create a row and put some cells in it. Rows are 0 based.
+ row = sheet.createRow((short) k);
+
+ for (int y = 0; y < 100; y++) {
+ cell = row.createCell((short) k);
+ cell.setCellValue("X");
+ cell.setCellStyle(style);
+ }
+ }
+
+ // Write the output to a file
+ FileOutputStream fileOut = new FileOutputStream("workbook.xls");
+ wb.write(fileOut);
+ fileOut.close();
+ </pre>
+
+<a name="faq-N10109"></a>
+<div class="h4">
+<h4>14.
+ An OLE2 ("binary") file is giving me problems, but I can't share it. How can I investigate the problem on my own?
+ </h4>
+</div>
+
+<p>The first thing to try is running the
+ <a href="http://blogs.msdn.com/b/officeinteroperability/archive/2011/07/12/microsoft-office-binary-file-format-validator-is-now-available.aspx">Binary File Format Validator</a>
+ from Microsoft against the file, which will report if the file
+ complies with the specification. If your input file doesn't, then this
+ may well explain why POI isn't able to process it correctly. You
+ should probably in this case speak to whoever is generating the file,
+ and have them fix it there. If your POI generated file is identified
+ as having an issue, and you're on the
+ <a href="/howtobuild.html">latest codebase</a>, report a new
+ POI bug and include the details of the validation failure.</p>
+
+<p>Another thing to try, especially if the file is valid but POI isn't
+ behaving as expected, are the POI Dev Tools for the component you're
+ using. For example, HSSF has <em>org.apache.poi.hssf.dev.BiffViewer</em>
+ which will allow you to view the file as POI does. This will often
+ allow you to check that things are being read as you expect, and
+ narrow in on problem records and structures.</p>
+
+<a name="faq-N10123"></a>
+<div class="h4">
+<h4>15.
+ An OOXML ("xml") file is giving me problems, but I can't share it. How can I investigate the problem on my own?
+ </h4>
+</div>
+
+<p>There's not currently a simple validator tool as there is for the
+ OLE2 based (binary) file formats, but checking the basics of a file
+ is generally much easier.</p>
+
+<p>Files such as .xlsx, .docx and .pptx are actually a zip file of XML
+ files, with a special structure. Your first step in diagnosing the
+ issues with the input or output file will likely be to unzip the
+ file, and look at the XML of it. Newer versions of Office will
+ normally tell you which area of the file is problematic, so
+ narrow in on there. Looking at the XML, does it look correct?</p>
+
+<p>When reporting bugs, ideally include the whole file, but if you're
+ unable to then include the snippet of XML for the problem area, and
+ reference the OOXML standard for what it should contain.</p>
+
+</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-2012 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.
+ </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>
Propchange: poi/site/publish/faq.html
------------------------------------------------------------------------------
svn:executable = *
Added: poi/site/publish/guidelines.html
URL: http://svn.apache.org/viewvc/poi/site/publish/guidelines.html?rev=1423805&view=auto
==============================================================================
--- poi/site/publish/guidelines.html (added)
+++ poi/site/publish/guidelines.html Wed Dec 19 09:27:20 2012
@@ -0,0 +1,636 @@
+<!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 - Contribution Guidelines</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://poi.apache.org"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/group-logo.jpg"></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="POI" src="resources/images/project-logo.jpg"></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="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="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
+</div>
+
+<div class="menuItem">
+<a href="changes.html">Changes Log</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">
+<span class="menuSelected">Contribution Guidelines</span>
+</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="hwpf/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>
+<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="http://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 - Contribution Guidelines</h1>
+</div>
+<div class="h3">
+
+
+
+
+
+<a name="Introduction"></a>
+<div class="h3">
+<h3>Introduction</h3>
+</div>
+
+<a name="Disclaimer"></a>
+<div class="h4">
+<h4>Disclaimer</h4>
+</div>
+
+<p>
+ Any information in here that might be perceived as legal information is
+ informational only. We're not lawyers, so consult a legal professional
+ if needed.
+ </p>
+
+
+<a name="The+Licensing"></a>
+<div class="h4">
+<h4>The Licensing</h4>
+</div>
+
+<p>
+ The POI project is <a href="http://www.opensource.org">OpenSource</a>
+ and developed/distributed under the <a href="http://www.apache.org/foundation/license-faq.html">
+ Apache Software License</a>. Unlike other licenses this license allows
+ free open source development; however, it does not require you to release
+ your source or use any particular license for your source. If you wish
+ to contribute to POI (which you're very welcome and encouraged to do so)
+ then you must agree to release the rights of your source to us under this
+ license.
+ </p>
+
+
+<a name="Publicly+Available+Information+on+the+file+formats"></a>
+<div class="h4">
+<h4>Publicly Available Information on the file formats</h4>
+</div>
+
+<p>
+ In early 2008, Microsoft made a fairly complete set of documentation
+ on the binary file formats freely and publicly available. These were
+ released under the <a href="http://www.microsoft.com/interop/osp">Open
+ Specification Promise</a>, which does allow us to use them for
+ building open source software under the <a href="http://www.apache.org/foundation/license-FAQ.html">
+ Apache Software License</a>.
+ </p>
+
+<p>
+ You can download the documentation on Excel, Word, PowerPoint and
+ Escher (drawing) from
+ <a href="http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx">http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx</a>.
+ Documentation on a few of the supporting technologies used in these
+ file formats can be downloaded from
+ <a href="http://www.microsoft.com/interop/docs/supportingtechnologies.mspx">http://www.microsoft.com/interop/docs/supportingtechnologies.mspx</a>.
+ </p>
+
+<p>
+ Previously, Microsoft published a book on the Excel 97 file format.
+ It can still be of plenty of use, and is handy dead tree form. Pick up
+ a copy of "Excel 97 Developer's Kit" from your favourite second hand
+ book store.
+ </p>
+
+<p>
+ The newer Office Open XML (ooxml) file formats are documented as part
+ of the ECMA / ISO standardisation effort for the formats. This
+ documentation is quite large, but you can normally find the bit you
+ need without too much effort! This can be downloaded from
+ <a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a>,
+ and is also under the <a href="http://www.microsoft.com/interop/osp">OSP</a>.
+ </p>
+
+<p>
+ It is also worth checking the documentation and code of the other
+ open source implementations of the file formats.
+ </p>
+
+
+<a name="I+just+signed+an+NDA+to+get+a+spec+from+Microsoft+and+I%27d+like+to+contribute"></a>
+<div class="h4">
+<h4>I just signed an NDA to get a spec from Microsoft and I'd like to contribute</h4>
+</div>
+
+<p>
+ In short, stay away, stay far far away. Implementing these file formats
+ in POI is done strictly by using public information. Most of this Public
+ Information currently comes from the documentation that Microsoft
+ makes freely available (see above). The rest of the public information
+ includes sources from other open source projects, books that state the
+ purpose intended is for allowing implementation of the file format and
+ do not require any non-disclosure agreement and just hard work.
+ We are intent on keeping it legal, by contributing patches you agree to
+ do the same.
+ </p>
+
+<p>
+ If you've ever received information regarding the OLE 2 Compound Document
+ Format under any type of exclusionary agreement from Microsoft, or
+ received such information from a person bound by such an agreement, you
+ cannot participate in this project. Sorry. Well, unless you can persuade
+ Microsoft to release you from the terms of the NDA on the grounds that
+ most of the information is now publically available. However, if you have
+ been party to a Microsoft NDA, you will need to get clearance from Microsoft
+ before contributing.
+ </p>
+
+<p>
+ Those submitting patches that show insight into the file format may be
+ asked to state explicitly that they have only ever read the publicly
+ available file format information, and not any received under an NDA
+ or similar, and have only made us of the public documentation.
+ </p>
+
+
+
+<a name="I+just+want+to+get+involved+but+don%27t+know+where+to+start"></a>
+<div class="h3">
+<h3>I just want to get involved but don't know where to start</h3>
+</div>
+
+<ul>
+
+<li>Read the rest of the website, understand what POI is and what it does,
+ the project vision, etc.</li>
+
+<li>Use POI a bit, look for gaps in the documentation and examples.</li>
+
+<li>Join the <a href="mailinglists.html">mailing lists</a> and share your knowledge with others.</li>
+
+<li>Get <a href="subversion.html">Subversion</a> and check out the POI source tree</li>
+
+<li>Documentation is always the best place to start contributing, maybe you found that if the documentation just told you how to do X then it would make more sense, modify the documentation.</li>
+
+<li>Contribute examples - if there's something people are often asking about on the <a href="mailinglists.html">user list</a> which isn't covered in the documentation or current examples, try writing an example of this and uploading it as a patch.</li>
+
+<li>Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.</li>
+
+<li>Write Unit Tests. Great way to understand POI. Look for classes that aren't tested, or aren't tested on a public/protected method level, start there.</li>
+
+<li>Download the file format documentation from Microsoft -
+ <a href="http://www.microsoft.com/interop/docs/OfficeBinaryFormats.mspx">OLE2 Binary File Formats</a> or
+ <a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">OOXML XML File Formats</a>
+</li>
+
+<li>Submit patches (see below) of your contributions, modifications.</li>
+
+<li>Check the <a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">bug database</a> for simple problem reports, and write a patch to fix the problem</li>
+
+<li>Review existing patches in the <a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">bug database</a>, and report if they still apply, if they need unit tests atc.</li>
+
+<li>Take a look at all the <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI;bug_status=NEW;bug_status=NEEDINFO">unresolved issues in the bug database</a>, and see if you can help with testing or patches for them</li>
+
+<li>Add in new features, see <a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</a> for suggestions.</li>
+
+</ul>
+
+
+<p>The Apache <a href="http://www.apache.org/dev/contributors.html">Contributors Tech Guide</a> gives a good overview how to start contributing patches.</p>
+
+
+<p>The Nutch project also have a very useful guide on becoming a
+ new developer in their project. While it is written for their project,
+ a large part of it will apply to POI too. You can read it at
+ <a href="http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer">http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</a>. The
+ <a href="http://community.apache.org/">Apache Community Development
+ Project</a> also provides guidance and mentoring for new contributors.</p>
+
+
+<a name="Submitting+Patches"></a>
+<div class="h3">
+<h3>Submitting Patches</h3>
+</div>
+
+<p>
+ Patches are submitted via the <a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>.
+ Create a new bug, set the subject to [PATCH] followed by a brief description. Explain you patch and any special instructions and submit/save it.
+ Next, go back to the bug, and create attachements for the patch files you
+ created. Be sure to describe not only the files purpose, but its format.
+ (Is that ZIP or a tgz or a bz2 or what?).
+ </p>
+
+<p>
+ Ideally, patches should be submitted early and often. This is for
+ two key reasons. Firstly, it's much easier to review smaller patches
+ than large ones. This means that smaller patches are much more likely
+ to be applied to SVN in a timely fashion. Secondly, by sending in your
+ patches earlier rather than later, it's much easier to get feedback
+ on your coding and direction. If you've missed an easier way to do something,
+ or are duplicating some (probably hidden) existing code, or taking things
+ in an unusual direction, it's best to get the feedback sooner rather than
+ later! As such, when submitting patches to POI, as with other Apache
+ Software Foundation projects, do please try to submit early and often, rather
+ than "throwing a large patch over the wall" at the end.
+ </p>
+
+<p>You may create your patch file using either of the following approaches (the committers recommend the first):</p>
+
+<a name="Approach+1+-+use+Ant"></a>
+<div class="h4">
+<h4>Approach 1 - use Ant</h4>
+</div>
+
+<p>Use Ant to generate a patch file to POI: </p>
+
+<pre class="code">
+ ant -f patch.xml
+ </pre>
+
+<p>
+ This will create a file named patch.tar.gz that will contain a unified diff of files that have been modified
+ and also include files that have been added. Review the file for completeness and correctness. This approach
+ is recommended because it standardizes the way in which patch files are constructed. It also eliminates the
+ chance of you missing to submit new files that constitute part of the patch.
+ </p>
+
+
+<a name="Approach+2+-+the+manual+way"></a>
+<div class="h4">
+<h4>Approach 2 - the manual way</h4>
+</div>
+
+<p>
+ Patches to existing files should be generated with svn diff filename and save the output to a file.
+ if you want to get the changes made to multiple files in a directory , just use svn diff.
+ then, tar and gzip the patch file as well as any new files that you have added.
+ </p>
+
+<p>If you use a unix shell, you may find the following following
+ sequence of commands useful for building the files to attach.</p>
+
+<pre class="code">
+ # run this in the root of the checkout, i.e. the directory holding
+ # build.xml and poi.pom
+
+ # build the directory to hold new files
+ mkdir /tmp/poi-patch/
+ mkdir /tmp/poi-patch/new-files/
+
+ # get changes to existing files
+ svn diff > /tmp/poi-patch/diff.txt
+
+ # capture any new files, as svn diff won't include them
+ # preserve the path
+ svn status | grep "^\?" | awk '{printf "cp --parents %s /tmp/poi-patch/new-files/\n", $2 }' | sh -s
+
+ # tar up the new files
+ cd /tmp/poi-patch/new-files/
+ tar jcvf ../new-files.tar.bz2
+ cd ..
+
+ # upload these to bugzilla
+ echo "please upload to bugzilla:"
+ echo " /tmp/poi-patch/diff.txt"
+ echo " /tmp/poi-patch/new-files.tar.bz2"
+ </pre>
+
+
+<a name="checklist+before+submitting+a+patch"></a>
+<div class="h4">
+<h4>checklist before submitting a patch</h4>
+</div>
+
+<ul>
+
+<li>added code complies with <a href="http://poi.apache.org/resolutions/res001.html">coding standards</a>
+</li>
+
+<li>added code compiles and runs on java 1.5</li>
+
+<li>new java files begin with the <a href="http://www.apache.org/foundation/license-faq.html">
+ apache software license</a> statement.</li>
+
+<li>the code does not depend on gpl or lgpl code.</li>
+
+<li>the code includes the @author tag on any files you've altered or created.</li>
+
+<li>existing test cases succeed.</li>
+
+<li>new test cases written and succeed.</li>
+
+<li>documentation page extended as appropriate.</li>
+
+<li>diff files generated using svn diff</li>
+
+<li>message to dev contains [patch], task name and patch reason in subject.</li>
+
+<li>message body contains a rationale for the patch.</li>
+
+<li>message attachment contains the patch file(s).</li>
+
+</ul>
+
+
+
+
+<a name="Mentoring+and+Committership"></a>
+<div class="h3">
+<h3>Mentoring and Committership</h3>
+</div>
+
+<p>The POI project will generally offer committership to contributors who send
+ in consistently good patches over a period of several months.</p>
+
+<p>The requirement for "good patches" generally means patches which can be applied
+ to SVN with little or no changes. These patches should include unit test, and
+ appropriate documentation. Whilst your first patch to POI may require quite a
+ bit of work before it can be committed by an existing committer, with any luck
+ your later patches will be applied with no / minor tweaks. Please do take note
+ of any changes required by your earlier patches, to learn for later ones! If
+ in doubt, ask on the <a href="mailinglists.html">dev mailing list</a>.</p>
+
+<p>The requirement for patches over several months is to ensure that committers
+ remain with the project. It's very easy for a good developer to fire off half
+ a dozen good patches in the couple of weeks that they're working on a POI
+ powered project. However, if that developer then moves away, and stops
+ contributing to POI after that spurt, then they're not a good candidate for
+ committership. As such, we generally require people to stay around for a while,
+ submitting patches and helping on the mailing list before considering them
+ for committership.</p>
+
+<p>Where possible, patches should be submitted early and often. For more details
+ on this, please see the "Submitting Patches" section above.</p>
+
+
+<p>Where possible, the existing developers will try to help and mentor new
+ contributors. However, everyone involved in POI is a volunteer, and it may
+ happen that your first few patches come in at a time when all the committers
+ are very busy. Do please have patience, and remember to use the
+ <a href="mailinglists.html">dev mailing list</a> so that other
+ contributors can assist you!</p>
+
+<p>For more information on getting started at Apache, mentoring, and local
+ Apache Committers near you who can offer advice, please see the
+ <a href="http://community.apache.org/">Apache Community Development
+ Project</a> website.</p>
+
+
+
+
+
+<div id="authors" align="right">by Nick Burch, David Fisher</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-2012 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.
+ </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>
Propchange: poi/site/publish/guidelines.html
------------------------------------------------------------------------------
svn:executable = *
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org