Copied: poi/site/publish/devel/guidelines.html (from r1836243, poi/site/publish/guidelines.html) URL: http://svn.apache.org/viewvc/poi/site/publish/devel/guidelines.html?p2=poi/site/publish/devel/guidelines.html&p1=poi/site/publish/guidelines.html&r1=1836243&r2=1836244&rev=1836244&view=diff ============================================================================== --- poi/site/publish/guidelines.html (original) +++ poi/site/publish/devel/guidelines.html Wed Jul 18 23:27:21 2018 @@ -1,275 +1,188 @@ -<!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 - Contribution Guidelines</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> -</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="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> -<!--================= end Tabs ==================--> -</td> -</tr> -</tbody> -</table> -<!--================= end Status ==================--> -<table id="main" width="100%" cellpadding="8" cellspacing="0" summary="" border="0"> -<tbody> -<tr valign="top"> -<!--================= start Menu ==================--> -<td id="leftcol"> -<div id="navcolumn"> -<div class="menuBar"> -<div class="menu"> -<span class="menuLabel">Overview</span> - -<div class="menuItem"> -<a href="index.html">Home</a> -</div> - -<div class="menuItem"> -<a href="download.html">Download</a> -</div> - -<div class="menuItem"> -<a href="overview.html">Components</a> -</div> - -<div class="menuItem"> -<a href="text-extraction.html">Text Extraction</a> -</div> - -<div class="menuItem"> -<a href="encryption.html">Encryption support</a> -</div> - -<div class="menuItem"> -<a href="casestudies.html">Case Studies</a> -</div> - -<div class="menuItem"> -<a href="related-projects.html">Related projects</a> -</div> - -<div class="menuItem"> -<a href="legal.html">Legal</a> -</div> - -</div> -<div class="menu"> -<span class="menuLabel">Help</span> - -<div class="menuItem"> -<a href="apidocs/index.html">Javadocs</a> -</div> - -<div class="menuItem"> -<a href="faq.html">FAQ</a> -</div> - -<div class="menuItem"> -<a href="mailinglists.html">Mailing Lists</a> -</div> - -<div class="menuItem"> -<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI";>Bug Database</a> -</div> - -<div class="menuItem"> -<a href="changes.html">Changelog</a> -</div> - -</div> -<div class="menu"> -<span class="menuLabel">Getting Involved</span> - -<div class="menuItem"> -<a href="subversion.html">Subversion Repository</a> -</div> - -<div class="menuItem"> -<a href="howtobuild.html">How To Build</a> -</div> - -<div class="menuItem"> -<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+SXSSF)</a> -</div> - -<div class="menuItem"> -<a href="slideshow/index.html">PowerPoint (SL=HSLF+XSLF)</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> - -<div class="menuItem"> -<a href="diagram/index.html">Visio (HDGF+XDGF)</a> -</div> - -<div class="menuItem"> -<a href="hpbf/index.html">Publisher (HPBF)</a> -</div> - -</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> - -<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> - -<div class="menuItem"> -<a href="oxml4j/index.html">OpenXML4J (OOXML)</a> -</div> - -<div class="menuItem"> -<a href="logging.html">Logging framework</a> -</div> - -</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> - -<div class="menuItem"> -<a href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> -</div> - -<div class="menuItem"> -<a href="https://www.apache.org/foundation/thanks.html";>Thanks</a> -</div> - -<div class="menuItem"> -<a href="https://www.apache.org/security/";>Security</a> -</div> - -</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> -</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> +<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> -</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"> - - - +<!--+ + |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> +<a class="unselected" href="../components/index.html">Component APIs</a> +</li> +<li class="current"> +<a class="selected" 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');">Getting Involved</div> +<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> +<div class="menuitem"> +<a href="../devel/index.html">How To Build</a> +</div> +<div class="menuitem"> +<a href="../devel/subversion.html">Subversion Repository</a> +</div> +<div class="menupage"> +<div class="menupagetitle">Contribution Guidelines</div> +</div> +<div class="menuitem"> +<a href="../devel/who.html">Who We Are</a> +</div> +<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Planning Documents</div> +<div id="menu_1.1.5" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/plan/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/plan/vision10.html">1.0 Vision</a> +</div> +<div class="menuitem"> +<a href="../devel/plan/vision20.html">2.0 Vision</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.6', '../skin/')" id="menu_1.1.6Title" class="menutitle">References</div> +<div id="menu_1.1.6" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/references/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/references/logocontest.html">Logo Submissions</a> +</div> +<div class="menuitem"> +<a href="http://sc.openoffice.org/excelfileformat.pdf";>XLS spec [PDF]</a> +</div> +<div class="menuitem"> +<a href="http://xml.apache.org/cocoon/";>Apache Cocoon</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.7', '../skin/')" id="menu_1.1.7Title" class="menutitle">Resolutions</div> +<div id="menu_1.1.7" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/resolutions/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/resolutions/res001.html">Minimal Coding Standards</a> +</div> +</div> +<div class="menuitem"> +<a href="../devel/historyandfuture.html">History</a> +</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 - Contribution Guidelines</h1> +<div id="front-matter"></div> <a name="Index+of+Contribution+Guidelines"></a> -<div class="h3"> -<h3>Index of Contribution Guidelines<a title="Permanent link" class="headerlink" href="#Index+of+Contribution+Guidelines">#</a> -</h3> -</div> - +<h2 class="boxed">Index of Contribution Guidelines</h2> +<div class="section"> <ul> <li> @@ -301,37 +214,22 @@ if (VERSION > 3) { </li> </ul> - - - -<a name="Introduction"></a> - <a name="Introduction-N10047"></a> -<div class="h3"> -<h3>Introduction<a title="Permanent link" class="headerlink" href="#Introduction-N10047">#</a> -</h3> </div> - + +<a name="Introduction" id="Introduction"></a> + <a name="Introduction-N10048"></a> +<h2 class="boxed">Introduction</h2> +<div class="section"> <a name="Disclaimer"></a> -<div class="h4"> -<h4>Disclaimer<a title="Permanent link" class="headerlink" href="#Disclaimer">#</a> -</h4> -</div> - +<h3 class="boxed">Disclaimer</h3> <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<a title="Permanent link" class="headerlink" href="#The+Licensing">#</a> -</h4> -</div> - +<h3 class="boxed">The Licensing</h3> <p> The POI project is <a href="http://www.opensource.org";>OpenSource</a> and developed/distributed under the <a href="https://www.apache.org/foundation/license-faq.html";> @@ -344,37 +242,30 @@ if (VERSION > 3) { contribute to Apache POI (which you're very welcome and encouraged to do so), then you must agree to grant your contributions to us under the same license. </p> - - +</div> -<a name="WhereHelpNeeded"></a> +<a name="WhereHelpNeeded" id="WhereHelpNeeded"></a> <a name="Where+is+help+needed+on+the+project%3F"></a> -<div class="h3"> -<h3>Where is help needed on the project?<a title="Permanent link" class="headerlink" href="#Where+is+help+needed+on+the+project%3F">#</a> -</h3> +<h2 class="boxed">Where is help needed on the project?</h2> +<div class="section"> +<div description="the Apache POI Project" project="poi" style="width: 80%;" type="helpwanted"> +<em>To view the <a href="https://helpwanted.apache.org/";>"Help Wanted" + </a> tasks, an internet connection is required. + </em> </div> - -<div description="the Apache POI Project" project="poi" type="helpwanted" style="width: 80%;"> -<em>To view the <a href="https://helpwanted.apache.org/";>"Help - Wanted"</a> tasks, an internet connection is required.</em> -</div> -<script type="text/javascript" src="https://helpwanted.apache.org/widget.js";></script> - +<script src="https://helpwanted.apache.org/widget.js"; type="text/javascript"></script> <p>Please note - only some of the areas where help is needed have been listed in the <a href="https://helpwanted.apache.org/";>Apache "Help Wanted!" tool</a>, many others remain only in Bugzilla or listed as TODOs in the code. Please see the section below for more on these.</p> - +</div> -<a name="GetInvolved"></a> +<a name="GetInvolved" id="GetInvolved"></a> <a name="I+just+want+to+get+involved%2C+but+don%27t+know+where+to+start%3F"></a> -<div class="h3"> -<h3>I just want to get involved, but don't know where to start?<a title="Permanent link" class="headerlink" href="#I+just+want+to+get+involved%2C+but+don%27t+know+where+to+start%3F">#</a> -</h3> -</div> - +<h2 class="boxed">I just want to get involved, but don't know where to start?</h2> +<div class="section"> <ul> <li>View the <a href="#WhereHelpNeeded">Apache "Help Wanted" tasks</a> listed @@ -385,13 +276,13 @@ if (VERSION > 3) { <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>Join the <a href="../help/index.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>Get <a href="../devel/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>Contribute examples - if there's something people are often asking about on the <a href="../help/index.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> @@ -414,27 +305,20 @@ if (VERSION > 3) { <li>Add in new features, see <a href="https://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 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="https://wiki.apache.org/nutch/Becoming_A_Nutch_Developer";>http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</a>. The <a href="https://community.apache.org/";>Apache Community Development Project</a> also provides guidance and mentoring for new contributors.</p> - +</div> -<a name="SubmittingPatches"></a> +<a name="SubmittingPatches" id="SubmittingPatches"></a> <a name="Submitting+Patches"></a> -<div class="h3"> -<h3>Submitting Patches<a title="Permanent link" class="headerlink" href="#Submitting+Patches">#</a> -</h3> -</div> - +<h2 class="boxed">Submitting Patches</h2> +<div class="section"> <p> Patches are submitted via the <a href="https://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. @@ -443,7 +327,6 @@ if (VERSION > 3) { 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 @@ -457,7 +340,6 @@ if (VERSION > 3) { 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> A number of Apache projects provide far more comprehensive guides to producing and submitting patches than we do, you may wish to review some of their @@ -465,53 +347,35 @@ if (VERSION > 3) { <a href="https://commons.apache.org/patches.html";>Apache Commons</a> one is fairly similar as a starting point. </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<a title="Permanent link" class="headerlink" href="#Approach+1+-+use+Ant">#</a> -</h4> -</div> - +<h3 class="boxed">Approach 1 - use Ant</h3> <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 <span class="codefrag">patch.tar.gz</span> 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> - <p> To apply a previously generated <span class="codefrag">patch.tar.gz</span> file to a clean subversion checkout, use the following command. It will unpack the tarball and add new files to the subversion working copy. </p> - <pre class="code"> ant -f patch.xml apply </pre> - - <a name="Approach+2+-+the+manual+way"></a> -<div class="h4"> -<h4>Approach 2 - the manual way<a title="Permanent link" class="headerlink" href="#Approach+2+-+the+manual+way">#</a> -</h4> -</div> - +<h3 class="boxed">Approach 2 - the manual way</h3> <p> Patches to existing files should be generated with <span class="codefrag">svn diff filename</span> and save the output to a file. If you want to get the changes made to multiple files in a directory, just use <span class="codefrag">svn diff</span>. 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 @@ -537,35 +401,26 @@ if (VERSION > 3) { echo " /tmp/poi-patch/diff.txt" echo " /tmp/poi-patch/new-files.tar.bz2" </pre> - - <a name="Approach+3+-+the+git+way"></a> -<div class="h4"> -<h4>Approach 3 - the git way<a title="Permanent link" class="headerlink" href="#Approach+3+-+the+git+way">#</a> -</h4> -</div> - +<h3 class="boxed">Approach 3 - the git way</h3> <p> If you are working on a Git clone of Apache POI (see the - <a href="subversion.html">Version Control page</a> for + <a href="../devel/subversion.html">Version Control page</a> for more on the read-only Git mirrors), it is possible to generate a patch of your changes (including new binary files) using Git. </p> - <p> For new developers, we'd normally suggest using Subversion and one of the methods above, as they tend to be simpler. For people who are already proficient with Git, then generating a patch from Git can be an easy way to contribute! </p> - <p> When generating a patch / patch set from Git, for many related and small changes a squashed patch is probably best, as it makes the (manual) review quicker. For larger changes, several distinct patches are probably best. </p> - <p> If you intend to do a noticeable amount of work enhancing Apache POI on your own Git repo, we would suggest sending in patches early and @@ -575,14 +430,8 @@ if (VERSION > 3) { needs re-doing... Git's offline workflow makes this easier, so try not to fall into that trap! </p> - - <a name="checklist+before+submitting+a+patch"></a> -<div class="h4"> -<h4>checklist before submitting a patch<a title="Permanent link" class="headerlink" href="#checklist+before+submitting+a+patch">#</a> -</h4> -</div> - +<h3 class="boxed">checklist before submitting a patch</h3> <ul> <li>Added code complies with <a href="#CodeStyle">coding standards</a>.</li> @@ -616,63 +465,50 @@ if (VERSION > 3) { <li>Attachment to the bugzilla entry contains the patch file.</li> -</ul> - - +</ul> +</div> -<a name="CodeStyle"></a> +<a name="CodeStyle" id="CodeStyle"></a> <a name="Code+Style"></a> -<div class="h3"> -<h3>Code Style<a title="Permanent link" class="headerlink" href="#Code+Style">#</a> -</h3> -</div> - +<h2 class="boxed">Code Style</h2> +<div class="section"> <p>The long standing - <a href="resolutions/res001.html">Minimal + <a href="../devel/resolutions/res001.html">Minimal Coding Standards</a> from 2002 still largely apply to the project.</p> - <p>When making changes to an existing file, please try to follow the same style that that file already uses. This will keep things looking similar, and will prevent patches becoming largely about whitespace. Whitespace fixing changes, if needed, should normally be in their own commit, so that they don't crowd out coding changes in review.</p> - <p>Normally, tabs should not be used to indent code. Instead, spaces should be used. If starting on a fresh file, please use 4 spaces to indent your code. If working on an existing file, please use whichever of 3 or 4 spaces that file already follows.</p> - <p>Normally, braces should open on the same line as the decision statement. Braces should normally close on their own line. Brackets should normally have a space before them when they are the first.</p> - <p>Lines normally shouldn't be too long. There's no hard and fast rule, but if you line is getting above about 90 characters think about splitting it, and you should rarely create something over about 100 characters without a very good reason!</p> - +</div> -<a name="Mentoring"></a> +<a name="Mentoring" id="Mentoring"></a> <a name="Mentoring+and+Committership"></a> -<div class="h3"> -<h3>Mentoring and Committership<a title="Permanent link" class="headerlink" href="#Mentoring+and+Committership">#</a> -</h3> -</div> - +<h2 class="boxed">Mentoring and Committership</h2> +<div class="section"> <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> - + in doubt, ask on the <a href="../help/index.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 @@ -681,38 +517,27 @@ if (VERSION > 3) { 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 + <a href="../help/index.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> -<a name="FileFormatInformation"></a> +<a name="FileFormatInformation" id="FileFormatInformation"></a> <a name="File+Format+Information"></a> -<div class="h3"> -<h3>File Format Information<a title="Permanent link" class="headerlink" href="#File+Format+Information">#</a> -</h3> -</div> - +<h2 class="boxed">File Format Information</h2> +<div class="section"> <a name="Publicly+Available+Information+on+the+file+formats"></a> -<div class="h4"> -<h4>Publicly Available Information on the file formats<a title="Permanent link" class="headerlink" href="#Publicly+Available+Information+on+the+file+formats">#</a> -</h4> -</div> - +<h3 class="boxed">Publicly Available Information on the file formats</h3> <p> In early 2008, Microsoft made a fairly complete set of documentation on the binary file formats freely and publicly available. These were @@ -721,7 +546,6 @@ if (VERSION > 3) { building open source software under the <a href="https://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 @@ -730,7 +554,6 @@ if (VERSION > 3) { file formats can be downloaded from <a href="https://msdn.microsoft.com/en-us/library/jj633110.aspx";>http://msdn.microsoft.com/en-us/library/jj633110.aspx</a>. </p> - <p> For the VSDX format (implemented in Apache POI as XDGF), an <a href="https://msdn.microsoft.com/en-us/library/office/jj228622.aspx";>introduction @@ -739,14 +562,12 @@ if (VERSION > 3) { and <a href="https://msdn.microsoft.com/en-us/library/hh645006(v=office.12).aspx">here</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 @@ -756,26 +577,18 @@ if (VERSION > 3) { and is also under the <a href="https://msdn.microsoft.com/en-us/openspecifications/default";>OSP</a>. </p> - <p> Additionally for the newer Office Open XML (ooxml) file formats, you can find some good introductary documentation (often clearer for getting started with) at <a href="http://officeopenxml.com/";>officeopenxml.com</a>, which is an independent site documenting the file formats. </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<a title="Permanent link" class="headerlink" href="#I+just+signed+an+NDA+to+get+a+spec+from+Microsoft+and+I%27d+like+to+contribute">#</a> -</h4> -</div> - +<h3 class="boxed">I just signed an NDA to get a spec from Microsoft and I'd like to contribute</h3> <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 @@ -787,7 +600,6 @@ if (VERSION > 3) { 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 @@ -798,60 +610,44 @@ if (VERSION > 3) { 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> - - - - +</div> -<div id="authors" align="right">by Nick Burch, David Fisher</div> -</div> -</div> +<p align="right"> +<font size="-2">by Nick Burch, 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> -</div> -<!--================= end Credits ==================--> -</td> -</tr> -</tbody> -</table> + Copyright © + 2001-2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a> +</div> +<div id="feedback"> + Send feedback about the website to: + <a id="feedbackto" href="mailto:[email protected]?subject=Feedback%C2%A0devel/guidelines.html";>[email protected]</a> +</div> +<!--+ + |end bottomstrip + +--> </div> -<!--================= end Footer ==================--> </body> </html>
Added: poi/site/publish/devel/historyandfuture.html URL: http://svn.apache.org/viewvc/poi/site/publish/devel/historyandfuture.html?rev=1836244&view=auto ============================================================================== --- poi/site/publish/devel/historyandfuture.html (added) +++ poi/site/publish/devel/historyandfuture.html Wed Jul 18 23:27:21 2018 @@ -0,0 +1,325 @@ +<!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"> +<meta content="Apache Forrest" name="Generator"> +<meta name="Forrest-version" content="0.9"> +<meta name="Forrest-skin-name" content="pelt"> +<title>Apache POI - Project History</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 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> +<!--+ + |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> +<a class="unselected" href="../components/index.html">Component APIs</a> +</li> +<li class="current"> +<a class="selected" 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');">Getting Involved</div> +<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> +<div class="menuitem"> +<a href="../devel/index.html">How To Build</a> +</div> +<div class="menuitem"> +<a href="../devel/subversion.html">Subversion Repository</a> +</div> +<div class="menuitem"> +<a href="../devel/guidelines.html">Contribution Guidelines</a> +</div> +<div class="menuitem"> +<a href="../devel/who.html">Who We Are</a> +</div> +<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Planning Documents</div> +<div id="menu_1.1.5" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/plan/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/plan/vision10.html">1.0 Vision</a> +</div> +<div class="menuitem"> +<a href="../devel/plan/vision20.html">2.0 Vision</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.6', '../skin/')" id="menu_1.1.6Title" class="menutitle">References</div> +<div id="menu_1.1.6" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/references/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/references/logocontest.html">Logo Submissions</a> +</div> +<div class="menuitem"> +<a href="http://sc.openoffice.org/excelfileformat.pdf";>XLS spec [PDF]</a> +</div> +<div class="menuitem"> +<a href="http://xml.apache.org/cocoon/";>Apache Cocoon</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.7', '../skin/')" id="menu_1.1.7Title" class="menutitle">Resolutions</div> +<div id="menu_1.1.7" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/resolutions/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../devel/resolutions/res001.html">Minimal Coding Standards</a> +</div> +</div> +<div class="menupage"> +<div class="menupagetitle">History</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 - Project History</h1> +<div id="front-matter"></div> + + + +<a name="Apache+POI+-+Brief+Project+History"></a> +<h2 class="boxed">Apache POI - Brief Project History</h2> +<div class="section"> +<p>The POI project was dreamed up back around April 2001, when + Andrew Oliver landed a short term contract to do Java-based + reporting to Excel. He'd done this project a few times before + and knew right where to look for the tools he needed. + Ironically, the API he used to use had skyrocketed from around + $300 ($US) to around $10K ($US). He figured it would take two + people around six months to write an Excel port so he + recommended the client fork out the $10K. + </p> +<p>Around June 2001, Andrew started thinking how great it would + be to have an open source Java tool to do this and, while he + had some spare time, he started on the project and learned + about OLE 2 Compound Document Format. After hitting some real + stumpers he realized he'd need help. He posted a message to + his local Java User's Group (JUG) and asked if anyone else + would be interested. He lucked out and the most talented Java + programmer he'd ever met, Marc Johnson, joined the project. He + ran rings around Andrew at porting OLE 2 CDF and rewrote his + skeletal code into a more sophisticated library. It took Marc + a few iterations to get something they were happy with. + </p> +<p>While Marc worked on that, Andrew ported XLS to Java, based + on Marc's library. Several users wrote in asking to read XLS + (not just write as had originally been planned) and one user + had special requests for a different use for POIFS. Before + long, the project scope had tripled. POI 1.0 was released a + month later than planned, but with far more features. Marc + quickly wrote the serializer framework and HSSF Serializer in + record time and Andrew banged out more documentation and worked + on making people aware of the project + </p> +<p> Shortly before the release, POI was fortunate to come into + contact with Nicola -Ken- Barrozzi who gave them samples for + the HSSF Serializer and help uncover its unfortunate bugs + (which were promptly fixed). More recently, Ken ported most + of the POI project documentation to XML from Andrew's crappy + HTML docs he wrote with Star Office. + </p> +<p> Around the same time as the release, Glen Stampoultzis +joined the project. Glen was ticked off at Andrew's flippant attitude +towards adding graphing to HSSF. Glen got so ticked off he decided to +grab a hammer and do it himself. Glen has already become an integral +part of the POI development community; his contributions to HSSF have +already started making waves. + </p> +<p>Somewhere in there we decided to finally submit the project + to <a href="https://cocoon.apache.org/";>The Apache + Cocoon Project</a>, only to discover the project had + outgrown fitting nicely into just Cocoon long ago. + Furthermore, Andrew started eyeing other projects he'd like to + see POI functionality added to. So it was decided to donate + the Serializers and Generators to Cocoon, other POI + integration components to other projects, and the POI APIs + would become part of Jakarta. It was a bumpy road but it + looks like everything turned out since you're reading this! + </p> +<p>In Early 2007, we graduated from + <a href="https://jakarta.apache.org/";>Jakarta</a>, and became + our own Top Level Project (TLP) within Apache.</p> +</div> + +<!-- + <section><title>What's next for Poi</title> + <p>First we'll tackle this from a project standpoint: Well, we + made an offer to Microsoft and Actuate (tongue in cheek + ... well mostly) that we'd quit the project and retire if + they'd simply write us each a really large check. I've yet to + get a phone call or email so I'm assuming they're not going to + pay us to go away. + </p> + <p>Next, we've got some work to do here at Jakarta to finish + integrating POI into the community. Furthermore, we're + still transitioning the Serializer to Cocoon. + </p> + <p>HSSF, during the 2.0 cycle, will undergo a few + optimizations. We'll also be adding new features like a full + implementation of Formulas and custom text formats. We're + hoping to be able to generate smaller files by adding + write-support for RK, MulRK and MulBlank records. I'm also + going to work on a Cocoon 2 Generator. Currently, reading is + not very efficient in HSSF. This is mainly because in order to + write or modify, one needs to be able to update upstream + pointers to downstream data. To do this you have to have + everything between in memory. A Generator would allow SAX + events to be processed instead. (This will be based on the low + level structures). One of the great things about this is that, + you'll not only have a more efficient way to read the file, + you'll have a great way to use spreadsheets as XML data + sources. + </p> + <p>The HSSF Serializer, will further separate into a general + framework for creating serializers for other formats and the + HSSF Serializer specific implementation. (This is largely + already true). We'll also be adding support for features + already supported by HSSF (styles, fonts, text formats). We're + hoping to add support for formulas during this cycle. + </p> + <p>We're beginning to expand our scope yet again. If we could + do all of this for XLS files, what about Doc files or PowerPoint + files? We're thinking that our next component (HWPF - Manipulates + Word Processor Format) should follow the same pattern. We're hoping + that new blood will join the team and allow us to tackle this + even faster (in part because POIFS is already finished). But + maybe what we need most is you! </p> + </section> --> + + +<p align="right"> +<font size="-2">by Andrew C. Oliver</font> +</p> +</div> +<!--+ + |end content + +--> +<div class="clearboth"> </div> +</div> +<div id="footer"> +<!--+ + |start bottomstrip + +--> +<div class="lastmodified"> +<script type="text/javascript"><!-- +document.write("Last Published: " + document.lastModified); +// --></script> +</div> +<div class="copyright"> + Copyright © + 2001-2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a> +</div> +<div id="feedback"> + Send feedback about the website to: + <a id="feedbackto" href="mailto:[email protected]?subject=Feedback%C2%A0devel/historyandfuture.html";>[email protected]</a> +</div> +<!--+ + |end bottomstrip + +--> +</div> +</body> +</html> Copied: poi/site/publish/devel/index.html (from r1836243, poi/site/publish/howtobuild.html) URL: http://svn.apache.org/viewvc/poi/site/publish/devel/index.html?p2=poi/site/publish/devel/index.html&p1=poi/site/publish/howtobuild.html&r1=1836243&r2=1836244&rev=1836244&view=diff ============================================================================== --- poi/site/publish/howtobuild.html (original) +++ poi/site/publish/devel/index.html Wed Jul 18 23:27:21 2018 @@ -1,356 +1,253 @@ -<!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 - How To Build</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> -</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="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> -<!--================= end Tabs ==================--> -</td> -</tr> -</tbody> -</table> -<!--================= end Status ==================--> -<table id="main" width="100%" cellpadding="8" cellspacing="0" summary="" border="0"> -<tbody> -<tr valign="top"> -<!--================= start Menu ==================--> -<td id="leftcol"> -<div id="navcolumn"> -<div class="menuBar"> -<div class="menu"> -<span class="menuLabel">Overview</span> - -<div class="menuItem"> -<a href="index.html">Home</a> -</div> - -<div class="menuItem"> -<a href="download.html">Download</a> -</div> - -<div class="menuItem"> -<a href="overview.html">Components</a> -</div> - -<div class="menuItem"> -<a href="text-extraction.html">Text Extraction</a> -</div> - -<div class="menuItem"> -<a href="encryption.html">Encryption support</a> -</div> - -<div class="menuItem"> -<a href="casestudies.html">Case Studies</a> -</div> - -<div class="menuItem"> -<a href="related-projects.html">Related projects</a> -</div> - -<div class="menuItem"> -<a href="legal.html">Legal</a> -</div> - -</div> -<div class="menu"> -<span class="menuLabel">Help</span> - -<div class="menuItem"> -<a href="apidocs/index.html">Javadocs</a> -</div> - -<div class="menuItem"> -<a href="faq.html">FAQ</a> -</div> - -<div class="menuItem"> -<a href="mailinglists.html">Mailing Lists</a> -</div> - -<div class="menuItem"> -<a href="https://bz.apache.org/bugzilla/buglist.cgi?product=POI";>Bug Database</a> -</div> - -<div class="menuItem"> -<a href="changes.html">Changelog</a> -</div> - +<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> -<div class="menu"> -<span class="menuLabel">Getting Involved</span> - -<div class="menuItem"> -<a href="subversion.html">Subversion Repository</a> +<!--+ + |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> +<a class="unselected" href="../components/index.html">Component APIs</a> +</li> +<li class="current"> +<a class="selected" 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');">Getting Involved</div> +<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> +<div class="menupage"> +<div class="menupagetitle">How To Build</div> </div> - -<div class="menuItem"> -<span class="menuSelected">How To Build</span> +<div class="menuitem"> +<a href="../devel/subversion.html">Subversion Repository</a> </div> - -<div class="menuItem"> -<a href="guidelines.html">Contribution Guidelines</a> +<div class="menuitem"> +<a href="../devel/guidelines.html">Contribution Guidelines</a> </div> - -<div class="menuItem"> -<a href="who.html">Who We Are</a> +<div class="menuitem"> +<a href="../devel/who.html">Who We Are</a> </div> - +<div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Planning Documents</div> +<div id="menu_1.1.5" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/plan/index.html">Overview</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="../devel/plan/vision10.html">1.0 Vision</a> </div> - -<div class="menuItem"> -<a href="slideshow/index.html">PowerPoint (SL=HSLF+XSLF)</a> +<div class="menuitem"> +<a href="../devel/plan/vision20.html">2.0 Vision</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.6', '../skin/')" id="menu_1.1.6Title" class="menutitle">References</div> +<div id="menu_1.1.6" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/references/index.html">Overview</a> </div> - -<div class="menuItem"> -<a href="diagram/index.html">Visio (HDGF+XDGF)</a> +<div class="menuitem"> +<a href="../devel/references/logocontest.html">Logo Submissions</a> </div> - -<div class="menuItem"> -<a href="hpbf/index.html">Publisher (HPBF)</a> +<div class="menuitem"> +<a href="http://sc.openoffice.org/excelfileformat.pdf";>XLS spec [PDF]</a> </div> - +<div class="menuitem"> +<a href="http://xml.apache.org/cocoon/";>Apache Cocoon</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> - -<div class="menuItem"> -<a href="hpsf/index.html">OLE2 Document Props (HPSF)</a> +<div onclick="SwitchMenu('menu_1.1.7', '../skin/')" id="menu_1.1.7Title" class="menutitle">Resolutions</div> +<div id="menu_1.1.7" class="menuitemgroup"> +<div class="menuitem"> +<a href="../devel/resolutions/index.html">Overview</a> </div> - -<div class="menuItem"> -<a href="hmef/index.html">TNEF (HMEF) for winmail.dat</a> +<div class="menuitem"> +<a href="../devel/resolutions/res001.html">Minimal Coding Standards</a> </div> - -<div class="menuItem"> -<a href="oxml4j/index.html">OpenXML4J (OOXML)</a> </div> - -<div class="menuItem"> -<a href="logging.html">Logging framework</a> +<div class="menuitem"> +<a href="../devel/historyandfuture.html">History</a> </div> - -</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> - -<div class="menuItem"> -<a href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a> -</div> - -<div class="menuItem"> -<a href="https://www.apache.org/foundation/thanks.html";>Thanks</a> </div> - -<div class="menuItem"> -<a href="https://www.apache.org/security/";>Security</a> -</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> -<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 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> -<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"> +<!--+ + |end Menu + +--> +<!--+ + |start content + +--> +<div id="content"> <h1>Apache POI - How To Build</h1> -</div> -<div class="h3"> - - +<div id="front-matter"></div> <a name="JDK+Version"></a> -<div class="h3"> -<h3>JDK Version<a title="Permanent link" class="headerlink" href="#JDK+Version">#</a> -</h3> -</div> - - +<h2 class="boxed">JDK Version</h2> +<div class="section"> <p> POI 4.0 and later require JDK version 1.8 or later. </p> - <p> POI 3.11 and later 3.x versions require JDK version 1.6 or later. </p> - <p> POI 3.5 to 3.10 required the JDK version 1.5 or later. Versions prior to 3.5 required JDK 1.4+. </p> - +</div> <a name="Install+Apache+Ant"></a> -<div class="h3"> -<h3>Install Apache Ant<a title="Permanent link" class="headerlink" href="#Install+Apache+Ant">#</a> -</h3> -</div> - - +<h2 class="boxed">Install Apache Ant</h2> +<div class="section"> <p> The POI build system requires <a href="https://ant.apache.org/";>Apache Ant</a> version 1.8 - 1.9.x for Java 1.6 and higher. Newer versions (1.10.x) require Java 8 or higher. </p> - <p> Specifically the build has been tested to work with Ant version 1.9.4, 1.9.9 and 1.10.1. </p> - <p> Remember to set the ANT_HOME environment variable and add ANT_HOME/bin to your shell's PATH. </p> - +</div> <a name="Install+Apache+Forrest"></a> -<div class="h3"> -<h3>Install Apache Forrest<a title="Permanent link" class="headerlink" href="#Install+Apache+Forrest">#</a> -</h3> -</div> - - +<h2 class="boxed">Install Apache Forrest</h2> +<div class="section"> <p> The POI build system requires <a href="https://forrest.apache.org/";>Apache Forrest</a> to build the documentation. </p> - <p> Specifically the build has been tested to work with Forrest 0.5.x. This is an <strong>old release</strong> which is available <a href="https://archive.apache.org/dist/forrest/pre-0.6/";>here</a>. </p> - <p> Remember to set the FORREST_HOME environment variable. </p> - +</div> <a name="Building+Targets+with+Ant"></a> -<div class="h3"> -<h3>Building Targets with Ant<a title="Permanent link" class="headerlink" href="#Building+Targets+with+Ant">#</a> -</h3> -</div> - - +<h2 class="boxed">Building Targets with Ant</h2> +<div class="section"> <p> The main targets of interest to our users are: </p> - <table class="ForrestTable" cellspacing="1" cellpadding="4"> -<tr class="b"> +<tr> <th colspan="1" rowspan="1">Ant Target</th> <th colspan="1" rowspan="1">Description</th> </tr> -<tr class="a"> +<tr> <td colspan="1" rowspan="1">clean</td> <td colspan="1" rowspan="1">Erase all build work products (ie. everything in the @@ -358,42 +255,42 @@ if (VERSION > 3) { </tr> -<tr class="b"> +<tr> <td colspan="1" rowspan="1">compile</td> <td colspan="1" rowspan="1">Compiles all files from main, ooxml and scratchpad</td> </tr> -<tr class="a"> +<tr> <td colspan="1" rowspan="1">test</td> <td colspan="1" rowspan="1">Run all unit tests from main, ooxml and scratchpad</td> </tr> -<tr class="b"> +<tr> <td colspan="1" rowspan="1">jar</td> <td colspan="1" rowspan="1">Produce jar files</td> </tr> -<tr class="a"> +<tr> <td colspan="1" rowspan="1">assemble</td> <td colspan="1" rowspan="1">Produce .zip and tar.gz distribution packages</td> </tr> -<tr class="b"> +<tr> <td colspan="1" rowspan="1">docs</td> <td colspan="1" rowspan="1">Generate all documentation (Requires Apache Forrest)</td> </tr> -<tr class="a"> +<tr> <td colspan="1" rowspan="1">jenkins</td> <td colspan="1" rowspan="1">Runs the tests which Jenkins, our Continuous Integration system, does. This includes the unit tests and various code quality checks.</td> @@ -401,144 +298,109 @@ if (VERSION > 3) { </tr> </table> - +</div> <a name="Working+with+Eclipse"></a> -<div class="h3"> -<h3>Working with Eclipse<a title="Permanent link" class="headerlink" href="#Working+with+Eclipse">#</a> -</h3> -</div> - - +<h2 class="boxed">Working with Eclipse</h2> +<div class="section"> <p> Apache POI includes a pre-defined Eclipse project file which can be used to quickly get set up in the Eclipse IDE. </p> - <p> In order to get started, first build Apache POI using Ant as described above to get all required 3rd party libraries downloaded. </p> - <p> Then import the project in Eclipse via File->Import->Existing Projects into Workspace. </p> - <p> Note: when executing junit tests from within Eclipse, you might need to set the system property "POI.testdata.path" to the actual location of the 'test-data' directory to make the test framework find the required test-files. A simple value of 'test-data' usually works. </p> - +</div> <a name="Working+with+IntelliJ+Idea"></a> -<div class="h3"> -<h3>Working with IntelliJ Idea<a title="Permanent link" class="headerlink" href="#Working+with+IntelliJ+Idea">#</a> -</h3> -</div> - - +<h2 class="boxed">Working with IntelliJ Idea</h2> +<div class="section"> <p> We currently do not offer project files for IntelliJ and unfortunately it cannot import the project from the Ant build files. </p> - <p> In order to get started, first build Apache POI using Ant as described above to get all required 3rd party libraries downloaded. </p> - <p> Then import the main folder into a new project and then define all the source folders under src accordingly. Also add all libraries from the lib, compile-lib and ooxml-lib folders. </p> - <p> Note: when executing junit tests from within IntelliJ, you might need to set the system property "POI.testdata.path" to the actual location of the 'test-data' directory to make the test framework find the required test-files. A simple value of 'test-data' usually works. </p> - +</div> <a name="Using+Maven"></a> -<div class="h3"> -<h3>Using Maven<a title="Permanent link" class="headerlink" href="#Using+Maven">#</a> -</h3> -</div> - - +<h2 class="boxed">Using Maven</h2> +<div class="section"> <p>Building Apache POI using Maven is not currently officially supported, and we strongly suggest continuing to use the official Ant build.</p> - <p>However, including Apache POI within your own Maven project is fully supported, and widely used. Please see the - <a href="overview.html#components">Components Page</a> + <a href="../components/">Components Page</a> for details of the Maven artifacts available.</p> - +</div> <a name="Setting+environment+variables"></a> -<div class="h3"> -<h3>Setting environment variables<a title="Permanent link" class="headerlink" href="#Setting+environment+variables">#</a> -</h3> -</div> - - +<h2 class="boxed">Setting environment variables</h2> +<div class="section"> <p>Linux: <a href="https://help.ubuntu.com/community/EnvironmentVariables";>help.ubuntu.com</a>, <a href="http://unix.stackexchange.com/questions/117467/how-to-permanently-set-environmental-variables";>unix.stackexchange.com</a> </p> - <p>Windows: <a href="https://en.wikipedia.org/wiki/Environment_variable#DOS.2C_OS.2F2_and_Windows";>en.wikipedia.org</a> </p> - - - - -<div id="authors" align="right">by Glen Stampoultzis, Tetsuya Kitahata, David Fisher</div> </div> + +<p align="right"> +<font size="-2">by Glen Stampoultzis, Tetsuya Kitahata, 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> + Copyright © + 2001-2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a> </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 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> -<!--================= end Credits ==================--> -</td> -</tr> -</tbody> -</table> +<div id="feedback"> + Send feedback about the website to: + <a id="feedbackto" href="mailto:[email protected]?subject=Feedback%C2%A0devel/index.html";>[email protected]</a> +</div> +<!--+ + |end bottomstrip + +--> </div> -<!--================= end Footer ==================--> </body> </html> Added: poi/site/publish/devel/plan/index.html URL: http://svn.apache.org/viewvc/poi/site/publish/devel/plan/index.html?rev=1836244&view=auto ============================================================================== --- poi/site/publish/devel/plan/index.html (added) +++ poi/site/publish/devel/plan/index.html Wed Jul 18 23:27:21 2018 @@ -0,0 +1,267 @@ +<!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"> +<meta content="Apache Forrest" name="Generator"> +<meta name="Forrest-version" content="0.9"> +<meta name="Forrest-skin-name" content="pelt"> +<title>Planning Documentation</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 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> +<!--+ + |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> +<a class="unselected" href="../../components/index.html">Component APIs</a> +</li> +<li class="current"> +<a class="selected" 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');">Getting Involved</div> +<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> +<div class="menuitem"> +<a href="../../devel/index.html">How To Build</a> +</div> +<div class="menuitem"> +<a href="../../devel/subversion.html">Subversion Repository</a> +</div> +<div class="menuitem"> +<a href="../../devel/guidelines.html">Contribution Guidelines</a> +</div> +<div class="menuitem"> +<a href="../../devel/who.html">Who We Are</a> +</div> +<div onclick="SwitchMenu('menu_selected_1.1.5', '../../skin/')" id="menu_selected_1.1.5Title" class="menutitle" style="background-image: url('../../skin/images/chapter_open.gif');">Planning Documents</div> +<div id="menu_selected_1.1.5" class="selectedmenuitemgroup" style="display: block;"> +<div class="menupage"> +<div class="menupagetitle">Overview</div> +</div> +<div class="menuitem"> +<a href="../../devel/plan/vision10.html">1.0 Vision</a> +</div> +<div class="menuitem"> +<a href="../../devel/plan/vision20.html">2.0 Vision</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.6', '../../skin/')" id="menu_1.1.6Title" class="menutitle">References</div> +<div id="menu_1.1.6" class="menuitemgroup"> +<div class="menuitem"> +<a href="../../devel/references/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../../devel/references/logocontest.html">Logo Submissions</a> +</div> +<div class="menuitem"> +<a href="http://sc.openoffice.org/excelfileformat.pdf";>XLS spec [PDF]</a> +</div> +<div class="menuitem"> +<a href="http://xml.apache.org/cocoon/";>Apache Cocoon</a> +</div> +</div> +<div onclick="SwitchMenu('menu_1.1.7', '../../skin/')" id="menu_1.1.7Title" class="menutitle">Resolutions</div> +<div id="menu_1.1.7" class="menuitemgroup"> +<div class="menuitem"> +<a href="../../devel/resolutions/index.html">Overview</a> +</div> +<div class="menuitem"> +<a href="../../devel/resolutions/res001.html">Minimal Coding Standards</a> +</div> +</div> +<div class="menuitem"> +<a href="../../devel/historyandfuture.html">History</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>Planning Documentation</h1> +<h3>Overview</h3> +<div id="front-matter"></div> + +<a name="Overview"></a> +<h2 class="boxed">Overview</h2> +<div class="section"> +<p>This is a collection of notes to assist with long-term planning and + development. + </p> +<p>There is much discussion of issues and research topics (RT) threads on + the <span class="codefrag">dev</span> mailing list (and elsewhere). However, details + get lost in the sheer volume. This is the place to document the summary of + discussions on some key topics. Some new and complex capabilities will take + lots of design and specification before they can be implemented. + </p> +<p>Another use for this collection of notes is as a place to quickly store + a snippet from an email discussion or even a link to a discussion thread. + The concepts can then be fleshed-out over time. + </p> +<p>Anyone can participate in this process. Please get involved in discussion + on <span class="codefrag">dev</span> and contribute patches for these summary planning + documents via the normal <a href="../../devel/guidelines.html">contribution</a> + process. + </p> +<p>These planning documents are intended to be concise notes only. They are + also ever-evolving, because as issues are addressed these notes will be + revised. + </p> +</div> + + +<a name="Topics+and+Issues"></a> +<h2 class="boxed">Topics and Issues</h2> +<div class="section"> +<ul> + +<li> +<a href="../../devel/plan/vision20.html">POI Version 2.0 Vision</a> + +</li> + +<li> +<a href="../../devel/plan/vision10.html">POI Version 1.0 Vision</a> + +</li> + +</ul> +</div> + + +<p align="right"> +<font size="-2">by David Crossley, Nicola Ken Barozzi</font> +</p> +</div> +<!--+ + |end content + +--> +<div class="clearboth"> </div> +</div> +<div id="footer"> +<!--+ + |start bottomstrip + +--> +<div class="lastmodified"> +<script type="text/javascript"><!-- +document.write("Last Published: " + document.lastModified); +// --></script> +</div> +<div class="copyright"> + Copyright © + 2001-2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a> +</div> +<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:[email protected]?subject=Feedback%C2%A0devel/plan/index.html";>[email protected]</a> +</div> +<!--+ + |end bottomstrip + +--> +</div> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
![https://www.apache.org/events/current-event-125x125.png"](https://www.apache.org/events/current-event-125x125.png"){kind=link}
![http://www.apache.org/events/current-event-125x125.png"](http://www.apache.org/events/current-event-125x125.png"){kind=link}