Prepare documentation for 1.1 release
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@280438 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/project.properties b/project.properties
index 4f2f4b1..56260c2 100644
--- a/project.properties
+++ b/project.properties
@@ -25,3 +25,5 @@
maven.javadoc.additionalparam=-tag todo:a:"To Do:"
maven.jdiff.old.tag=IO_1_0
+maven.xdoc.copy.excludes=images/file.gif,images/folder-closed.gif,images/folder-open.gif,images/icon_alert.gif,images/icon_alertsml.gif,images/icon_arrowfolder1_sml.gif,images/icon_arrowfolder2_sml.gif,images/icon_arrowmembers1_sml.gif,images/icon_arrowmembers2_sml.gif,images/icon_arrowusergroups1_sml.gif,images/icon_arrowusergroups2_sml.gif,images/icon_confirmsml.gif,images/icon_help_lrg.gif,images/icon_infosml.gif,images/icon_members_sml.gif,images/icon_sortleft.gif,images/icon_sortright.gif,images/icon_usergroups_sml.gif,images/icon_waste_lrg.gif,images/icon_waste_sml.gif,images/none.png,images/nw_maj.gif,images/nw_maj_hi.gif,images/nw_med.gif,images/nw_med_hi.gif,images/nw_med_rond.gif,images/nw_min.gif,images/nw_min_036.gif,images/nw_min_hi.gif,images/poweredby_036.gif,images/product_logo.gif,images/se_maj_rond.gif,images/sw_min.gif,images/logos/**
+maven.xdoc.copy.excludes.classic=images/external-classic.png,images/help_logo.gif,images/icon_arrowfolderclosed1_sml.gif,images/icon_arrowwaste1_sml.gif,images/icon_arrowwaste2_sml.gif,images/icon_doc_lrg.gif,images/icon_doc_sml.gif,images/icon_error_lrg.gif,images/icon_folder_lrg.gif,images/icon_folder_sml.gif,images/icon_help_sml.gif,images/icon_info_lrg.gif,images/icon_members_lrg.gif,images/icon_sortdown.gif,images/icon_sortup.gif,images/icon_success_lrg.gif,images/icon_usergroups_lrg.gif,images/icon_arrowfolderopen2_sml.gif,images/icon_warning_lrg.gif,images/newwindow-classic.png,images/nw_maj_rond.gif,images/strich.gif,images/sw_maj_rond.gif,images/sw_med_rond.gif
diff --git a/project.xml b/project.xml
index 2821a9d..1f48eed 100644
--- a/project.xml
+++ b/project.xml
@@ -118,10 +118,11 @@
<developer>
<name>Stephen Colebourne</name>
<id>scolebourne</id>
- <organization>SITA ATS</organization>
+ <organization></organization>
<roles>
<role>Java Developer</role>
</roles>
+ <timezone>0</timezone>
</developer>
<developer>
<name>Jeremias Maerki</name>
@@ -189,10 +190,10 @@
</contributors>
<dependencies>
- <dependency>
+ <!--dependency>
<id>junit</id>
<version>3.8.1</version>
- </dependency>
+ </dependency-->
</dependencies>
<build>
diff --git a/xdocs/bestpractices.xml b/xdocs/bestpractices.xml
index c7829c4..57ce8de 100644
--- a/xdocs/bestpractices.xml
+++ b/xdocs/bestpractices.xml
@@ -1,11 +1,24 @@
<?xml version="1.0"?>
-
<!--
- Building IO
- $Id$
--->
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
+ <properties>
+ <title>Best practices</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
<body>
<section name="Overview">
diff --git a/xdocs/building.xml b/xdocs/building.xml
index 59287f4..e7f9aad 100644
--- a/xdocs/building.xml
+++ b/xdocs/building.xml
@@ -1,11 +1,25 @@
<?xml version="1.0"?>
-
<!--
- Building IO
- $Id$
--->
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
+ <properties>
+ <title>Building</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+
<body>
<section name="Overview">
diff --git a/xdocs/changes.xml b/xdocs/changes.xml
index 1a60093..f836f2a 100644
--- a/xdocs/changes.xml
+++ b/xdocs/changes.xml
@@ -1,8 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
- <properties>
- <title>Changes</title>
- </properties>
+ <properties>
+ <title>Changes</title>
+ </properties>
<body>
<release version="1.0-dev" date="in CVS">
<action dev="jeremias" type="remove">
diff --git a/xdocs/description.xml b/xdocs/description.xml
index 2cec8cd..843c298 100755
--- a/xdocs/description.xml
+++ b/xdocs/description.xml
@@ -1,15 +1,24 @@
<?xml version="1.0"?>
-
<!--
- Main index
- $Id$
--->
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
<properties>
- <title>About Commons IO</title>
- <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
- </properties>
+ <title>User guide</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
<body>
<section name="Commons IO">
@@ -26,19 +35,12 @@
</section>
<section name="Utility classes">
- <subsection name="CopyUtils and IOUtils">
- <p>
- <code>org.apache.commons.io.CopyUtils</code>
- contains a comprehensive set of static methods for copying
- from String, byte[], InputStream, Reader
- to OutputStream, Writer.
- </p>
+ <subsection name="IOUtils">
<p>
<code>org.apache.commons.io.IOUtils</code>
- contains additional IO-related tools for safely closing streams
- and creating Strings and byte arrays from streams and Readers.
+ contains utility methods dealing with reading, writing and copying.
+ The methods work on InputStream, OutputStream, Reader and Writer.
</p>
-
<p>
As an example, consider the task of reading bytes
from a URL, and printing them. This would typically done like this:
@@ -83,12 +85,29 @@
<subsection name="FileUtils">
<p>
- The <code>org.apache.commons.io.FileUtils</code>
- class contains methods for retrieving different components of a file path
- (directory name, file base name, file extension), methods
- for copying files to other files and directories, and methods
- for querying, deleting and cleaning directories. For more information,
- see the class description.
+ The <code>org.apache.commons.io.FileUtils</code> class contains
+ utility methods for working with File objects.
+ These include reading, writing, copying and comparing files.
+ </p>
+ </subsection>
+
+ <subsection name="FilenameUtils">
+ <p>
+ The <code>org.apache.commons.io.FilenameUtils</code> class contains
+ utility methods for working with filenames <i>without</i>
+ using File objects. The class aims to be consistent
+ between Unix and Windows, to aid transitions between these
+ environments (such as moving from development to production).
+ </p>
+ </subsection>
+
+ <subsection name="FileSystemUtils">
+ <p>
+ The <code>org.apache.commons.io.FileSystemUtils</code> class contains
+ utility methods for working with the file system
+ to access functionality not supported by the JDK.
+ Currently, the only method is to get the free space on a drive.
+ Note that this uses the command line, not native code.
</p>
</subsection>
diff --git a/xdocs/index.xml b/xdocs/index.xml
index e002a7d..c1e621c 100755
--- a/xdocs/index.xml
+++ b/xdocs/index.xml
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
-Copyright 2002-2004 The Apache Software Foundation.
+Copyright 2002-2005 The Apache Software Foundation.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -14,62 +14,63 @@
See the License for the specific iouage governing permissions and
limitations under the License.
-->
-
<document>
-
<properties>
- <title>Commons IO</title>
+ <title>Home</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
-
- <body>
-
+<body>
+<!-- ================================================== -->
<section name="Commons IO">
-
<p>
+Commons IO is a library of utilities to assist with developing IO functionality.
+There are three main areas included:
+<ul>
+<li>Utility classes - with static methods to perform common tasks</li>
+<li>Filters - various implementations of file filters</li>
+<li>Streams - useful stream, reader and writer implementations</li>
+</ul>
</p>
</section>
-
-<section name="Latest Release">
-<p>The latest release of Apache Jakarta Commons IO is version 1.0. It is available (from mirrors) in <a href="http://jakarta.apache.org/site/binindex.cgi#commons-io">binary</a> and <a href="http://jakarta.apache.org/site/sourceindex.cgi#commons-io">source</a> downloads. </p>
-</section>
-
+<!-- ================================================== -->
<section name="Documentation">
<p>
-A top level description of some of the classes to be found in the IO component is available - <a href="description.html">Description</a>.
+A getting started <a href="description.html">user guide</a> is available.
</p>
-
<p>
-The <a href="http://jakarta.apache.org/commons/io/apidocs/index.html">JavaDoc API documents</a> are available online.
+The JavaDoc API documents are available online:
+</p>
+<ul>
+<li>The <a href="api-release/index.html">current release 1.1</a></li>
+<li>The <a href="api-1.0/index.html">previous version 1.0</a></li>
+<li>The <a href="apidocs/index.html">latest SVN</a></li>
+</ul>
+<p>
+The <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/">SVN repository</a> can be browsed.
</p>
</section>
-
+<!-- ================================================== -->
+<section name="Releases">
+<p>
+The latest version is v1.1. -
+<a href="http://jakarta.apache.org/site/downloads/downloads_commons-io.cgi">Download now!</a>
+</p>
+<p>
+For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/io/">Apache Archive</a>
+</p>
+</section>
+<!-- ================================================== -->
<section name="Bugs">
<p>
Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
</p>
<ul>
- <li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
- <li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons">Submit a bug report</a></li>
- <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
- <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
+<li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
+<li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=IO&version=3.0%20Final">Submit a bug report</a></li>
+<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
+<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
</ul>
</section>
-
-<section name="Releases">
-<ul>
-<li><a href="http://jakarta.apache.org/site/binindex.cgi#commons-io">Version 1.0</a></li>
-</ul>
-</section>
-
-<section name="Repository">
-<ul>
-<li>
-<a href="http://cvs.apache.org/viewcvs/jakarta-commons/io/">CVS Repository</a>
-</li>
-</ul>
-</section>
-
+<!-- ================================================== -->
</body>
</document>
-
diff --git a/xdocs/navigation.xml b/xdocs/navigation.xml
index 2df909a..8c4f1ea 100644
--- a/xdocs/navigation.xml
+++ b/xdocs/navigation.xml
@@ -10,16 +10,22 @@
</links>
<menu name="Commons IO">
- <item name="Overview" href="index.html"/>
- <item name="Description" href="description.html"/>
- <item name="Javadoc" href="apidocs/index.html"/>
- <item name="Best practices" href="bestpractices.html"/>
- <item name="Building" href="building.html"/>
- <item name="Mailing lists" href="mail-lists.html"/>
- <item name="Team" href="team-list.html"/>
- <item name="Tasks" href="tasks.html"/>
- <item name="Proposal" href="proposal.html"/>
- <item name="CVS" href="http://cvs.apache.org/viewcvs/jakarta-commons/io/"/>
+ <item name="Overview" href="/index.html"/>
+ <item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-io.cgi"/>
+ <item name="Users guide" href="/description.html"/>
+ <item name="Best practices" href="/bestpractices.html"/>
+ <!--item name="History" href="/history.html"/-->
+ <item name="Javadoc (1.1 release)" href="api-release/index.html"/>
+ </menu>
+
+ <menu name="Development">
+ <item name="Building" href="/building.html"/>
+ <item name="Mailing lists" href="/mail-lists.html"/>
+ <item name="Team" href="/team-list.html"/>
+ <item name="Tasks" href="/tasks.html"/>
+ <item name="Proposal" href="/proposal.html"/>
+ <item name="SVN repository" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/"/>
+ <item name="Javadoc (SVN latest)" href="apidocs/index.html"/>
</menu>
&common-menus;
diff --git a/xdocs/proposal.xml b/xdocs/proposal.xml
index e3b9042..1e4c86f 100644
--- a/xdocs/proposal.xml
+++ b/xdocs/proposal.xml
@@ -1,10 +1,25 @@
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="xdoc.xsl"?>
-<!-- $Revision$ $Date$ -->
+<!--
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
-<properties>
- <title>Proposal for IO Package</title>
-</properties>
+ <properties>
+ <title>Proposal</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
<body>
diff --git a/xdocs/style/maven.css b/xdocs/style/maven.css
new file mode 100644
index 0000000..6addb4c
--- /dev/null
+++ b/xdocs/style/maven.css
@@ -0,0 +1,114 @@
+body {
+ background: #fff;
+ color: #000;
+ }
+
+.app h3 {
+ color: #fff;
+ background-color: #036;
+ }
+
+.app h4 {
+ color: #fff;
+ background-color: #888;
+ }
+
+.a td {
+ background: #ddd;
+ color: #000;
+ }
+
+.b td {
+ background: #efefef;
+ color: #000;
+ }
+
+.app th {
+ background-color: #bbb;
+ color: #fff;
+ }
+
+div#banner {
+ border-top: 1px solid #369;
+ border-bottom: 1px solid #003;
+ }
+
+#banner, #banner td {
+ background: #036;
+ color: #fff;
+ }
+
+#leftcol {
+ background: #eee;
+ color: #000;
+ border-right: 1px solid #aaa;
+ border-bottom: 1px solid #aaa;
+ border-top: 1px solid #fff;
+}
+
+#navcolumn {
+ background: #eee;
+ color: #000;
+ border-right: none;
+ border-bottom: none;
+ border-top: none;
+ }
+
+#breadcrumbs {
+ background-color: #ddd;
+ color: #000;
+ border-top: 1px solid #fff;
+ border-bottom: 1px solid #aaa;
+ }
+
+#source {
+ background-color: #fff;
+ color: #000;
+ border-right: 1px solid #888;
+ border-left: 1px solid #888;
+ border-top: 1px solid #888;
+ border-bottom: 1px solid #888;
+ margin-right: 7px;
+ margin-left: 7px;
+ margin-top: 1em;
+ }
+
+#source pre {
+ margin-right: 7px;
+ margin-left: 7px;
+ }
+
+a[name]:hover, #leftcol a[name]:hover {
+ color: inherit !important;
+ }
+
+a:link, #breadcrumbs a:visited, #navcolumn a:visited, .app a:visited, .tasknav a:visited {
+ color: blue;
+ }
+
+a:active, a:hover, #leftcol a:active, #leftcol a:hover {
+ color: #f30 !important;
+ }
+
+a:link.selfref, a:visited.selfref {
+ color: #555 !important;
+ }
+
+h3, h4 {
+ margin-top: 1em;
+ margin-bottom: 0;
+ }
+
+img.handle {
+ border: 0;
+ padding-right: 2px;
+}
+
+#navcolumn div div {
+ background-image: none;
+ background-repeat: no-repeat;
+}
+
+#navcolumn div div {
+ padding-left: 10px;
+}
diff --git a/xdocs/style/print.css b/xdocs/style/print.css
new file mode 100644
index 0000000..3a607ad
--- /dev/null
+++ b/xdocs/style/print.css
@@ -0,0 +1,7 @@
+#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks {
+ display: none;
+ }
+body.docs div.docs {
+ margin: 0 !important;
+ border: none !important
+ }
diff --git a/xdocs/style/tigris.css b/xdocs/style/tigris.css
new file mode 100644
index 0000000..c292963
--- /dev/null
+++ b/xdocs/style/tigris.css
@@ -0,0 +1,789 @@
+/* $Id: tigris.css 201919 2005-06-26 22:39:42Z psteitz $
+
+ This file defines basic default formatting for HTML conforming to Tigris application style. To extend or override these rules for your instance, edit inst.css instead of this file. */
+
+/* colors, backgrounds, borders, link indication */
+body {
+ background: #fff;
+ color: #000;
+}
+
+.app h3, .app h4, .tabs td, .tabs th, .functnbar {
+ background-image: url(../images/nw_maj_rond.gif);
+ background-repeat: no-repeat;
+}
+
+.functnbar, .functnbar2 {
+ background-color: #aaa;
+}
+
+.functnbar2, .functnbar3 {
+ background-color: #aaa;
+ background-image: url(../images/sw_maj_rond.gif);
+ background-repeat: no-repeat;
+ background-position: bottom left;
+}
+
+.functnbar3 {
+ background-color: #ddd;
+ background-image: url(../images/sw_med_rond.gif);
+}
+
+.functnbar, .functnbar2, .functnbar3 {
+ color: #000;
+}
+
+.functnbar a, .functnbar2 a, .functnbar3 a {
+ color: #000;
+ text-decoration: underline;
+}
+
+#navcolumn .body div, body.docs #toc li li {
+ background-image: url(../images/strich.gif);
+ background-repeat: no-repeat;
+ background-position: .5em .5em;
+}
+
+#searchbox .body div, #navcolumn .body .heading {
+ background-image: none;
+}
+
+a:link, #navcolumn a:visited, .app a:visited, .tasknav a:visited {
+ color: blue;
+}
+
+a:link.selfref, a:visited.selfref {
+ color: #555 !important;
+ text-decoration: none;
+}
+
+a:active, a:hover, #leftcol a:active, #leftcol a:hover {
+ color: #f30 !important;
+}
+
+#leftcol a, #breadcrumbs a {
+ text-decoration: none;
+}
+
+.app h3, .app h4 {
+ color: #fff;
+}
+
+.app h3 {
+ background-color: #333;
+}
+
+.app h3 a:link, .app h3 a:visited, .app h4 a:link, .app h4 a:visited {
+ color: #fff !important;
+ text-decoration: underline;
+}
+
+.app h4 {
+ background-color: #888;
+}
+
+.a td {
+ background: #ddd;
+}
+
+.b td {
+ background: #efefef;
+}
+
+table, th, td {
+ border: none;
+}
+
+div.colbar {
+ background: #eee;
+ border-color: #999 #EEE #EEE #999;
+ border-width: 1px;
+ border-style: solid;
+}
+
+.toolgroup {
+ background: #efefef;
+}
+
+.toolgroup .label {
+ border-bottom: 1px solid #666;
+ border-right: 1px solid #666;
+ background: #ddd;
+ color: #555;
+}
+
+.toolgroup .body {
+ border-right: 1px solid #aaa;
+ border-bottom: 1px solid #aaa;
+}
+
+#breadcrumbs {
+ border-top: 1px solid #fff;
+ background-color: #ccc;
+}
+
+#main {
+ border-top: 1px solid #999;
+}
+
+#rightcol div.www, #rightcol div.help {
+ border: 1px solid #ddd;
+}
+
+body.docs div.docs {
+ background-color: #fff;
+ border-left: 1px solid #ddd;
+ border-top: 1px solid #ddd;
+}
+
+#helptext .label {
+ background-image: url(../images/icon_help_sml.gif);
+ background-repeat: no-repeat;
+ background-position: 97%;
+}
+
+body.docs {
+ background: #eee url(../images/help_logo.gif) top right no-repeat !important;
+}
+
+.docs h3, .docs h4 {
+ border-top: solid 1px #000;
+}
+
+#apphead h2 em {
+ color: #777;
+}
+
+.app th {
+ background-color: #bbb;
+}
+
+.tabs th {
+ border-right: 1px solid #333;
+ background-color: #ddd;
+ color: #fff;
+ border-left: 1px solid #fff;
+}
+
+.tabs td {
+ background-color: #999;
+ border-bottom: 1px solid #fff;
+ border-right: 1px solid #fff;
+ border-left: 1px solid #fff;
+}
+
+.tabs {
+ border-bottom: 6px #ddd solid;
+}
+
+.tabs th, .tabs th a:link, .tabs th a:visited {
+ color: #555;
+}
+
+.tabs td, .tabs td a:link, .tabs td a:visited {
+ color: #fff;
+}
+
+.tabs a {
+ text-decoration: none;
+}
+
+.axial th {
+ background-color: #ddd;
+ color: black;
+}
+
+.alert {
+ background-color: #ff9;
+}
+
+.expandedwaste {
+ background: url(../images/icon_arrowwaste2_sml.gif) no-repeat;
+}
+
+.collapsedwaste {
+ background: url(../images/icon_arrowwaste1_sml.gif) no-repeat;
+}
+
+.filebrowse .expanded, .filebrowse-alt .expanded {
+ background-image: url(../images/icon_arrowfolderopen2_sml.gif);
+ background-repeat: no-repeat;
+}
+
+.filebrowse .collapsed, .filebrowse-alt .collapsed {
+ background-image: url(../images/icon_arrowfolderclosed1_sml.gif);
+ background-repeat: no-repeat;
+}
+
+.filebrowse .leafnode, .filebrowse-alt .leafnode {
+ background-image: url(../images/icon_folder_sml.gif);
+ background-repeat: no-repeat;
+}
+
+.filebrowse .leaf, .filebrowse-alt .leaf {
+ background-image: url(../images/icon_doc_sml.gif);
+ background-repeat: no-repeat;
+}
+
+.sortup {
+ background: url(../images/icon_sortup.gif) no-repeat;
+}
+
+.sortdown {
+ background: url(../images/icon_sortdown.gif) no-repeat;
+}
+
+.collapsedwaste {
+ background: url(../images/icon_arrowwaste1_sml.gif) no-repeat;
+}
+
+body .grid td {
+ border-top: 1px solid #ccc;
+ border-left: 1px solid #ccc;
+ background-color: transparent;
+}
+
+.confirm {
+ color: #090;
+}
+
+.info {
+ color: #069;
+}
+
+.errormessage, .warningmessage, .donemessage, .infomessage {
+ border-top: 5px solid #900;
+ border-left: 1px solid #900;
+ background-image: url(../images/icon_error_lrg.gif);
+ background-repeat: no-repeat;
+ background-position: 5px 1.33em;
+}
+
+.warningmessage {
+ background-image: url(../images/icon_warning_lrg.gif);
+ border-color: #c60;
+}
+
+.donemessage {
+ background-image: url(../images/icon_success_lrg.gif);
+ border-color: #090;
+}
+
+.infomessage {
+ background-image: url(../images/icon_info_lrg.gif);
+ border-color: #069;
+}
+
+.docinfo {
+ background: url(../images/icon_doc_lrg.gif) no-repeat;
+}
+
+.dirinfo {
+ background: url(../images/icon_folder_lrg.gif) no-repeat;
+}
+
+.memberinfo {
+ background: url(../images/icon_members_lrg.gif) no-repeat;
+}
+
+.usergroupinfo {
+ background: url(../images/icon_usergroups_lrg.gif) no-repeat;
+}
+
+.errormark, .warningmark, .donemark, .infomark {
+ background: url(../images/icon_error_sml.gif) no-repeat;
+}
+
+.warningmark {
+ background-image: url(../images/icon_warning_sml.gif);
+}
+
+.donemark {
+ background-image: url(../images/icon_success_sml.gif);
+}
+
+.infomark {
+ background-image: url(../images/icon_info_sml.gif);
+}
+
+.cvsdiff, .cvsblame {
+ background-color: #ccc;
+}
+
+.cvsdiffadd {
+ background-color: #afa;
+}
+
+.cvsdiffremove {
+ background-color: #faa;
+}
+
+.cvsdiffchanges1 {
+ background-color: #ff7;
+}
+
+.cvsdiffchanges2 {
+ background-color: #ff7;
+}
+
+li.selection ul a {
+ background: #fff;
+}
+
+.band1 {
+ color: #fff;
+ background-color: #663;
+}
+
+.band2 {
+ color: #fff;
+ background-color: #66C;
+}
+
+.band3 {
+ background-color: #C99;
+}
+
+.band4 {
+ background-color: #CFF;
+}
+
+.band5 {
+ color: #fff;
+ background-color: #336;
+}
+
+.band6 {
+ color: #fff;
+ background-color: #966;
+}
+
+.band7 {
+ background-color: #9CC;
+}
+
+.band8 {
+ background-color: #FFC;
+}
+
+.band9 {
+ color: #fff;
+ background-color: #633;
+}
+
+.band10 {
+ color: #fff;
+ background-color: #699;
+}
+
+.band11 {
+ background-color: #CC9;
+}
+
+.band12 {
+ background-color: #CCF;
+}
+
+.band13 {
+ color: #fff;
+ background-color: #366;
+}
+
+.band14 {
+ color: #fff;
+ background-color: #996;
+}
+
+.band15 {
+ background-color: #99C;
+}
+
+.band16 {
+ background-color: #FCC;
+}
+
+.app .helplink, #helptext .helplink {
+ cursor: help;
+}
+
+.legend th, .bars th {
+ background-color: #fff;
+}
+
+/* font and text properties, exclusive of link indication, alignment, text-indent */
+body, th, td, input, select {
+ font-family: Verdana, Helvetica, Arial, sans-serif;
+}
+
+code, pre {
+ font-family: 'Andale Mono', Courier, monospace;
+}
+
+body, .app h3, .app h4, #rightcol h3, pre, code, #apphead h2 small, h4, th, td {
+ font-size: x-small;
+ voice-family: "\"}\"";
+ voice-family: inherit;
+ font-size: small;
+}
+
+small, div#footer, div#login, div.tabs th, div.tabs td, input, select, .paginate, .functnbar, .functnbar2, .functnbar3, #breadcrumbs, .courtesylinks, #rightcol div.help, .colbar, .tasknav, body.docs div#toc, #leftcol, .legend, .bars {
+ font-size: xx-small;
+ voice-family: "\"}\"";
+ voice-family: inherit;
+ font-size: x-small;
+}
+
+.tabs td, .tabs th, dt, .tasknav .selfref, #login .username, .selection {
+ font-weight: bold;
+}
+
+li.selection ul {
+ font-weight: normal;
+}
+
+#apphead h2 em {
+ font-style: normal;
+}
+
+#banner h1 {
+ font-size: 1.25em;
+}
+
+/* box properties (exclusive of borders), positioning, alignments, list types, text-indent */
+#bodycol h2 {
+ margin-top: .3em;
+ margin-bottom: .5em;
+}
+
+p, ul, ol, dl, .bars table {
+ margin-top: .67em;
+ margin-bottom: .67em;
+}
+
+h3, h4 {
+ margin-bottom: 0;
+}
+
+form {
+ margin: 0;
+}
+
+#bodycol {
+ padding-left: 12px;
+ padding-right: 12px;
+ width: 100%;
+ voice-family: "\"}\"";
+ voice-family: inherit;
+ width: auto;
+}
+
+html>body #bodycol {
+ width: auto;
+}
+
+.docs {
+ line-height: 1.4;
+}
+
+ol ol {
+ list-style-type: lower-alpha;
+}
+
+ol ol ol {
+ list-style-type: lower-roman;
+}
+
+.app h3, .app h4 {
+ padding: 5px;
+ margin-right: 2px;
+ margin-left: 2px;
+}
+
+.app td, .app th {
+ padding: 2px 3px;
+}
+
+.h3 p, .h4 p, .h3 dt, .h4 dt {
+ margin-right: 7px;
+ margin-left: 7px;
+}
+
+.tasknav {
+ margin-bottom: 1.33em;
+}
+
+div.colbar {
+ padding: 3px;
+ margin: 2px 2px 0;
+}
+
+.tabs {
+ margin-top: .67em;
+ margin-right: 2px;
+ margin-left: 2px;
+ padding-left: 8px;
+}
+
+.tabs td, .tabs th {
+ padding: 3px 9px;
+}
+
+#rightcol div.www, #rightcol div.help {
+ padding: 0 .5em;
+}
+
+body.docs #toc {
+ position: absolute;
+ top: 15px;
+ left: 0px;
+ width: 120px;
+ padding: 0 20px 0 0;
+}
+
+body.docs #toc ul, #toc ol {
+ margin-left: 0;
+ padding-left: 0;
+}
+
+body.docs #toc li {
+ margin-top: 7px;
+ padding-left: 10px;
+ list-style-type: none;
+}
+
+body.docs div.docs {
+ margin: 61px 0 0 150px;
+ padding: 1em 2em 1em 1em !important;
+}
+
+.docs p+p {
+ text-indent: 5%;
+ margin-top: -.67em;
+}
+
+.docs h3, .docs h4 {
+ margin-bottom: .1em;
+ padding-top: .3em;
+}
+
+.functnbar, .functnbar2, .functnbar3 {
+ padding: 5px;
+ margin: .67em 2px;
+}
+
+.functnbar3 {
+ margin-top: 0;
+}
+
+body {
+ padding: 1em;
+}
+
+body.composite, body.docs {
+ margin: 0;
+ padding: 0;
+}
+
+th, td {
+ text-align: left;
+ vertical-align: top;
+}
+
+.right {
+ text-align: right !important;
+}
+
+.center {
+ text-align: center !important;
+}
+
+.axial th, .axial th .strut {
+ text-align: right;
+}
+
+.app .axial td th {
+ text-align: left;
+}
+
+body .stb {
+ margin-top: 1em;
+ text-indent: 0;
+}
+
+body .mtb {
+ margin-top: 2em;
+ text-indent: 0;
+}
+
+.courtesylinks {
+ margin-top: 1em;
+ padding-top: 1em;
+}
+
+dd {
+ margin-bottom: .67em;
+}
+
+.toolgroup {
+ margin-bottom: 6px;
+}
+
+.toolgroup .body {
+ padding: 4px 4px 4px 0;
+}
+
+.toolgroup .label {
+ padding: 4px;
+}
+
+.toolgroup .body div {
+ padding-bottom: .3em;
+ padding-left: 1em;
+}
+
+.toolgroup .body div div {
+ margin-top: .3em;
+ padding-bottom: 0;
+}
+
+.tier1 {
+ margin-left: 0;
+}
+
+.tier2 {
+ margin-left: 1.5em;
+}
+
+.tier3 {
+ margin-left: 3em;
+}
+
+.tier4 {
+ margin-left: 4.5em;
+}
+
+.tier5 {
+ margin-left: 6em;
+}
+
+.tier6 {
+ margin-left: 7.5em;
+}
+
+.tier7 {
+ margin-left: 9em;
+}
+
+.tier8 {
+ margin-left: 10.5em;
+}
+
+.tier9 {
+ margin-left: 12em;
+}
+
+.tier10 {
+ margin-left: 13.5em;
+}
+
+.filebrowse .expanded, .filebrowse .collapsed {
+ padding-left: 34px;
+}
+
+.filebrowse .leafnode, .filebrowse .leaf {
+ padding-left: 20px;
+}
+
+.messagechild {
+ padding-left: 34px;
+}
+
+.filebrowse-alt .expanded, .filebrowse-alt .collapsed, .filebrowse-alt .leaf, .filebrowse-alt .leafnode, .expandedwaste, .collapsedwaste, .sortup, .sortdown {
+ /* hide from macie5\*/
+ float: left;
+ /* resume */
+ display: inline-block;
+ height: 15px;
+ width: 34px;
+ padding-left: 0 !important;
+}
+
+.filebrowse-alt .leaf, .filebrowse-alt .leafnode, .sortup, .sortdown {
+ width: 20px;
+}
+
+.filebrowse ul, .filebrowse-alt ul {
+ list-style-type: none;
+ padding-left: 0;
+ margin-left: 0;
+}
+
+.filebrowse ul ul, .filebrowse-alt ul ul {
+ margin-left: 1.5em;
+ margin-top: 0;
+ padding-top: .67em;
+}
+
+.filebrowse li, .filebrowse-alt li {
+ margin-bottom: .67em;
+}
+
+td.filebrowse h3 {
+ margin-top: 0;
+}
+
+.errormessage, .warningmessage, .donemessage, .infomessage, .docinfo, .dirinfo, .memberinfo, .usergroupinfo {
+ margin: .67em 0;
+ padding: .33em 0 .67em 42px;
+ min-height: 32px;
+}
+
+.errormark, .warningmark, .donemark, .infomark {
+ padding-left: 20px;
+ min-height: 15px;
+}
+
+.alt {
+ display: none;
+}
+
+#banner h1 {
+ margin: 0;
+}
+
+#leftcol {
+ width: 14em;
+}
+
+.axial th, .axial th .strut, #leftcol .strut {
+ width: 12em;
+}
+
+#breadcrumbs {
+ padding: 2px 8px;
+}
+
+.app h3, .app h4, .bars {
+ clear: both;
+}
+
+.legend {
+ float: right;
+}
+
+.legend th, .bars th {
+ text-align: right;
+ padding-left: 1em;
+}
+
+.bars table {
+ table-layout: fixed;
+}
+
+.bars th {
+ width: 12em;
+}
+
+#projectdocumentlist td.filebrowse-alt {
+ padding-right: .75em;
+}
diff --git a/xdocs/tasks.xml b/xdocs/tasks.xml
index 559fd5e..6d7f87d 100644
--- a/xdocs/tasks.xml
+++ b/xdocs/tasks.xml
@@ -1,5 +1,24 @@
<?xml version="1.0"?>
+<!--
+Copyright 2002-2005 The Apache Software Foundation.
+
+Licensed 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 iouage governing permissions and
+limitations under the License.
+-->
<document>
+ <properties>
+ <title>Tasks</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
<body>
<section name="Tasks and Ideas for the future">
<p>
@@ -12,13 +31,7 @@
<li>JoinReader/ConcatReader. One in GenJava, one submitted to Bayard</li>
<li>FormattedWriter, when it writes out values it uses Format objects to output them. </li>
<li>FixedWidthReader. Reads in files with a known width, ie) mainframe like. </li>
- <li>Add an additional ByteArrayOutputStream variant that saves content
- in memory just as the original but starts to write to a temp file when
- a given number of bytes is surpassed. This is to reduce the memory
- usage for big "things".</li>
<li>FileUtils could use a copyDirectory() method (possibly making use of IOFileFilters)</li>
- <li>A CsvReader/Writer set of classes in a csv sub-package. Will probably be commons-csv.</li>
- <li>A Finder system. This may becomes commons-finder. </li>
</ul>
</section>
</body>
diff --git a/xdocs/userguide.xml b/xdocs/userguide.xml
deleted file mode 100644
index f3dc408..0000000
--- a/xdocs/userguide.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version="1.0"?>
-<!--
-Copyright 2002-2004 The Apache Software Foundation.
-
-Licensed 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>Commons IO - Users guide</title>
- <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
- </properties>
-
- <body>
-
- <section name="io.*">
- <p>The top level of the IO component contains two Utils, FileUtils and IOUtil that are of use to all programmers. It also contains an EndianUtils class which is slightly more specialised.</p>
- <p>IOUtil is generally concerned with copying between input and output and converting between Strings and byte[]. </p>
- <p>FileUtil is obviously concerned with handling lots of nice things to do with Files. Copying, removing, enquiring as to meta-data etc.</p>
- <p>EndianUtils helps developers to work between Big/Little Endian files. </p>
- <p>The top level also contains two Proxy classes, ProxyInputStream and ProxyOutputStream. These exist because FilterInputStream and FilterOutputStream obscure their implementation by switching around the methods which they call. The Proxy classes are more honest, calling the same method as was called on themselves. This makes implementing a Proxy/Filter a lot easier. </p>
- </section>
-
- <section name="io.filefilter.*">
- <p>The filefilter subpackage contains a small set of filters, perhaps more importantly they also contain an interface framework which merges the java.io.FilenameFilter and java.io.FileFilter interfaces together with Lang's Predicate interface. The FileFilterUtils class provides a facade to the PredicateUtils allowing such things as an AndFileFilter to be handled by Lang's Predicates. </p>
- </section>
-
- <section name="io.output.*">
- <p>IO contains an output package containing Writers and OutputStreams. HexDump, FormattedWriter, TeeOutputStream, LockableFileWriter, DemuxOutputStream and CountingOutputStream are currently in the output package.</p>
- </section>
- <section name="io.input.*">
- <p>IO contains an input package containing Readers and InputStreams. ClassLoaderObjectInputStream, DemuxInputStream, SwappedDataInputStream and CountingInputStream are the current inhabitants of input.</p>
- </section>
-
- <section name="Next version of IO">
- <p>IO 1.1 will be the next release for this component, consisting of various bugfixes concerning the 1.0 release. </p>
- </section>
-
- </body>
-
-</document>
