Refactored documentation to have a consistent structure as for CCD: Community, Documentation, Code.
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352543 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nicola Ken Barozzi
parent
9ca7a15e0d
commit
c27829f72f
@ -7,51 +7,38 @@
|
|||||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
|
||||||
<menu label="Community">
|
<menu label="Community">
|
||||||
<menu-item label="Index" href="index.html"/>
|
<menu-item label="News" href="news.html"/>
|
||||||
|
<menu-item label="Changes" href="changes.html"/>
|
||||||
|
<menu-item label="To do" href="todo.html"/>
|
||||||
|
<menu-item label="Vision" href="plan/POI20Vision.html"/>
|
||||||
<menu-item label="History and Future" href="historyandfuture.html"/>
|
<menu-item label="History and Future" href="historyandfuture.html"/>
|
||||||
<menu-item label="1.0 Vision" href="plan/POI10Vision.html"/>
|
|
||||||
<menu-item label="2.0 Vision" href="plan/POI20Vision.html"/>
|
|
||||||
<menu-item label="Who we are" href="who.html"/>
|
<menu-item label="Who we are" href="who.html"/>
|
||||||
<menu-item label="Download" href="http://jakarta.apache.org/builds/jakarta-poi/"/>
|
<menu-item label="Resolutions" href="resolutions/index.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu label="Sub-Projects">
|
<menu label="Project">
|
||||||
<menu-item label="Overview" href="overview.html"/>
|
<menu-item label="Overview" href="overview.html"/>
|
||||||
<menu-item label="POIFS" href="poifs/index.html"/>
|
<menu-item label="POIFS" href="poifs/index.html"/>
|
||||||
<menu-item label="HSSF" href="hssf/index.html"/>
|
<menu-item label="HSSF" href="hssf/index.html"/>
|
||||||
<menu-item label="HDF" href="hdf/index.html"/>
|
<menu-item label="HDF" href="hdf/index.html"/>
|
||||||
<menu-item label="HPSF" href="hpsf/index.html"/>
|
<menu-item label="HPSF" href="hpsf/index.html"/>
|
||||||
<menu-item label="POI-Utils" href="utils/index.html"/>
|
<menu-item label="POI-Utils" href="utils/index.html"/>
|
||||||
|
<menu-item label="Download" href="http://jakarta.apache.org/builds/jakarta-poi/"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu label="Docs">
|
<menu label="Docs">
|
||||||
<menu-item label="Javadocs" href="http://jakarta.apache.org/poi/javadocs/"/>
|
<menu-item label="Javadocs" href="http://jakarta.apache.org/poi/javadocs/"/>
|
||||||
<menu-item label="Source" href="http://jakarta.apache.org/poi/javadocs/javasrc/"/>
|
|
||||||
<menu-item label="Changes" href="changes.html"/>
|
|
||||||
<menu-item label="FAQ" href="faq.html"/>
|
<menu-item label="FAQ" href="faq.html"/>
|
||||||
|
<menu-item label="References" href="references/index.html"/>
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<menu label="Code">
|
<menu label="Code">
|
||||||
|
<menu-item label="Source Code" href="http://jakarta.apache.org/poi/javadocs/javasrc/"/>
|
||||||
|
<menu-item label="CVS" href="http://jakarta.apache.org/site/cvsindex.html"/>
|
||||||
|
<menu-item label="Bug Database" href="http://nagoya.apache.org/bugzilla/buglist.cgi?product=POI"/>
|
||||||
<menu-item label="Junit Test Results" href="http://jakarta.apache.org/poi/tests/junit/"/>
|
<menu-item label="Junit Test Results" href="http://jakarta.apache.org/poi/tests/junit/"/>
|
||||||
<menu-item label="Dependency Metrics" href="http://jakarta.apache.org/poi/metrics/jdepend/"/>
|
<menu-item label="Dependency Metrics" href="http://jakarta.apache.org/poi/metrics/jdepend/"/>
|
||||||
<menu-item label="Checkstyle" href="http://jakarta.apache.org/poi/metrics/checkstyle/"/>
|
<menu-item label="Checkstyle Metrics" href="http://jakarta.apache.org/poi/metrics/checkstyle/"/>
|
||||||
</menu>
|
|
||||||
|
|
||||||
<menu label="References">
|
|
||||||
<menu-item label="In The News" href="inthenews.html"/>
|
|
||||||
<menu-item label="Live Sites" href="livesites.html"/>
|
|
||||||
<menu-item label="XLS spec [PDF]" href="http://sc.openoffice.org/excelfileformat.pdf"/>
|
|
||||||
<menu-item label="Apache Cocoon" href="http://xml.apache.org/cocoon/"/>
|
|
||||||
<menu-item label="Resolutions" href="resolutions/index.html"/>
|
|
||||||
</menu>
|
|
||||||
|
|
||||||
<menu label="Get Involved">
|
|
||||||
<menu-item label="Contributing" href="contrib.html"/>
|
|
||||||
<menu-item label="Branching" href="branching.html"/>
|
|
||||||
<menu-item label="Bug Database" href="http://nagoya.apache.org/bugzilla/buglist.cgi?product=POI"/>
|
|
||||||
<menu-item label="Patches" href="http://nagoya.apache.org/bugzilla/buglist.cgi?product=POI&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr"/>
|
|
||||||
<menu-item label="CVS" href="http://jakarta.apache.org/site/cvsindex.html"/>
|
|
||||||
<menu-item label="Mail Lists" href="http://jakarta.apache.org/site/mail.html"/>
|
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
</book>
|
</book>
|
||||||
|
|||||||
@ -1,15 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
|
|
||||||
<package name="org.apache.poi">
|
|
||||||
<class name="Class">
|
|
||||||
To be done
|
|
||||||
</class>
|
|
||||||
<interface name="Interface">
|
|
||||||
To be done
|
|
||||||
</interface>
|
|
||||||
<package name="package">
|
|
||||||
<interface name="int2">
|
|
||||||
To be done
|
|
||||||
</interface>
|
|
||||||
</package>
|
|
||||||
</package>
|
|
||||||
15
src/documentation/xdocs/getinvolved/book.xml
Normal file
15
src/documentation/xdocs/getinvolved/book.xml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "./dtd/book-cocoon-v10.dtd">
|
||||||
|
|
||||||
|
<book software="Poi"
|
||||||
|
title="Poi Project Documentation"
|
||||||
|
copyright="@year@ Poi Project"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
|
||||||
|
<menu label="Get Involved">
|
||||||
|
<menu-item label="Contributing" href="index.html"/>
|
||||||
|
<menu-item label="Branching" href="branching.html"/>
|
||||||
|
<menu-item label="Mail Lists" href="http://jakarta.apache.org/site/mail.html"/>
|
||||||
|
</menu>
|
||||||
|
|
||||||
|
</book>
|
||||||
@ -1,43 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
|
|
||||||
|
|
||||||
<document>
|
|
||||||
<header>
|
|
||||||
<title>Mail Archives</title>
|
|
||||||
<authors>
|
|
||||||
<person name="Robin Green" email="greenrd@hotmail.com"/>
|
|
||||||
<person name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/>
|
|
||||||
</authors>
|
|
||||||
</header>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<section title="Mailing List Archives">
|
|
||||||
<p>
|
|
||||||
There are a number of mailing list archives available.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><strong>poi-user</strong></td>
|
|
||||||
<td><strong>poi-dev</strong></td>
|
|
||||||
<td><strong>Regularly updated?</strong></td>
|
|
||||||
<td><strong>Searchable?</strong></td>
|
|
||||||
<td><strong>Speed</strong></td>
|
|
||||||
<td><strong>Other features?</strong></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><link href="http://www.mail-archive.com/poi-user@jakarta.apache.org">
|
|
||||||
Apache</link></td>
|
|
||||||
<td><link href="http://www.mail-archive.com/poi-dev@jakarta.apache.org">
|
|
||||||
Apache</link></td>
|
|
||||||
<td>Yes</td>
|
|
||||||
<td>?</td>
|
|
||||||
<td>?</td>
|
|
||||||
<td>?</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</document>
|
|
||||||
@ -1,97 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
|
|
||||||
|
|
||||||
<document>
|
|
||||||
<header>
|
|
||||||
<title>Mailing Lists</title>
|
|
||||||
<authors>
|
|
||||||
<person name="Robin Green" email="greenrd@hotmail.com"/>
|
|
||||||
<person name="Nicola Ken Barozzi" email="barozzi@nicolaken.com"/>
|
|
||||||
</authors>
|
|
||||||
</header>
|
|
||||||
|
|
||||||
<body><section title="Important Notice">
|
|
||||||
<p><strong>IMPORTANT: Before posting a question or problem to any mailing list,
|
|
||||||
</strong>please first look at the following resources in this order:</p>
|
|
||||||
<ol>
|
|
||||||
<li><connect href="faq.html">FAQs</connect></li>
|
|
||||||
<li><link href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/">ODP XML links</link>
|
|
||||||
- a wealth of general XML information.</li>
|
|
||||||
<li><connect href="mail-archives.html">Mailing list archives</connect> -
|
|
||||||
a veritable goldmine of Poi-specific information - if you know where to look!</li>
|
|
||||||
</ol>
|
|
||||||
|
|
||||||
<p><strong>IMPORTANT:</strong> Careful postings please.
|
|
||||||
These are high-volume lists, so we all needs ways to help us all
|
|
||||||
work smarter.
|
|
||||||
See tips for <link href="contrib.html#tips">Contributing</link>
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section title="Poi Users">
|
|
||||||
<p><link href="mailto://poi-user-subscribe@jakarta.apache.org">Subscribe</link>
|
|
||||||
<link href="mailto://poi-user-unsubscribe@jakarta.apache.org">Unsubscribe</link>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>The general list, for problems, bug reports, asking for advice on how
|
|
||||||
best to implement a site, comparisons with other frameworks, etc.
|
|
||||||
But don't forget to look in the FAQ first, please!</p>
|
|
||||||
|
|
||||||
<p><strong>This is also not an appropriate list for general Java questions.</strong>
|
|
||||||
Instead try <link href="news:comp.lang.java.help">news:comp.lang.java.help</link>
|
|
||||||
or <link href="http://hotdispatch.com/">http://hotdispatch.com/</link>, for
|
|
||||||
example.</p>
|
|
||||||
|
|
||||||
<p><strong>This is not an appropriate list for general XML questions.</strong>
|
|
||||||
Instead
|
|
||||||
look at the <link href="http://dmoz.org/">ODP</link> for
|
|
||||||
<link href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/">XML/XSL links</link>
|
|
||||||
(such as the excellent <link href="http://www.zvon.org/xxl/XSLTutorial/Books/Book1/index.html">
|
|
||||||
XSL tutorial at Zvon.org</link>) or try the
|
|
||||||
<link href="http://www.mulberrytech.com/xsl/">Mulberrytech XSL list</link>.</p>
|
|
||||||
|
|
||||||
<p><strong>IMPORTANT:</strong> If you are posting about a problem
|
|
||||||
you are having (as most people do), it will aid in finding a
|
|
||||||
speedy resolution if you provide full configuration details
|
|
||||||
(especially the <strong>version number</strong>, but also your
|
|
||||||
operating system, JDK version, etc.), and full details of any
|
|
||||||
errors encountered (including full error messages and stack
|
|
||||||
traces).</p>
|
|
||||||
|
|
||||||
<p>Please also have some consideration for the other users on the list - this is a
|
|
||||||
busy list and we do not appreciate getting the exact same message posted impatiently
|
|
||||||
several times a day/week! Doing so is only likely to make your question answered more
|
|
||||||
slowly, or not at all, not faster.</p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section title="Poi Dev">
|
|
||||||
<p><link href="mailto://poi-dev-subscribe@jakarta.apache.org">Subscribe</link>
|
|
||||||
<link href="mailto://poi-dev-unsubscribe@jakarta.apache.org">Unsubscribe</link>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>This list is for developers <strong>working on</strong> or wanting to work on
|
|
||||||
Poi itself (not developers merely working <strong>with</strong> Poi),
|
|
||||||
for code patches to Poi to be posted (please use <code>diff -u</code> format),
|
|
||||||
and for general Poi questions.</p>
|
|
||||||
|
|
||||||
<p>Note this is <strong>NOT</strong> for general Poi questions like "Why
|
|
||||||
isn't Poi working on my machine?" -
|
|
||||||
please ask those sorts of questions on users list (after reading the
|
|
||||||
FAQ first, of course).</p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section title="Related Mailing Lists">
|
|
||||||
|
|
||||||
<p>(See also <link href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/">
|
|
||||||
ODP XML links</link> for related websites.)</p>
|
|
||||||
<ul>
|
|
||||||
<li><link href="http://xml.apache.org/mail.html">XML Apache Projects</link> -
|
|
||||||
list of mailing lists for all the projects on xml.apache.org.</li>
|
|
||||||
<li>Some servlet engines have their own mailing lists for servlet-engine
|
|
||||||
configuration questions, such as
|
|
||||||
<link href="mailto:tomcat-user-subscribe@jakarta.apache.org">tomcat-user</link> (note it is "user"
|
|
||||||
and not "users").</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</body>
|
|
||||||
</document>
|
|
||||||
17
src/documentation/xdocs/references/book.xml
Normal file
17
src/documentation/xdocs/references/book.xml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "./dtd/book-cocoon-v10.dtd">
|
||||||
|
|
||||||
|
<book software="Poi"
|
||||||
|
title="Poi Project Documentation"
|
||||||
|
copyright="@year@ Poi Project"
|
||||||
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
|
||||||
|
|
||||||
|
<menu label="References">
|
||||||
|
<menu-item label="Live Sites" href="index.html"/>
|
||||||
|
<menu-item label="XLS spec [PDF]" href="http://sc.openoffice.org/excelfileformat.pdf"/>
|
||||||
|
<menu-item label="Apache Cocoon" href="http://xml.apache.org/cocoon/"/>
|
||||||
|
</menu>
|
||||||
|
|
||||||
|
|
||||||
|
</book>
|
||||||
Loading…
Reference in New Issue
Block a user