Author: dmeikle
Date: Sun May 17 09:24:30 2009
New Revision: 775607
URL: http://svn.apache.org/viewvc?rev=775607&view=rev
Log:
General updates to the website
Added:
commons/sandbox/resources/trunk/xdocs/building.xml
commons/sandbox/resources/trunk/xdocs/proposal.xml
Modified:
commons/sandbox/resources/trunk/xdocs/changes.xml
commons/sandbox/resources/trunk/xdocs/cvs-usage.xml
commons/sandbox/resources/trunk/xdocs/downloads.xml
commons/sandbox/resources/trunk/xdocs/index.xml
commons/sandbox/resources/trunk/xdocs/issue-tracking.xml
commons/sandbox/resources/trunk/xdocs/navigation.xml
commons/sandbox/resources/trunk/xdocs/todo.xml
Added: commons/sandbox/resources/trunk/xdocs/building.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/building.xml?rev=775607&view=auto
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/building.xml (added)
+++ commons/sandbox/resources/trunk/xdocs/building.xml Sun May 17 09:24:30 2009
@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Building</title>
+ <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+<!-- ================================================== -->
+<section name="Overview">
+<p>
+ Commons Resources uses <a href="http://maven.apache.org";>Maven</a> as a
build system.
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Maven Goals">
+ <p>
+ To build a jar file, change into the root directory of Resources and run
"maven jar".
+ The result will be in the "target" subdirectory.
+ </p>
+ <p>
+ To build the full website, run "maven site".
+ The result will be in "target/site".
+ You must be online to successfully complete this target.
+ </p>
+ <p>
+ To build the src and binary packages, change into the root directory of
Resources and run "maven package".
+ The result will be in the "target" subdirectory.
+ </p>
+ <p>
+ Further details can be found in the
+ <a href="http://commons.apache.org/building.html";>commons build
instructions</a>.
+ </p>
+</section>
+<!-- ================================================== -->
+</body>
+</document>
Modified: commons/sandbox/resources/trunk/xdocs/changes.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/changes.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/changes.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/changes.xml Sun May 17 09:24:30 2009
@@ -1,31 +1,32 @@
<?xml version="1.0"?>
<!--
- Copyright 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 language governing permissions and
- limitations under the License.
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You 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.
-->
<!--
This file is used by the maven-changes-plugin to generate the release notes.
Useful ways of finding items to add to this file are:
-1. Add items when you fix a bug or add a feature (this makes the
+1. Add items when you fix a bug or add a feature (this makes the
release process easy :-).
2. Do a bugzilla search for tickets closed since the previous release.
3. Use the report generated by the maven-changelog-plugin to see all
-CVS commits. Set the project.properties' maven.changelog.range
+CVS commits. Set the project.properties' maven.changelog.range
property to the number of days since the last release.
@@ -66,7 +67,7 @@
<i>(Dec 2005)</i>.
</action>
<action dev="niallp" type="add" issue="33379" due-to="Anaximandro de
Godinho">
- Resources Class diagram - added to the
+ Resources Class diagram - added to the
<a
href="http://wiki.apache.org/jakarta-commons/ResourcesClassDiagram";>Wiki</a>
<i>(Nov 2005)</i>.
</action>
@@ -119,6 +120,6 @@
<i>(May 2001)</i>.
</action>
</release>
-
+
</body>
</document>
Modified: commons/sandbox/resources/trunk/xdocs/cvs-usage.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/cvs-usage.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/cvs-usage.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/cvs-usage.xml Sun May 17 09:24:30 2009
@@ -1,18 +1,19 @@
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!--
- Copyright 2005 The Apache Software Foundation
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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
- 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
- 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.
+ 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>
Modified: commons/sandbox/resources/trunk/xdocs/downloads.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/downloads.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/downloads.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/downloads.xml Sun May 17 09:24:30 2009
@@ -1,18 +1,19 @@
<?xml version="1.0"?>
<!--
- Copyright 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 language governing permissions and
- limitations under the License.
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
@@ -21,7 +22,7 @@
<body>
<section name="Download Resources">
-
+
<subsection name="Releases">
<p>Download the <a
href="http://jakarta.apache.org/site/downloads/downloads_commons-resources.cgi";>Latest
Release</a>
of Commons Resources.
Modified: commons/sandbox/resources/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/index.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/index.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/index.xml Sun May 17 09:24:30 2009
@@ -1,18 +1,19 @@
<?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 language governing permissions and
- limitations under the License.
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
@@ -50,11 +51,11 @@
<p>The core of the resources framework are two interfaces:</p>
<ul>
- <li><a
href="apidocs/org/apache/commons/resources/Resources.html">Resources</a>
+ <li><a
href="apidocs/org/apache/commons/resources/Resources.html">Resources</a>
Representation of a set of internationalized resources, which are
arbitrary
objects identified by a unique String key and can be accessed for
different
<code>java.util.Locale</code>.</li>
- <li><a
href="apidocs/org/apache/commons/resources/ResourcesFactory.html">ResourcesFactory</a>
+ <li><a
href="apidocs/org/apache/commons/resources/ResourcesFactory.html">ResourcesFactory</a>
Factory class to configure and instantiate an appropriate
<code>Resources</code> instance.</li>
</ul>
@@ -63,14 +64,14 @@
in property files, XML and databases(via JDBC). Implementations are
also provided for use in a Web App environment.
</p>
-
+
<p>The resources framework also includes interfaces for encapsualting
messages
and message lists:</p>
<ul>
- <li><a
href="apidocs/org/apache/commons/resources/Message.html">Message</a>
+ <li><a
href="apidocs/org/apache/commons/resources/Message.html">Message</a>
An encapsulation of an individual message, consisting of a message
key,
and replacement values.</li>
- <li><a
href="apidocs/org/apache/commons/resources/MessageList.html">MessageList</a>
+ <li><a
href="apidocs/org/apache/commons/resources/MessageList.html">MessageList</a>
A class that encapsulates a set of messages.</li>
</ul>
</subsection>
@@ -112,7 +113,7 @@
</section>
<section name="Releases">
- <p>See the <a href="downloads.html">Downloads</a> page for
current/previous
+ <p>See the <a href="downloads.html">Downloads</a> page for current/previous
releases.
</p>
<p>Release Notes are available <a href="changes-report.html">here</a>.
Modified: commons/sandbox/resources/trunk/xdocs/issue-tracking.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/issue-tracking.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/issue-tracking.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/issue-tracking.xml Sun May 17
09:24:30 2009
@@ -1,61 +1,102 @@
<?xml version="1.0"?>
<!--
- Copyright 2005 The Apache Software Foundation
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You 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
- 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.
+ 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.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: issue-tracking-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.id (required, alphabetic, upper case) |
+ | - commons.jira.pid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.id>MATH</commons.jira.id> |
+ | <commons.jira.pid>12310485</commons.jira.pid> |
+ | </properties> |
+ | |
+ +======================================================================+
-->
<document>
- <properties>
- <title>Issue tracking</title>
- <author email="d...@commons.apache.org">Commons Documentation Team</author>
- </properties>
-<body>
-<!-- ================================================== -->
-<section name="Issue tracking">
-<p>
- Commons Resources uses <a href="http://issues.apache.org/bugzilla/";>ASF
Bugzilla</a> for tracking issues.
- To use Bugzilla you may need to <a
href="http://issues.apache.org/bugzilla/createaccount.cgi";>create an
account</a>.
-</p>
-<p>
- If you would like to report a bug, or raise an enhancement request with
- Commons Resources please do the following:
- <ol>
- <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&product=Commons&component=Resources";>Search
existing open bugs</a>.
- If you find your issue listed then please add a comment with your
details.</li>
- <li><a
href="http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/";>Search the
mailing list archive</a>.
- You may find your issue or idea has already been discussed.</li>
- <li><a
href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&version=unspecified&component=Resources&rep_platform=All&op_sys=All&priority=P1&bug_severity=normal&bug_status=NEW&assigned_to=commons-dev%40jakarta.apache.org&short_desc=%5Bresources%5D%20%22Your%20subject%20heading%20here%22&comment=Please%20provide%20details%20here.%20Its%20best%20to%20submit%20patches%20that%20alter%0D%0Aexisting%20file%20content%20in%20%22unified%20cvs%20diff%22%20format.%20%0D%0A%0D%0ASubmissions%20that%20provide%20new%20files%20can%20be%20supplied%20as%20direct%20file%0D%0Aattachments%20or%20archives%20in%20zip%20or%20tar.gz%20format.%20please%20be%20kind%20%0D%0Aenough%20to%20identify%20the%20format%20of%20the%20attached%20archive%20as%20bugzilla%0D%0Atends%20to%20strip%20these%20characterstics%20by%20removing%20the%20files%20extension.&commentprivacy=0&form_name=enter_bug";>Submit
a bug report or enhancement request</a>.
- Please prefix all new issues with [resources] in the summary line.
- </li>
- </ol>
-</p>
-<p>
- Please also remember these points:
- <ul>
- <li>the more information you provide, the better we can help you</li>
- <li>test cases are vital, particularly for any proposed enhancements</li>
- <li>the developers of Commons Resources are all unpaid volunteers</li>
- </ul>
-</p>
-<p>
- You may also find these links useful:
- <ul>
- <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&product=Commons&component=Resources";>All
Open Resources bugs</a></li>
- <li><a
href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&product=Commons&component=Resources";>All
Closed Resources 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&product=Commons&component=Resources";>All
Resources bugs</a></li>
- </ul>
-</p>
-</section>
-<!-- ================================================== -->
-</body>
-</document>
+ <properties>
+ <title>Commons Resources Issue tracking</title>
+ <author email="d...@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="Commons Resources Issue tracking">
+ <p>
+ Commons Resources uses <a href="http://issues.apache.org/jira/";>ASF
JIRA</a> for tracking issues.
+ See the <a href="http://issues.apache.org/jira/browse/RESOURCES";>Commons
Resources JIRA project page</a>.
+ </p>
+
+ <p>
+ To use JIRA you may need to <a
href="http://issues.apache.org/jira/secure/Signup!default.jspa";>create an
account</a>
+ (if you have previously created/updated Commons issues using Bugzilla an
account will have been automatically
+ created and you can use the <a
href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa";>Forgot
Password</a>
+ page to get a new password).
+ </p>
+
+ <p>
+ If you would like to report a bug, or raise an enhancement request with
+ Commons Resources please do the following:
+ <ol>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310481&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>Search
existing open bugs</a>.
+ If you find your issue listed then please add a comment with your
details.</li>
+ <li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
+ You may find your issue or idea has already been discussed.</li>
+ <li>Decide if your issue is a bug or an enhancement.</li>
+ <li>Submit either a <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310481&issuetype=1&priority=4&assignee=-1";>bug
report</a>
+ or <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310481&issuetype=4&priority=4&assignee=-1";>enhancement
request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <ul>
+ <li>the more information you provide, the better we can help you</li>
+ <li>test cases are vital, particularly for any proposed
enhancements</li>
+ <li>the developers of Commons Resources are all unpaid volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on subversion and creating patches see the
+ <a href="http://www.apache.org/dev/contributors.html";>Apache
Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310490&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4";>All
Open Commons Resources bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310490&sorter/field=issuekey&sorter/order=DESC&status=5&status=6";>All
Resolved Commons Resources bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310490&sorter/field=issuekey&sorter/order=DESC";>All
Commons Resources bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Modified: commons/sandbox/resources/trunk/xdocs/navigation.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/navigation.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/navigation.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/navigation.xml Sun May 17 09:24:30
2009
@@ -1,19 +1,20 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE org.apache.commons.menus SYSTEM
'../../commons-build/menus/menus.dtd'>
<!--
- Copyright 2003-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 language governing permissions and
- limitations under the License.
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
-->
<project name="Commons Resources">
@@ -22,7 +23,7 @@
<body>
<links>
- <item name="Apache Commons"
+ <item name="Apache Commons"
href="http://commons.apache.org/"/>
</links>
Added: commons/sandbox/resources/trunk/xdocs/proposal.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/proposal.xml?rev=775607&view=auto
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/proposal.xml (added)
+++ commons/sandbox/resources/trunk/xdocs/proposal.xml Sun May 17 09:24:30 2009
@@ -0,0 +1,125 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>Proposal for Resources Package</title>
+</properties>
+<body>
+
+
+<section name="Proposal for Resources Package">
+
+
+
+<subsection name="(0) Rationale">
+
+<p>Many Java applications must support internationalization (i18n) of message
+strings presented as part of the user interface, or in messages written to
+log files. The standard Java APIs offer the
+<code>java.util.ResourceBundle</code> family of classes to support this
+requirement; however, these classes have the following limitations that
+reduce their usefulness:</p>
+<ul>
+<li>The classes assume that all messages should be presented based on
+ a single Locale, while many applications require support for different
+ Locales for each current application user.</li>
+<li>The <code>ResourceBundle</code> implementation classes do not implement
+ the <code>java.io.Serializable</code> interface, which is required in
+ some operational environments.</li>
+</ul>
+
+<p>The classes in the proposed <code>Resources</code> package offer solutions
+to these two problems, and provide a framework for providing customized
+<code>MessageResources</code> implementations that can access resource strings
+from any desired static or dynamically updated collection.</p>
+
+</subsection>
+<subsection name="(1) Scope of the Package">
+
+<p>The proposal defines a miniature resources framework consisting of two
+abstract classes:</p>
+<ul>
+<li><strong>MessageResources</strong> - Base class for a collection of
+ message strings, keyed by a combination of a <code>java.util.Locale</code>
+ and a message key.</li>
+<li><strong>MessageResourcesFactory</strong> - Factory class to configure and
+ instantiate an appropriate <code>MessageResources</code> instance.</li>
+</ul>
+
+<p>An initial (and default) implementation accesses the required message
+strings from Properties files accessed via <code>Class.getResource()</code>.
+These files are named with a base name, plus extensions identifying the
+Locale of the contained message strings, in a manner identical to the
+<code>java.util.PropertyResourceBundle</code> class of the standard APIs.</p>
+
+
+</subsection>
+<subsection name="(1.5) Interaction With Other Packages">
+
+<p><em>Resource</em> relies on the standard JDK 1.2 (or later) APIs, plus
+the <code>Collections</code> package from Apache Commons.</p>
+
+<p>No external configuration files are utilized.</p>
+
+
+</subsection>
+<subsection name="(2) Initial Source of the Package">
+
+<p>The four original Java classes (<code>MessageResources</code>,
+<code>MessageResourcesFactory</code>, <code>PropertyMessageResources</code>,
+and <code>PropertyMessageResourcesFactory</code>) are an integral
+part of the <a href="http://struts.apache.org";>Struts Framework</a>.
+However, they have no dependencies on other aspects of Struts.
+Once accepted and released as a Apache Commons component, Struts will
+be modified to use the Commons version of these classes, and its internal
+versions will be deprecated.</p>
+
+<p>The proposed package name for the new component is
+<code>org.apache.commons.resources</code>.</p>
+
+
+</subsection>
+<subsection name="(3) Required Jakarta-Commons Resources">
+
+<ul>
+<li>CVS Repository - New directory <code>resources</code> in the
+ <code>jakarta-commons</code> CVS repository. All initial committers
+ are already committers on <code>jakarta-commons</code>, so no
+ additional user setups are required.</li>
+<li>Mailing List - Discussions will take place on the general
+ <em>jakarta-comm...@jakarta.apache.org</em> mailing list. To help
+ list subscribers identify messages of interest, it is suggested that
+ the message subject of messages about this component be prefixed with
+ [Resources].</li>
+<li>Bugzilla - New component "Resources" under the "Commons" product
+ category, with appropriate version identifiers as needed.</li>
+<li>Jyve FAQ - New category "commons-resources" (when available).</li>
+</ul>
+
+
+</subsection>
+<subsection name="(4) Initial Committers">
+
+<p>The initial committers on the Resources component shall be Craig
+McClanahan, Michael Schachter, Jason van Zyl, and Daniel Rall.</p>
+
+
+</subsection>
+</section>
+</body>
+</document>
Modified: commons/sandbox/resources/trunk/xdocs/todo.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/resources/trunk/xdocs/todo.xml?rev=775607&r1=775606&r2=775607&view=diff
==============================================================================
--- commons/sandbox/resources/trunk/xdocs/todo.xml (original)
+++ commons/sandbox/resources/trunk/xdocs/todo.xml Sun May 17 09:24:30 2009
@@ -1,20 +1,20 @@
<?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 language governing permissions and
- limitations under the License.
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>TODO</title>
@@ -22,12 +22,12 @@
</properties>
<body>
- <section name="TODO">
+ <section name="TODO">
<p>
The following is a list of items that need to be completed in
Resources. Contributions are welcome!.
</p>
-
+
<table border="1">
<tr>
