Add a 'using' section to the main page with a short code example and pointers to the Javadoc. Move the "About" section to the end and remove broken package reference.

garydgregory · garydgregory · commit 83ad716bc2fc · 2013-03-26T22:12:57.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1461338 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
@@ -22,18 +22,16 @@ limitations under the License.
  </properties>
 <body>
 <!-- ================================================== -->
-<section name="Commons CSV">
-  <p>Commons CSV was started to unify a common and simple interface for reading and writing CSV files under an ASL license. It has been bootstrapped by a code donation from Netcetera in Switzerland. There are three pre-existing BSD compatible CSV parsers which this component will hopefully make redundant (authors willing): </p>
-  <ul>
-    <li><a href="http://kasparov.skife.org/csv/">Skife CSV</a></li>
-    <li><a href="http://opencsv.sourceforge.net/">Open CSV</a></li>
-    <li><a href="http://www.osjava.org/genjava/multiproject/gj-csv/">Genjava CSV</a></li>
-  </ul>
-  <p>In addition to the code from Netcetera (org.apache.commons.csv), Martin van den Bemt has added an additional writer API (org.apache.commons.csv.writer). </p>
-  <p>Other CSV implementations: </p>
-  <ul>
-    <li><a href="http://supercsv.sourceforge.net/">Super CSV</a></li>
-  </ul>
+<section name="Using Commons CSV">
+  <p>Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.</p>
+  <p>To parse an Excel CSV file, write:</p>
+  <source>Reader in = ...;
+Iterable&lt;CSVRecord&gt; parser = CSVFormat.EXCEL.parse(in);
+for (CSVRecord record : parser) {
+    ...
+}</source>  
+  <p>Other formats are available, please consult the Javadoc for <a href="apidocs/org/apache/commons/csv/CSVFormat.html">CSVFormat</a> and 
+  <a href="apidocs/org/apache/commons/csv/CSVParser.html">CSVParser</a></p>
 </section>
 
 <section name="Getting the code">
@@ -46,6 +44,20 @@ limitations under the License.
   <p>Please report any bugs or issues in the Commons Sandbox Jira project at <a href="http://issues.apache.org/jira/browse/CSV">http://issues.apache.org/jira/browse/CSV</a>. Please ask any questions or suggest any ideas for improvement on the commons-dev and commons-user <a href="mail-lists.html">mailing lists</a>. </p>
 </section>
 
+<section name="About Commons CSV">
+  <p>Commons CSV was started to unify a common and simple interface for reading and writing CSV files under an ASL license. It has been bootstrapped by a code donation from Netcetera in Switzerland. There are three pre-existing BSD compatible CSV parsers which this component will hopefully make redundant (authors willing): </p>
+  <ul>
+    <li><a href="http://kasparov.skife.org/csv/">Skife CSV</a></li>
+    <li><a href="http://opencsv.sourceforge.net/">Open CSV</a></li>
+    <li><a href="http://www.osjava.org/genjava/multiproject/gj-csv/">Genjava CSV</a></li>
+  </ul>
+  <p>In addition to the code from Netcetera (org.apache.commons.csv), Martin van den Bemt has added an additional writer API. </p>
+  <p>Other CSV implementations: </p>
+  <ul>
+    <li><a href="http://supercsv.sourceforge.net/">Super CSV</a></li>
+  </ul>
+</section>
+
 <!-- ================================================== -->
 </body>
 </document>
