commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r349211 - in /jakarta/commons/proper/resources/trunk/xdocs: index.xml navigation.xml todo.xml
Date Sun, 27 Nov 2005 11:40:21 GMT
Author: niallp
Date: Sun Nov 27 03:40:08 2005
New Revision: 349211

URL: http://svn.apache.org/viewcvs?rev=349211&view=rev
Log:
Update Resources docs

Modified:
    jakarta/commons/proper/resources/trunk/xdocs/index.xml
    jakarta/commons/proper/resources/trunk/xdocs/navigation.xml
    jakarta/commons/proper/resources/trunk/xdocs/todo.xml

Modified: jakarta/commons/proper/resources/trunk/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/xdocs/index.xml?rev=349211&r1=349210&r2=349211&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/xdocs/index.xml (original)
+++ jakarta/commons/proper/resources/trunk/xdocs/index.xml Sun Nov 27 03:40:08 2005
@@ -41,64 +41,74 @@
     some operational environments.</li>
 </ul>
 
-<p>The classes in the proposed <code>Resources</code> package offer solutions
+<p>The classes in the <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
+<b><code>Resources</code></b> implementations that can access resource
strings
 from any desired static or dynamically updated collection.</p>
-</section>
-
-
-<section name="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>
-</section>
 
-<section name="Initial Source of the Package">
+  <subsection name="Resources API">
 
-<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 Jakarta Commons component, Struts will
-be modified to use the Commons version of these classes, and its internal
-versions will be deprecated.</p>
+    <p>The core of the resources framework are two interfaces:</p>
+    <ul>
+        <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> and <code>java.util.TimeZone</code>.</li>
+        <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>
 
-<p>The proposed package name for the new component is
-<code>org.apache.commons.resources</code>.</p>
+    <p>Basic imlementations of the above are provided for resources contained
+       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>

+            An encapsulation of an individual messag, consisting of a message key,
+            and replacement values.</li>
+        <li><a href="apidocs/org/apache/commons/resources/MessageList.html">MessageList</a>

+            A class that encapsulates a set of messages.</li>
+    </ul>
+  </subsection>
 
 </section>
 
 <section name="Documentation">
-    <p>
-    The JavaDoc API documents are available <a href="apidocs/index.html">here</a>.
-    </p>
-    <p>
-    The following versions of the JavaDoc API documents are available online:
-    </p>
-    <ul>
-        <li>The <a href="http://jakarta.apache.org/commons/resources/api-release/">Current
Release</a></li>
-        <li>The <a href="http://jakarta.apache.org/commons/resources/apidocs/">latest
SVN</a></li>
-    </ul>
 
-    <p>
-    The <a href="cvs-usage.html">subversion repository</a> can be
-    <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/resources/trunk/">browsed</a>.
-    </p>
+    <subsection name="Wiki">
+        <p>
+        See the <a href="http://wiki.apache.org/jakarta-commons/FrontPage">Commons
Wiki</a> for
+        the User Guide, class diagram and other resources:
+        <ul>
+            <li><a href="http://wiki.apache.org/jakarta-commons/Resources/">Resources
Wiki Home Page</a></li>
+            <li><a href="http://wiki.apache.org/jakarta-commons/ResourcesClassDiagram/">Class
Diagram</a></li>
+            <li><a href="http://wiki.apache.org/jakarta-commons/ResourcesUserGuide/">User
Guide</a></li>
+        </ul>
+        </p>
+    </subsection>
+    <subsection name="JavaDoc">
+        <p>
+        The JavaDoc API documents are available <a href="apidocs/index.html">here</a>.
+        </p>
+        <p>
+        The following versions of the JavaDoc API documents are available online:
+        </p>
+        <ul>
+            <li>The <a href="http://jakarta.apache.org/commons/resources/api-release/">Current
Release</a></li>
+            <li>The <a href="http://jakarta.apache.org/commons/resources/apidocs/">latest
SVN</a></li>
+        </ul>
+    </subsection>
+
+    <subsection name="Source Code Repository">
+        <p>
+        The <a href="cvs-usage.html">subversion repository</a> can be
+        <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/resources/trunk/">browsed</a>.
+        </p>
+    </subsection>
 </section>
 
 <section name="Releases">

Modified: jakarta/commons/proper/resources/trunk/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/xdocs/navigation.xml?rev=349211&r1=349210&r2=349211&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/xdocs/navigation.xml (original)
+++ jakarta/commons/proper/resources/trunk/xdocs/navigation.xml Sun Nov 27 03:40:08 2005
@@ -31,9 +31,13 @@
     <menu name="Commons&#xA0;Resources">
       <item name="Overview"   href="/index.html"/>
       <item name="Downloads"  href="/downloads.html"/>
-      <item name="To Do List" href="/todo.html"/>
-      <item name="Javadoc"    href="/apidocs/index.html"/>
-      <item name="Wiki"       href="http://wiki.apache.org/jakarta-commons/Resources"/>
+      <item name="Documentation">
+          <item name="User Guide"    href="http://wiki.apache.org/jakarta-commons/ResourcesUserGuide"/>
+          <item name="Class Diagram" href="http://wiki.apache.org/jakarta-commons/ResourcesClassDiagram"/>
+          <item name="Javadoc"       href="/apidocs/index.html"/>
+          <item name="Wiki"          href="http://wiki.apache.org/jakarta-commons/Resources"/>
+          <item name="To Do List"    href="/todo.html"/>
+      </item>
     </menu>
 
     &common-menus;

Modified: jakarta/commons/proper/resources/trunk/xdocs/todo.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/resources/trunk/xdocs/todo.xml?rev=349211&r1=349210&r2=349211&view=diff
==============================================================================
--- jakarta/commons/proper/resources/trunk/xdocs/todo.xml (original)
+++ jakarta/commons/proper/resources/trunk/xdocs/todo.xml Sun Nov 27 03:40:08 2005
@@ -45,22 +45,9 @@
   </tr>
 
   <tr>
-    <td><strong>Unit Tests for Abstract Classess</strong>.  Complete the
JUnit
-         unit tests for the <code>MessageResources</code> and
-         <code>MessageResourcesFactory</code> classes.</td>
-    <td align="center"></td>
-  </tr>
-
-  <tr>
-    <td><strong>Unit Tests for Property Resources</strong>.  Complete the
JUnit
-         unit tests for the <code>PropertyMessageResources</code> and
-         <code>PropertyMessageResourcesFactory</code> classes.</td>
-    <td align="center"></td>
-  </tr>
-
-  <tr>
-    <td><strong>Documentation</strong>.  Provide basic User's Guide information
-        in a <code>package.html</code> file for this package.</td>
+    <td><strong>Documentation</strong>. Provide basic User's Guide information
on the
+        <a href="http://wiki.apache.org/jakarta-commons/ResourcesUserGuide">Commons
Wiki</a>
+        for this package.</td>
     <td align="center"></td>
   </tr>
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message