You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2014/08/13 18:03:19 UTC
svn commit: r1617744 - in /poi/site: publish/guidelines.html
publish/resolutions/ publish/resolutions/index.html
publish/resolutions/res001.html
src/documentation/content/xdocs/guidelines.xml
Author: nick
Date: Wed Aug 13 16:03:18 2014
New Revision: 1617744
URL: http://svn.apache.org/r1617744
Log:
Switch from an absolute URL to a relative link, so that the page correctly gets generated, fixing #54829
Added:
poi/site/publish/resolutions/
poi/site/publish/resolutions/index.html
poi/site/publish/resolutions/res001.html
Modified:
poi/site/publish/guidelines.html
poi/site/src/documentation/content/xdocs/guidelines.xml
Modified: poi/site/publish/guidelines.html
URL: http://svn.apache.org/viewvc/poi/site/publish/guidelines.html?rev=1617744&r1=1617743&r2=1617744&view=diff
==============================================================================
--- poi/site/publish/guidelines.html (original)
+++ poi/site/publish/guidelines.html Wed Aug 13 16:03:18 2014
@@ -640,7 +640,7 @@ if (VERSION > 3) {
</div>
<p>The long standing
- <a href="http://poi.apache.org/resolutions/res001.html">Minimal
+ <a href="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
Added: poi/site/publish/resolutions/index.html
URL: http://svn.apache.org/viewvc/poi/site/publish/resolutions/index.html?rev=1617744&view=auto
==============================================================================
--- poi/site/publish/resolutions/index.html (added)
+++ poi/site/publish/resolutions/index.html Wed Aug 13 16:03:18 2014
@@ -0,0 +1,206 @@
+<!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>Resolutions</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">Apache POI</span>
+
+<div class="menuItem">
+<a href="../index.html">Top</a>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">About</span>
+
+<div class="menuItem">
+<span class="menuSelected">About</span>
+</div>
+
+</div>
+<div class="menu">
+<span class="menuLabel">Resolutions</span>
+
+<div class="menuItem">
+<a href="res001.html">Coding Standards</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>Resolutions</h1>
+</div>
+<div class="h3">
+
+
+
+
+<a name="About+Resolutions"></a>
+<div class="h3">
+<h3>About Resolutions</h3>
+</div>
+
+<p>
+ Every project in Apache has resolutions that they vote on.
+ Decisions are made, etc. But what happens once those decisions
+ are made? They are archived in the mail list archive never to
+ be read again (once its not in the top 10 or so posts). So they
+ get discussed again and again.
+ </p>
+
+<p>
+ Rather than have that big waste of time, we have this section to
+ record important POI decisions. Once a decision is passed it
+ need only be linked to this page (either by creating a page for
+ it or by simply linking it to the archive messages). Wherever
+ possible a brief about how many votes for and against an maybe
+ some background should be posted.
+ </p>
+
+<p>
+ This section is intended mainly to reduce big waste of time
+ discussions from taking away from whats important...developing
+ POI! :-D
+ </p>
+
+
+
+<div id="authors" align="right">by Andrew C. Oliver</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-2014 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">
+<a href="http://validator.w3.org/check/referer"><img width="88" height="31" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/"><img width="88" height="31" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a><a href="http://forrest.apache.org/"><img border="0" class="logoImage" alt="Built with Apache Forrest" src="../skin/images/built-with-forrest-button.png" width="88" height="31"></a>
+</div>
+</div>
+<!--================= end Credits ==================-->
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<!--================= end Footer ==================-->
+</body>
+</html>
Added: poi/site/publish/resolutions/res001.html
URL: http://svn.apache.org/viewvc/poi/site/publish/resolutions/res001.html?rev=1617744&view=auto
==============================================================================
--- poi/site/publish/resolutions/res001.html (added)
+++ poi/site/publish/resolutions/res001.html Wed Aug 13 16:03:18 2014
@@ -0,0 +1,289 @@
+<!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>POI Resoluton</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">Apache POI</span>
+<div class="menuItem">
+<a href="../index.html">Top</a>
+</div>
+</div>
+<div class="menu">
+<span class="menuLabel">About</span>
+<div class="menuItem">
+<a href="index.html">About</a>
+</div>
+</div>
+<div class="menu">
+<span class="menuLabel">Resolutions</span>
+<div class="menuItem">
+<span class="menuSelected">Coding Standards</span>
+</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>POI Resoluton</h1>
+</div>
+<div class="h3">
+
+
+
+
+<a name="Resolution+001+-+Minimal+Coding+Standards"></a>
+<div class="h3">
+<h3>Resolution 001 - Minimal Coding Standards</h3>
+</div>
+
+<a name="Majority+Position"></a>
+<div class="h4">
+<h4>Majority Position</h4>
+</div>
+
+<p>
+ As the POI project has grown the "styles" used have become more
+ varied, some see this as a bad thing, but in reality it
+ can be a good thing. Each can learn from the different
+ styles by working with different code. That being said
+ there are some universal "good quality" guidelines that
+ must be adopted on a project of any proportions.
+ </p>
+
+<p>
+ Marc Johnson Authored the following resolution:
+ </p>
+
+<p>
+ On Tue, 2002-01-08 at 22:23, Marc Johnson wrote:
+ Standards are wonderful; everyone should have a set.
+ Here's what I propose for coding standards for POI WRT comments (should I
+ feel the need, I'll post more of these little gems):
+ </p>
+
+<ol>
+
+<li>
+ All classes and interfaces MUST have, right at the
+ beginning of the file, the Apache Software License
+ 2.0 License Header. (see /legal/LICENSE).
+ </li>
+
+<li>
+ All classes and interfaces MUST include class javadoc. Conventionally,
+ this goes after the package and imports, and before the start of the class
+ or interface.
+ <!-- No more author tags -->
+ <!-- The class javadoc MUST have at least one @author tag -->
+ </li>
+
+<li>
+ All methods that are accessible outside the class MUST have javadoc
+ comments. In other words, if it isn't private, it MUST have javadoc
+ comments. Simple getters can consist of a simple @return tag; simple setters
+ can consist of a simple @param tag. Anything else requires some verbiage
+ plus all the standard javadoc tags as appropriate. You MUST include @throws
+ or @exception for any non-runtime exceptions, and you SHOULD document any
+ runtime exceptions you expect to throw. @throws/@exception tags SHOULD
+ include an explanation of why that exception would be thrown. If your method
+ might return null, you MUST say so. An accompanying explanation of the
+ circumstances for doing so would be nice.
+ </li>
+
+</ol>
+
+
+<a name="Amendments+%28informal+by+extension+and+not+by+vote%29"></a>
+<div class="h4">
+<h4>Amendments (informal by extension and not by vote)</h4>
+</div>
+
+<a name="License"></a>
+<div class="h2">
+<h2>License</h2>
+</div>
+
+<p>
+ As opposed to the formerly used POI License (which was
+ based on the Apache Public License), now that POI is
+ part of Apache, use the standard Apache Software
+ License 2.0 header. As per standard Apache Software
+ Foundation policy, the full (long) version of the
+ header should be used.
+ </p>
+
+
+<a name="2+cents"></a>
+<div class="h2">
+<h2>2 cents</h2>
+</div>
+
+<p>
+ Tip: No laughing or joking allowed in conversations regarding coding
+ standards.
+ Any mail on coding standards will be treated very seriously,
+ and sent here with a RTFM.
+ </p>
+
+
+
+<a name="Dissent"></a>
+<div class="h4">
+<h4>Dissent</h4>
+</div>
+
+<p>
+ The motion was passed unanimously with no negative or
+ neutral votes.
+ </p>
+
+
+<a name="Comments"></a>
+<div class="h4">
+<h4>Comments</h4>
+</div>
+
+<p>
+ Andy didn't feel like going through his mail and sucking
+ out the comments.. If there is anything you feel should
+ be added here do it yourself ;-).
+ </p>
+
+
+
+
+<div id="authors" align="right">by Andrew C. Oliver</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-2014 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>
Modified: poi/site/src/documentation/content/xdocs/guidelines.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/guidelines.xml?rev=1617744&r1=1617743&r2=1617744&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/guidelines.xml (original)
+++ poi/site/src/documentation/content/xdocs/guidelines.xml Wed Aug 13 16:03:18 2014
@@ -294,7 +294,7 @@
<anchor id="CodeStyle"/>
<section><title>Code Style</title>
<p>The long standing
- <link href="http://poi.apache.org/resolutions/res001.html">Minimal
+ <link href="resolutions/res001.html">Minimal
Coding Standards</link> 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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org