Prepare website for 1.0 release
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1609554 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
4117bb493f
commit
d3afa156e4
|
@ -0,0 +1,89 @@
|
|||
Apache Commons CSV
|
||||
Version 1.0
|
||||
Release Notes
|
||||
|
||||
|
||||
INTRODUCTION:
|
||||
|
||||
This document contains the release notes for the 1.0 version of Apache Commons CSV.
|
||||
Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.
|
||||
|
||||
CSV requires at least Java 5.0.
|
||||
|
||||
The Apache Commons CSV library provides a simple interface for reading and writing
|
||||
CSV files of various types.
|
||||
|
||||
First release
|
||||
|
||||
Changes in this version include:
|
||||
|
||||
NEW FEATURES
|
||||
==============
|
||||
|
||||
o CSV-121: IllegalArgumentException thrown when the header contains duplicate names when the column names are empty.
|
||||
Thanks to Sebastian Hardt.
|
||||
o CSV-120: CSVFormat#withHeader doesn't work with CSVPrinter Thanks to Sergei Lebedev.
|
||||
o CSV-119: CSVFormat is missing a print(...) method Thanks to Sergei Lebedev.
|
||||
o CSV-105: Add Map conversion API to CSVRecord
|
||||
o CSV-52: Keep track of record number
|
||||
o CSV-92: Need a way to extract parsed headers, e.g. for use in formatting
|
||||
output
|
||||
o CSV-65: Header support
|
||||
o CSV-48: Predefined format for MYSQL
|
||||
|
||||
FIXED BUGS
|
||||
============
|
||||
|
||||
o CSV-118: CSVRecord.toMap() throws NPE on formats with no
|
||||
headers. Thanks to Enrique Lara.
|
||||
o CSV-113: Check whether ISE/IAE are being used appropriately
|
||||
o CSV-114: CSVFormat constructor should reject a header array with duplicate
|
||||
entries
|
||||
o CSV-112: HeaderMap is inconsistent when it is parsed from an input with
|
||||
duplicate columns names
|
||||
o CSV-111: CSVRecord.toMap() fails if row length shorter than header length
|
||||
o CSV-106: CSVFormat.format allways append null
|
||||
o CSV-100: CSVParser: getHeaderMap throws NPE
|
||||
o CSV-53: CSVRecord does not verify that the length of the header mapping
|
||||
matches the number of values
|
||||
o CSV-54: Confusing semantic of the ignore leading/trailing spaces parameters
|
||||
o CSV-34: CSVFormat describes itself as immutable, but it is not - in
|
||||
particular it is not thread-safe
|
||||
o CSV-36: Endless loops in CSV parser
|
||||
o CSV-13: NullPointerException in CSVPrinter.print()/println()
|
||||
o CSV-23: Excel strategy uses wrong separator
|
||||
|
||||
CHANGES
|
||||
=========
|
||||
|
||||
o CSV-117: Validate format parameters in constructor
|
||||
o CSV-42: Lots of possible changes Thanks to Bob Smith.
|
||||
o CSV-78: Use Character instead of char for char fields except delimiter
|
||||
o CSV-99: Revert Builder implementation in CSVFormat
|
||||
o CSV-93: Allow the handling of NULL values
|
||||
o CSV-68: Use the Builder pattern for CSVFormat
|
||||
o CSV-84: Clarify comment handling
|
||||
o CSV-25: CSVParser.nextValue() seems pointless
|
||||
o CSV-97: Allow the String value for null to be customized for the CSV
|
||||
printer
|
||||
o CSV-88: Not possible to create a CSVFormat from scratch
|
||||
o CSV-94: Lexer should only use char fields
|
||||
o CSV-71: Add convenience methods to CSVLexer
|
||||
o CSV-59: Is CharBuffer really needed, now that StringBuilder is available?
|
||||
o CSV-55: Replace while(true)-loop in CSVParser.getRecord with do-while-loop
|
||||
o CSV-45: CSVPrinter overhaul
|
||||
o CSV-49: CSVStrategy has modifiable public static variables Thanks to Bob Smith.
|
||||
o CSV-46: Reduce visibility of methods in internal classes
|
||||
o CSV-26: ExtendedBufferedReader does too much
|
||||
o CSV-27: Decide whether to keep the csv.writer subpackage
|
||||
|
||||
|
||||
Historical list of changes: http://commons.apache.org/proper/commons-csv/changes-report.html
|
||||
|
||||
For complete information on Apache Commons CSV, including instructions on how to submit bug reports,
|
||||
patches, or suggestions for improvement, see the Apache Apache Commons CSV website:
|
||||
|
||||
http://commons.apache.org/proper/commons-csv/
|
||||
|
||||
Have fun!
|
||||
-Apache Commons CSV team
|
|
@ -0,0 +1,126 @@
|
|||
## Licensed to the Apache Software Foundation (ASF) under one
|
||||
## or more contributor license agreements. See the NOTICE file
|
||||
## distributed with this work for additional information
|
||||
## regarding copyright ownership. The ASF licenses this file
|
||||
## to you under the Apache License, Version 2.0 (the
|
||||
## "License"); you may not use this file except in compliance
|
||||
## with the License. You may obtain a copy of the License at
|
||||
##
|
||||
## http://www.apache.org/licenses/LICENSE-2.0
|
||||
##
|
||||
## Unless required by applicable law or agreed to in writing,
|
||||
## software distributed under the License is distributed on an
|
||||
## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
## KIND, either express or implied. See the License for the
|
||||
## specific language governing permissions and limitations
|
||||
## under the License.
|
||||
##
|
||||
${project.name}
|
||||
Version ${version}
|
||||
Release Notes
|
||||
|
||||
|
||||
INTRODUCTION:
|
||||
|
||||
This document contains the release notes for the ${version} version of Apache Commons CSV.
|
||||
Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.
|
||||
|
||||
CSV requires at least Java 5.0.
|
||||
|
||||
$introduction.replaceAll("(?<!\015)\012", "
|
||||
").replaceAll("(?m)^ +","")
|
||||
|
||||
## N.B. the available variables are described here:
|
||||
## http://maven.apache.org/plugins/maven-changes-plugin/examples/using-a-custom-announcement-template.html
|
||||
##
|
||||
## Hack to improve layout: replace all pairs of spaces with a single new-line
|
||||
$release.description.replaceAll(" ", "
|
||||
")
|
||||
|
||||
## set up indent sizes. Only change indent1
|
||||
#set($props=${project.properties})
|
||||
#set($jiralen=$props.get("commons.jira.id").length())
|
||||
## indent1 = POOL-nnnn:
|
||||
#set($blanklen=$jiralen+6)## +6 for "-nnnn:"
|
||||
## must be at least as long as the longest JIRA id
|
||||
#set($blanks=" ")
|
||||
#set($indent1=$blanks.substring(0,$blanklen))
|
||||
## indent2 allows for issue wrapper
|
||||
#set($indent2="$indent1 ")
|
||||
##
|
||||
#macro ( processaction )
|
||||
## Use replaceAll to fix up LF-only line ends on Windows.
|
||||
#set($action=$actionItem.getAction().replaceAll("\n","
|
||||
"))
|
||||
## Fix up indentation for multi-line action descriptions
|
||||
#set($action=$action.replaceAll("(?m)^ +",$indent2))
|
||||
#if ($actionItem.getIssue())
|
||||
#set($issue="$actionItem.getIssue():")
|
||||
## Pad shorter issue numbers
|
||||
#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
|
||||
#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
|
||||
#if ($issue.length() < $indent1.length())#set ($issue="$issue ")#end
|
||||
#else
|
||||
#set($issue=$indent1)
|
||||
#end
|
||||
#if ($actionItem.getDueTo())
|
||||
#set($dueto=" Thanks to $actionItem.getDueTo().")
|
||||
#else
|
||||
#set($dueto="")
|
||||
#end
|
||||
o $issue ${action}$dueto
|
||||
#set($action="")
|
||||
#set($issue="")
|
||||
#set($dueto="")
|
||||
#end
|
||||
##
|
||||
#if ($release.getActions().size() == 0)
|
||||
No changes defined in this version.
|
||||
#else
|
||||
Changes in this version include:
|
||||
|
||||
#if ($release.getActions('add').size() !=0)
|
||||
NEW FEATURES
|
||||
==============
|
||||
|
||||
#foreach($actionItem in $release.getActions('add'))
|
||||
#processaction()
|
||||
#end
|
||||
#end
|
||||
|
||||
#if ($release.getActions('fix').size() !=0)
|
||||
FIXED BUGS
|
||||
============
|
||||
|
||||
#foreach($actionItem in $release.getActions('fix'))
|
||||
#processaction()
|
||||
#end
|
||||
#end
|
||||
|
||||
#if ($release.getActions('update').size() !=0)
|
||||
CHANGES
|
||||
=========
|
||||
|
||||
#foreach($actionItem in $release.getActions('update'))
|
||||
#processaction()
|
||||
#end
|
||||
#end
|
||||
|
||||
#if ($release.getActions('remove').size() !=0)
|
||||
Removed:
|
||||
#foreach($actionItem in $release.getActions('remove'))
|
||||
#processaction()
|
||||
#end
|
||||
#end
|
||||
## End of main loop
|
||||
#end
|
||||
|
||||
Historical list of changes: ${project.url}changes-report.html
|
||||
|
||||
For complete information on ${project.name}, including instructions on how to submit bug reports,
|
||||
patches, or suggestions for improvement, see the Apache ${project.name} website:
|
||||
|
||||
${project.url}
|
||||
|
||||
Have fun!
|
||||
-Apache Commons CSV team
|
|
@ -28,7 +28,7 @@
|
|||
|
||||
<menu name="Commons CSV">
|
||||
<item name="Overview" href="/index.html"/>
|
||||
<item name="Download" href="/downloads.html"/>
|
||||
<item name="Download" href="/download_csv.cgi"/>
|
||||
<item name="Wiki" href="http://wiki.apache.org/commons/CSV"/>
|
||||
</menu>
|
||||
|
||||
|
|
|
@ -0,0 +1,138 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<!--
|
||||
+======================================================================+
|
||||
|**** ****|
|
||||
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
|
||||
|**** DO NOT EDIT DIRECTLY ****|
|
||||
|**** ****|
|
||||
+======================================================================+
|
||||
| TEMPLATE FILE: download-page-template.xml |
|
||||
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
|
||||
+======================================================================+
|
||||
| |
|
||||
| 1) Re-generate using: mvn commons:download-page |
|
||||
| |
|
||||
| 2) Set the following properties in the component's pom: |
|
||||
| - commons.componentid (required, alphabetic, lower case) |
|
||||
| - commons.release.version (required) |
|
||||
| - commons.binary.suffix (optional) |
|
||||
| (defaults to "-bin", set to "" for pre-maven2 releases) |
|
||||
| |
|
||||
| 3) Example Properties |
|
||||
| |
|
||||
| <properties> |
|
||||
| <commons.componentid>math</commons.componentid> |
|
||||
| <commons.release.version>1.2</commons.release.version> |
|
||||
| </properties> |
|
||||
| |
|
||||
+======================================================================+
|
||||
-->
|
||||
<document>
|
||||
<properties>
|
||||
<title>Download Apache Commons CSV</title>
|
||||
<author email="dev@commons.apache.org">Commons Documentation Team</author>
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Download Apache Commons CSV">
|
||||
<subsection name="Using a Mirror">
|
||||
<p>
|
||||
We recommend you use a mirror to download our release
|
||||
builds, but you <strong>must</strong> verify the integrity of
|
||||
the downloaded files using signatures downloaded from our main
|
||||
distribution directories. Recent releases (48 hours) may not yet
|
||||
be available from the mirrors.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
You are currently using <b>[preferred]</b>. If you
|
||||
encounter a problem with this mirror, please select another
|
||||
mirror. If all mirrors are failing, there are <i>backup</i>
|
||||
mirrors (at the end of the mirrors list) that should be
|
||||
available.
|
||||
<br></br>
|
||||
[if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
|
||||
</p>
|
||||
|
||||
<form action="[location]" method="get" id="SelectMirror">
|
||||
<p>
|
||||
Other mirrors:
|
||||
<select name="Preferred">
|
||||
[if-any http]
|
||||
[for http]<option value="[http]">[http]</option>[end]
|
||||
[end]
|
||||
[if-any ftp]
|
||||
[for ftp]<option value="[ftp]">[ftp]</option>[end]
|
||||
[end]
|
||||
[if-any backup]
|
||||
[for backup]<option value="[backup]">[backup] (backup)</option>[end]
|
||||
[end]
|
||||
</select>
|
||||
<input type="submit" value="Change"></input>
|
||||
</p>
|
||||
</form>
|
||||
|
||||
<p>
|
||||
The <a href="http://www.apache.org/dist/commons/KEYS">KEYS</a>
|
||||
link links to the code signing keys used to sign the product.
|
||||
The <code>PGP</code> link downloads the OpenPGP compatible signature from our main site.
|
||||
The <code>MD5</code> link downloads the checksum from the main site.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
<section name="Apache Commons CSV 1.0 ">
|
||||
<subsection name="Binaries">
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.0-bin.tar.gz">commons-csv-1.0-bin.tar.gz</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/binaries/commons-csv-1.0-bin.tar.gz.md5">md5</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/binaries/commons-csv-1.0-bin.tar.gz.asc">pgp</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="[preferred]/commons/csv/binaries/commons-csv-1.0-bin.zip">commons-csv-1.0-bin.zip</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/binaries/commons-csv-1.0-bin.zip.md5">md5</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/binaries/commons-csv-1.0-bin.zip.asc">pgp</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
<subsection name="Source">
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="[preferred]/commons/csv/source/commons-csv-1.0-src.tar.gz">commons-csv-1.0-src.tar.gz</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/source/commons-csv-1.0-src.tar.gz.md5">md5</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/source/commons-csv-1.0-src.tar.gz.asc">pgp</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="[preferred]/commons/csv/source/commons-csv-1.0-src.zip">commons-csv-1.0-src.zip</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/source/commons-csv-1.0-src.zip.md5">md5</a></td>
|
||||
<td><a href="http://www.apache.org/dist/commons/csv/source/commons-csv-1.0-src.zip.asc">pgp</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
<section name="Archives">
|
||||
<p>
|
||||
Older releases can be obtained from the archives.
|
||||
</p>
|
||||
<ul>
|
||||
<li class="download"><a href="[preferred]/commons/csv/">browse download area</a></li>
|
||||
<li><a href="http://archive.apache.org/dist/commons/csv/">archives...</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
|
@ -1,57 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
<document>
|
||||
<properties>
|
||||
<title>Downloads</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Download CSV">
|
||||
|
||||
<subsection name="Releases">
|
||||
<p>
|
||||
There are currently no official downloads, and will not be until CSV moves out of the Sandbox.
|
||||
<!--
|
||||
Download the <a href="http://jakarta.apache.org/site/downloads/downloads_commons-csv.cgi">Latest Release</a>
|
||||
of Commons CSV.
|
||||
-->
|
||||
</p>
|
||||
|
||||
</subsection>
|
||||
|
||||
<subsection name="Nightly Builds">
|
||||
<p>
|
||||
<a href="https://repository.apache.org/content/groups/snapshots/org/apache/commons/commons-csv">Nightly Builds</a>
|
||||
are built once a day from the current SVN HEAD. This is (nearly) the latest code and so should
|
||||
be treated with caution.
|
||||
</p>
|
||||
</subsection>
|
||||
<!--
|
||||
<subsection name="Archived Releases">
|
||||
<p>
|
||||
Older releases are retained by the Apache Software Foundation but are
|
||||
moved into a
|
||||
<a href="http://archive.apache.org/dist/jakarta/commons/csv/">
|
||||
special archive area</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
-->
|
||||
</section>
|
||||
|
||||
</body>
|
||||
</document>
|
|
@ -56,10 +56,29 @@ try {
|
|||
}</source>
|
||||
</section>
|
||||
|
||||
<section name="Getting the code">
|
||||
<p>There are currently no official downloads, and will not be until version 1.0 is released.</p>
|
||||
<p>The latest code can be checked out from our Subversion repository at <a href="http://svn.apache.org/repos/asf/commons/proper/csv/trunk/">http://svn.apache.org/repos/asf/commons/proper/csv/trunk/</a>. </p>
|
||||
<p>You can build the component using Apache Maven. For example: mvn clean package.</p>
|
||||
<!-- ================================================== -->
|
||||
<section name="Release Information">
|
||||
<p>The latest stable release of csv is 1.0. You may: </p>
|
||||
<ul>
|
||||
<li>Download <a href="http://commons.apache.org/csv/download_csv.cgi">1.0</a></li>
|
||||
<li>Read the <a href="release-notes/RELEASE-NOTES-1.0.txt">1.0 release notes</a></li>
|
||||
</ul>
|
||||
<p>
|
||||
Alternatively you can pull it from the central Maven repositories:
|
||||
<pre>
|
||||
<groupId>org.apache.commons</groupId>
|
||||
<artifactId>commons-csv</artifactId>
|
||||
<version>1.0</version>
|
||||
</pre>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section name="Building from sources">
|
||||
<p>The latest code can be checked out from our Subversion repository at <a href="http://svn.apache.org/repos/asf/commons/proper/csv/trunk/">http://svn.apache.org/repos/asf/commons/proper/csv/trunk/</a>.
|
||||
You can build the component using Apache Maven using <code>mvn clean package</code>.
|
||||
</p>
|
||||
<p>Note that building the website currently does not work when building with JDK 8.
|
||||
This is due to incompatibilities between JDK 8 and the <a href="http://mojo.codehaus.org/findbugs-maven-plugin/">maven-findbugs-plugin</a>.</p>
|
||||
</section>
|
||||
<!-- ================================================== -->
|
||||
<section name="Getting Involved">
|
||||
|
|
Loading…
Reference in New Issue