Author: nick
Date: Thu Aug 14 13:36:33 2014
New Revision: 1617939
URL: http://svn.apache.org/r1617939
Log:
Partial update of the examples page, with HSSF-only and XSSF-only sections, and
a ToC
Modified:
poi/site/publish/spreadsheet/examples.html
poi/site/src/documentation/content/xdocs/spreadsheet/examples.xml
Modified: poi/site/publish/spreadsheet/examples.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/spreadsheet/examples.html?rev=1617939&r1=1617938&r2=1617939&view=diff
==============================================================================
--- poi/site/publish/spreadsheet/examples.html (original)
+++ poi/site/publish/spreadsheet/examples.html Thu Aug 14 13:36:33 2014
@@ -183,28 +183,100 @@ if (VERSION > 3) {
-<a name="HSSF+and+XSSF+examples"></a>
+<a name="HSSF+and+XSSF+common+examples"></a>
<div class="h3">
-<h3>HSSF and XSSF examples</h3>
+<h3>HSSF and XSSF common examples</h3>
</div>
-<p>POI 3.5 and later comes with a number of examples that demonstrate how you
can use POI API to create documents from "real life".
- The examples are based on common XSSF-HSSF interfaces so that you can
generate either *.xls or *.xlsx output just by setting a command-line argument:
- </p>
-
+<p>Apach POI comes with a number of examples that demonstrate how you
+ can use the POI API to create documents from "real life".
+ The examples below based on common XSSF-HSSF interfaces so that you
+ can generate either *.xls or *.xlsx output just by setting a
+ command-line argument:
+ </p>
+
<pre class="code">
- BusinessPlan -xls
+ BusinessPlan -xls
or
- BusinessPlan -xlsx
- </pre>
-
+ BusinessPlan -xlsx
+ </pre>
+
<p>All sample source is available in <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/";>SVN</a>
</p>
+
+<p>In addition, there are a handful of
+ <a href="#hssf-only">HSSF only</a> and
+ <a href="#xssf-only">XSSF only</a> examples as well.
+ </p>
+
+<a name="Available+Examples"></a>
+<div class="h4">
+<h4>Available Examples</h4>
+</div>
+
+<p>
+ The following examples are available:
+ </p>
+
+<ul>
+
+<li>
+<a href="#ss-common">Common HSSF and XSSF</a>
+<ul>
+
+<li>
+<a href="#business-plan">Business Plan</a>
+</li>
+
+<li>
+<a href="#calendar">Calendar</a>
+</li>
+
+<li>
+<a href="#loan-calculator">Loan Calculator</a>
+</li>
+
+<li>
+<a href="#timesheet">Timesheet</a>
+</li>
+
+<li>
+<a href="#conditional-formats">Conditional Formats</a>
+</li>
+
+<li>
+<a href="#to-html">To HTML</a>
+</li>
+
+<li>
+<a href="#to-csv">To CSV</a>
+</li>
+
+<li>
+<em>TODO - List remaining examples</em>
+</li>
+
+</ul>
+</li>
+
+<li>
+<a href="#hssf-only">HSSF-Only</a>
+</li>
+
+<li>
+<a href="#xssf-only">XSSF-Only</a>
+</li>
+
+</ul>
-<a name="Business+Plan"></a>
-<div class="h3">
-<h3>Business Plan</h3>
+
+
+<a name="ss-common"></a>
+ <a name="business-plan"></a>
+ <a name="Business+Plan"></a>
+<div class="h4">
+<h4>Business Plan</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/BusinessPlan.java";>BusinessPlan</a>
@@ -217,10 +289,12 @@ if (VERSION > 3) {
<img alt="business plan demo" src="../resources/images/businessplan.jpg">
</p>
-
-<a name="Calendar"></a>
-<div class="h3">
-<h3>Calendar</h3>
+
+
+<a name="calendar"></a>
+ <a name="Calendar"></a>
+<div class="h4">
+<h4>Calendar</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/CalendarDemo.java";>Calendar</a>
@@ -232,10 +306,12 @@ if (VERSION > 3) {
<img alt="calendar demo" src="../resources/images/calendar.jpg">
</p>
-
-<a name="Loan+Calculator"></a>
-<div class="h3">
-<h3>Loan Calculator</h3>
+
+
+<a name="loan-calculator"></a>
+ <a name="Loan+Calculator"></a>
+<div class="h4">
+<h4>Loan Calculator</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoanCalculator.java";>LoanCalculator</a>
@@ -247,10 +323,12 @@ if (VERSION > 3) {
<img alt="loan calculator demo" src="../resources/images/loancalc.jpg">
</p>
-
-<a name="Timesheet"></a>
-<div class="h3">
-<h3>Timesheet</h3>
+
+
+<a name="timesheet"></a>
+ <a name="Timesheet"></a>
+<div class="h4">
+<h4>Timesheet</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/TimesheetDemo.java";>Timesheet</a>
@@ -262,10 +340,12 @@ if (VERSION > 3) {
<img alt="timesheet demo" src="../resources/images/timesheet.jpg">
</p>
-
-<a name="Conditional+Formats"></a>
-<div class="h3">
-<h3>Conditional Formats</h3>
+
+
+<a name="conditional-formats"></a>
+ <a name="Conditional+Formats"></a>
+<div class="h4">
+<h4>Conditional Formats</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/ConditionalFormats.java";>ConditionalFormats</a>
@@ -294,26 +374,55 @@ if (VERSION > 3) {
</ul>
-
-<a name="ToHtml"></a>
-<div class="h3">
-<h3>ToHtml</h3>
+
+
+<a name="to-html"></a>
+ <a name="ToHtml"></a>
+<div class="h4">
+<h4>ToHtml</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/html/ToHtml.java";>ToHtml</a>
example shows how to display a spreadsheet in HTML using the classes
for spreadsheet display.
</p>
-
-<a name="ToCSV"></a>
-<div class="h3">
-<h3>ToCSV</h3>
+
+
+<a name="to-csv"></a>
+ <a name="ToCSV"></a>
+<div class="h4">
+<h4>ToCSV</h4>
</div>
<p> The <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/ToCSV.java";>ToCSV</a>
example demonstrates <em>one</em> way to convert an Excel spreadsheet
into a CSV file.
</p>
+
+
+
+<a name="hssf-only"></a>
+ <a name="HSSF-only+Examples"></a>
+<div class="h3">
+<h3>HSSF-only Examples</h3>
+</div>
+
+<p>All the HSSF-only examples can be found in
+ <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/examples/";>SVN</a>
+</p>
+
+
+
+<a name="xssf-only"></a>
+ <a name="XSSF-only+Examples"></a>
+<div class="h3">
+<h3>XSSF-only Examples</h3>
+</div>
+
+<p>All the XSSF-only examples can be found in
+ <a
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/xssf/examples/";>SVN</a>
+</p>
+
<div id="authors" align="right">by Yegor Kozlov</div>
Modified: poi/site/src/documentation/content/xdocs/spreadsheet/examples.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/spreadsheet/examples.xml?rev=1617939&r1=1617938&r2=1617939&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/spreadsheet/examples.xml (original)
+++ poi/site/src/documentation/content/xdocs/spreadsheet/examples.xml Thu Aug
14 13:36:33 2014
@@ -27,17 +27,46 @@
</authors>
</header>
<body>
- <section><title>HSSF and XSSF examples</title>
- <p>POI 3.5 and later comes with a number of examples that demonstrate
how you can use POI API to create documents from "real life".
- The examples are based on common XSSF-HSSF interfaces so that you can
generate either *.xls or *.xlsx output just by setting a command-line argument:
- </p>
- <source>
- BusinessPlan -xls
+ <section><title>HSSF and XSSF common examples</title>
+ <p>Apach POI comes with a number of examples that demonstrate how you
+ can use the POI API to create documents from "real life".
+ The examples below based on common XSSF-HSSF interfaces so that you
+ can generate either *.xls or *.xlsx output just by setting a
+ command-line argument:
+ </p>
+ <source>
+ BusinessPlan -xls
or
- BusinessPlan -xlsx
- </source>
- <p>All sample source is available in <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/";>SVN</link></p>
+ BusinessPlan -xlsx
+ </source>
+ <p>All sample source is available in <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/";>SVN</link></p>
+ <p>In addition, there are a handful of
+ <link href="#hssf-only">HSSF only</link> and
+ <link href="#xssf-only">XSSF only</link> examples as well.
+ </p>
+
+ <section><title>Available Examples</title>
+ <p>
+ The following examples are available:
+ </p>
+ <ul>
+ <li><link href="#ss-common">Common HSSF and XSSF</link><ul>
+ <li><link href="#business-plan">Business Plan</link></li>
+ <li><link href="#calendar">Calendar</link></li>
+ <li><link href="#loan-calculator">Loan Calculator</link></li>
+ <li><link href="#timesheet">Timesheet</link></li>
+ <li><link href="#conditional-formats">Conditional
Formats</link></li>
+ <li><link href="#to-html">To HTML</link></li>
+ <li><link href="#to-csv">To CSV</link></li>
+ <li><em>TODO - List remaining examples</em></li>
+ </ul></li>
+ <li><link href="#hssf-only">HSSF-Only</link></li>
+ <li><link href="#xssf-only">XSSF-Only</link></li>
+ </ul>
</section>
+
+ <anchor id="ss-common" />
+ <anchor id="business-plan" />
<section><title>Business Plan</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/BusinessPlan.java";>BusinessPlan</link>
application creates a sample business plan with three phases, weekly
iterations and time highlighting. Demonstrates advanced cell formatting
@@ -47,6 +76,8 @@
<img src="../resources/images/businessplan.jpg" alt="business plan
demo"/>
</p>
</section>
+
+ <anchor id="calendar" />
<section><title>Calendar</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/CalendarDemo.java";>Calendar</link>
demo creates a multi sheet calendar. Each month is on a separate
sheet.
@@ -55,6 +86,8 @@
<img src="../resources/images/calendar.jpg" alt="calendar demo"/>
</p>
</section>
+
+ <anchor id="loan-calculator" />
<section><title>Loan Calculator</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoanCalculator.java";>LoanCalculator</link>
demo creates a simple loan calculator. Demonstrates advance usage of
cell formulas and named ranges.
@@ -63,6 +96,8 @@
<img src="../resources/images/loancalc.jpg" alt="loan calculator
demo"/>
</p>
</section>
+
+ <anchor id="timesheet" />
<section><title>Timesheet</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/TimesheetDemo.java";>Timesheet</link>
demo creates a weekly timesheet with automatic calculation of total
hours. Demonstrates advance usage of cell formulas.
@@ -71,6 +106,8 @@
<img src="../resources/images/timesheet.jpg" alt="timesheet demo"/>
</p>
</section>
+
+ <anchor id="conditional-formats" />
<section><title>Conditional Formats</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/ConditionalFormats.java";>ConditionalFormats</link>
demo is a collection of short examples showing what you can do with
Excel conditional formating in POI:
@@ -87,15 +124,32 @@
<li>Shade bands of rows on the worksheet</li>
</ul>
</section>
+
+ <anchor id="to-html" />
<section><title>ToHtml</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/html/ToHtml.java";>ToHtml</link>
example shows how to display a spreadsheet in HTML using the classes
for spreadsheet display.
</p>
</section>
+
+ <anchor id="to-csv" />
<section><title>ToCSV</title>
<p> The <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/ss/examples/ToCSV.java";>ToCSV</link>
example demonstrates <em>one</em> way to convert an Excel spreadsheet
into a CSV file.
</p>
</section>
+ </section>
+
+ <anchor id="hssf-only" />
+ <section><title>HSSF-only Examples</title>
+ <p>All the HSSF-only examples can be found in
+ <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/hssf/examples/";>SVN</link></p>
+ </section>
+
+ <anchor id="xssf-only" />
+ <section><title>XSSF-only Examples</title>
+ <p>All the XSSF-only examples can be found in
+ <link
href="http://svn.apache.org/repos/asf/poi/trunk/src/examples/src/org/apache/poi/xssf/examples/";>SVN</link></p>
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
