Skip to content

Commit b074ab1

Browse files
author
Stephen Colebourne
committed
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
1 parent cc65593 commit b074ab1

14 files changed

Lines changed: 1103 additions & 146 deletions

‎project.properties‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4/docs/api/
2525
maven.javadoc.additionalparam=-tag todo:a:"To Do:"
2626

2727
maven.jdiff.old.tag=IO_1_0
28+
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/**
29+
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

‎project.xml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,11 @@
118118
<developer>
119119
<name>Stephen Colebourne</name>
120120
<id>scolebourne</id>
121-
<organization>SITA ATS</organization>
121+
<organization></organization>
122122
<roles>
123123
<role>Java Developer</role>
124124
</roles>
125+
<timezone>0</timezone>
125126
</developer>
126127
<developer>
127128
<name>Jeremias Maerki</name>
@@ -189,10 +190,10 @@
189190
</contributors>
190191

191192
<dependencies>
192-
<dependency>
193+
<!--dependency>
193194
<id>junit</id>
194195
<version>3.8.1</version>
195-
</dependency>
196+
</dependency-->
196197
</dependencies>
197198

198199
<build>

‎xdocs/bestpractices.xml‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
<?xml version="1.0"?>
2-
32
<!--
4-
Building IO
5-
$Id$
6-
-->
3+
Copyright 2002-2005 The Apache Software Foundation.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
78
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific iouage governing permissions and
15+
limitations under the License.
16+
-->
817
<document>
18+
<properties>
19+
<title>Best practices</title>
20+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
21+
</properties>
922
<body>
1023

1124
<section name="Overview">

‎xdocs/building.xml‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
<?xml version="1.0"?>
2-
32
<!--
4-
Building IO
5-
$Id$
3+
Copyright 2002-2005 The Apache Software Foundation.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific iouage governing permissions and
15+
limitations under the License.
616
-->
7-
817
<document>
18+
<properties>
19+
<title>Building</title>
20+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
21+
</properties>
22+
923
<body>
1024

1125
<section name="Overview">

‎xdocs/changes.xml‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
Copyright 2002-2005 The Apache Software Foundation.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific iouage governing permissions and
15+
limitations under the License.
16+
-->
217
<document>
3-
<properties>
4-
<title>Changes</title>
5-
</properties>
18+
<properties>
19+
<title>Changes</title>
20+
</properties>
621
<body>
722
<release version="1.0-dev" date="in CVS">
823
<action dev="jeremias" type="remove">

‎xdocs/description.xml‎

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
<?xml version="1.0"?>
2-
32
<!--
4-
Main index
5-
$Id$
3+
Copyright 2002-2005 The Apache Software Foundation.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific iouage governing permissions and
15+
limitations under the License.
616
-->
7-
817
<document>
918
<properties>
10-
<title>About Commons IO</title>
11-
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
12-
</properties>
19+
<title>User guide</title>
20+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
21+
</properties>
1322
<body>
1423

1524
<section name="Commons IO">
@@ -26,19 +35,12 @@
2635
</section>
2736

2837
<section name="Utility classes">
29-
<subsection name="CopyUtils and IOUtils">
30-
<p>
31-
<code>org.apache.commons.io.CopyUtils</code>
32-
contains a comprehensive set of static methods for copying
33-
from String, byte[], InputStream, Reader
34-
to OutputStream, Writer.
35-
</p>
38+
<subsection name="IOUtils">
3639
<p>
3740
<code>org.apache.commons.io.IOUtils</code>
38-
contains additional IO-related tools for safely closing streams
39-
and creating Strings and byte arrays from streams and Readers.
41+
contains utility methods dealing with reading, writing and copying.
42+
The methods work on InputStream, OutputStream, Reader and Writer.
4043
</p>
41-
4244
<p>
4345
As an example, consider the task of reading bytes
4446
from a URL, and printing them. This would typically done like this:
@@ -83,12 +85,29 @@
8385

8486
<subsection name="FileUtils">
8587
<p>
86-
The <code>org.apache.commons.io.FileUtils</code>
87-
class contains methods for retrieving different components of a file path
88-
(directory name, file base name, file extension), methods
89-
for copying files to other files and directories, and methods
90-
for querying, deleting and cleaning directories. For more information,
91-
see the class description.
88+
The <code>org.apache.commons.io.FileUtils</code> class contains
89+
utility methods for working with File objects.
90+
These include reading, writing, copying and comparing files.
91+
</p>
92+
</subsection>
93+
94+
<subsection name="FilenameUtils">
95+
<p>
96+
The <code>org.apache.commons.io.FilenameUtils</code> class contains
97+
utility methods for working with filenames <i>without</i>
98+
using File objects. The class aims to be consistent
99+
between Unix and Windows, to aid transitions between these
100+
environments (such as moving from development to production).
101+
</p>
102+
</subsection>
103+
104+
<subsection name="FileSystemUtils">
105+
<p>
106+
The <code>org.apache.commons.io.FileSystemUtils</code> class contains
107+
utility methods for working with the file system
108+
to access functionality not supported by the JDK.
109+
Currently, the only method is to get the free space on a drive.
110+
Note that this uses the command line, not native code.
92111
</p>
93112
</subsection>
94113

‎xdocs/index.xml‎

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<!--
3-
Copyright 2002-2004 The Apache Software Foundation.
3+
Copyright 2002-2005 The Apache Software Foundation.
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
@@ -14,62 +14,63 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1414
See the License for the specific iouage governing permissions and
1515
limitations under the License.
1616
-->
17-
1817
<document>
19-
2018
<properties>
21-
<title>Commons IO</title>
19+
<title>Home</title>
2220
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
2321
</properties>
24-
25-
<body>
26-
22+
<body>
23+
<!-- ================================================== -->
2724
<section name="Commons IO">
28-
2925
<p>
26+
Commons IO is a library of utilities to assist with developing IO functionality.
27+
There are three main areas included:
28+
<ul>
29+
<li>Utility classes - with static methods to perform common tasks</li>
30+
<li>Filters - various implementations of file filters</li>
31+
<li>Streams - useful stream, reader and writer implementations</li>
32+
</ul>
3033
</p>
3134
</section>
32-
33-
<section name="Latest Release">
34-
<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>
35-
</section>
36-
35+
<!-- ================================================== -->
3736
<section name="Documentation">
3837
<p>
39-
A top level description of some of the classes to be found in the IO component is available - <a href="description.html">Description</a>.
40-
</p>
41-
42-
<p>
43-
The <a href="http://jakarta.apache.org/commons/io/apidocs/index.html">JavaDoc API documents</a> are available online.
38+
A getting started <a href="description.html">user guide</a> is available.
4439
</p>
45-
</section>
46-
47-
<section name="Bugs">
4840
<p>
49-
Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
41+
The JavaDoc API documents are available online:
5042
</p>
5143
<ul>
52-
<li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
53-
<li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons">Submit a bug report</a></li>
54-
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=RESOLVED&amp;bug_status=VERIFIED&amp;bug_status=CLOSED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=IO&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
55-
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=IO&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
44+
<li>The <a href="api-release/index.html">current release 1.1</a></li>
45+
<li>The <a href="api-1.0/index.html">previous version 1.0</a></li>
46+
<li>The <a href="apidocs/index.html">latest SVN</a></li>
5647
</ul>
48+
<p>
49+
The <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/">SVN repository</a> can be browsed.
50+
</p>
5751
</section>
58-
52+
<!-- ================================================== -->
5953
<section name="Releases">
60-
<ul>
61-
<li><a href="http://jakarta.apache.org/site/binindex.cgi#commons-io">Version 1.0</a></li>
62-
</ul>
54+
<p>
55+
The latest version is v1.1. -
56+
<a href="http://jakarta.apache.org/site/downloads/downloads_commons-io.cgi">Download now!</a>
57+
</p>
58+
<p>
59+
For previous releases, see the <a href="http://archive.apache.org/dist/jakarta/commons/io/">Apache Archive</a>
60+
</p>
6361
</section>
64-
65-
<section name="Repository">
62+
<!-- ================================================== -->
63+
<section name="Bugs">
64+
<p>
65+
Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
66+
</p>
6667
<ul>
67-
<li>
68-
<a href="http://cvs.apache.org/viewcvs/jakarta-commons/io/">CVS Repository</a>
69-
</li>
68+
<li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
69+
<li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&amp;component=IO&amp;version=3.0%20Final">Submit a bug report</a></li>
70+
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=IO&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
71+
<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=RESOLVED&amp;bug_status=VERIFIED&amp;bug_status=CLOSED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=IO&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;newqueryname=&amp;order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
7072
</ul>
7173
</section>
72-
74+
<!-- ================================================== -->
7375
</body>
7476
</document>
75-

‎xdocs/navigation.xml‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,22 @@
1010
</links>
1111

1212
<menu name="Commons IO">
13-
<item name="Overview" href="index.html"/>
14-
<item name="Description" href="description.html"/>
15-
<item name="Javadoc" href="apidocs/index.html"/>
16-
<item name="Best practices" href="bestpractices.html"/>
17-
<item name="Building" href="building.html"/>
18-
<item name="Mailing lists" href="mail-lists.html"/>
19-
<item name="Team" href="team-list.html"/>
20-
<item name="Tasks" href="tasks.html"/>
21-
<item name="Proposal" href="proposal.html"/>
22-
<item name="CVS" href="http://cvs.apache.org/viewcvs/jakarta-commons/io/"/>
13+
<item name="Overview" href="/index.html"/>
14+
<item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-io.cgi"/>
15+
<item name="Users guide" href="/description.html"/>
16+
<item name="Best practices" href="/bestpractices.html"/>
17+
<!--item name="History" href="/history.html"/-->
18+
<item name="Javadoc (1.1 release)" href="api-release/index.html"/>
19+
</menu>
20+
21+
<menu name="Development">
22+
<item name="Building" href="/building.html"/>
23+
<item name="Mailing lists" href="/mail-lists.html"/>
24+
<item name="Team" href="/team-list.html"/>
25+
<item name="Tasks" href="/tasks.html"/>
26+
<item name="Proposal" href="/proposal.html"/>
27+
<item name="SVN repository" href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/"/>
28+
<item name="Javadoc (SVN latest)" href="apidocs/index.html"/>
2329
</menu>
2430

2531
&common-menus;

‎xdocs/proposal.xml‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
11
<?xml version="1.0"?>
22
<?xml-stylesheet type="text/xsl" href="xdoc.xsl"?>
3-
<!-- $Revision$ $Date$ -->
3+
<!--
4+
Copyright 2002-2005 The Apache Software Foundation.
5+
6+
Licensed under the Apache License, Version 2.0 (the "License");
7+
you may not use this file except in compliance with the License.
8+
You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing, software
13+
distributed under the License is distributed on an "AS IS" BASIS,
14+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
See the License for the specific iouage governing permissions and
16+
limitations under the License.
17+
-->
418
<document>
5-
<properties>
6-
<title>Proposal for IO Package</title>
7-
</properties>
19+
<properties>
20+
<title>Proposal</title>
21+
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
22+
</properties>
823
<body>
924

1025

0 commit comments

Comments
 (0)