commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jstrac...@apache.org
Subject cvs commit: jakarta-commons-sandbox/resources/xdocs todo.xml index.xml navigation.xml
Date Wed, 17 Jul 2002 07:54:46 GMT
jstrachan    2002/07/17 00:54:46

  Added:       resources LICENSE.txt project.xml project.properties
                        maven.xml
               resources/xdocs todo.xml index.xml navigation.xml
  Log:
  Added a maven build together with some very basic documentation.
  
  The website is now available here
  
  http://jakarta.apache.org/commons/sandbox/resources/
  
  Revision  Changes    Path
  1.1                  jakarta-commons-sandbox/resources/LICENSE.txt
  
  Index: LICENSE.txt
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons/LICENSE,v 1.4 2002/04/11 13:24:02 dion Exp $
   * $Revision: 1.4 $
   * $Date: 2002/04/11 13:24:02 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  
  
  1.1                  jakarta-commons-sandbox/resources/project.xml
  
  Index: project.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  
  <project>
    <pomVersion>3</pomVersion>
    <name>commons-resources</name>
    <id>commons-resources</id>
    <currentVersion>1.0-dev</currentVersion>
    <organization>
      <name>Apache Software Foundation</name>
      <url>http://www.apache.org</url>
    </organization>
    <inceptionYear>2002</inceptionYear>
    <package>org.apache.commons.resources</package>
    <shortDescription>Commons Jelly</shortDescription>
  
    <!-- Gump integration -->
    <gumpRepositoryId>jakarta</gumpRepositoryId>
    
    <description>
    	Resources is a resources component.
    </description>
    
    <url>http://jakarta.apache.org/commons/sandbox/resources/</url>
    <issueTrackingUrl>http://nagoya.apache.org/scarab/servlet/scarab/</issueTrackingUrl>
    <siteAddress>jakarta.apache.org</siteAddress>
    <siteDirectory>/www/jakarta.apache.org/commons/sandbox/resources/</siteDirectory>
    <distributionDirectory>/www/jakarta.apache.org/builds/jakarta-commons-sandbox/resources/</distributionDirectory>
    <repository>
      <connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-commons-sandbox/resources</connection>
      <url>http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/resources/</url>
    </repository>
    
    <versions>
      <version>
        <id>b1</id>
        <name>1.0-b1</name>
        <tag>HEAD</tag>
      </version>
    </versions>
    <branches></branches>
    
    <mailingLists>
      <mailingList>
        <name>Commons Dev List</name>
        <subscribe>commons-dev-subscribe@jakarta.apache.org</subscribe>
        <unsubscribe>commons-dev-unsubscribe@jakarta.apache.org</unsubscribe>
        <archive>http://nagoya.apache.org/eyebrowse/SummarizeList?listName=commons-dev@jakarta.apache.org</archive>
      </mailingList>
    </mailingLists>
  
    <developers>
      <developer>
        <name>Martin Cooper</name>
        <id>martinc</id>
        <email>martinc@apache.org</email>
        <organization></organization>
      </developer>
      <developer>
        <name>Craig McClanahan</name>
        <id>craigmcc</id>
        <email>craigmcc@apache.org</email>
        <organization></organization>
      </developer>
      <developer>
        <name>Michael Schachter</name>
        <id>mschachter</id>
        <email>mschachter@apache.org</email>
        <organization></organization>
      </developer>
      <developer>
        <name>Jason van Zyl</name>
        <id>jvanzyl</id>
        <email>jvanzyl@apache.org</email>
        <organization></organization>
      </developer>
      <developer>
        <name>Daniel Rall</name>
        <id>dlr</id>
        <email>dlr@apache.org</email>
        <organization></organization>
      </developer>
      <developer>
        <name>James Strachan</name>
        <id>jstrachan</id>
        <email>jstrachan@apache.org</email>
        <organization>SpiritSoft, Inc.</organization>
      </developer>
    </developers>
  
    <dependencies>
      <dependency>
        <id>xml-apis</id>
        <version>2.0.2</version>
      </dependency>
      
      <dependency>
        <id>commons-logging</id>
        <version>1.0</version>
      </dependency>
  
      <dependency>
        <id>commons-beanutils</id>
        <version>1.4-dev</version>
      </dependency>
  
      <dependency>
        <id>commons-collections</id>
        <version>2.0</version>
      </dependency>
  
      <dependency>
        <id>commons-digester</id>
        <version>1.2</version>
      </dependency>
      
      <dependency>
        <id>servletapi</id>
        <version>2.3</version>
      </dependency>
      
  	<!-- for testing -->
      <dependency>
        <id>commons-httpclient</id>
        <version>2.0-dev</version>
      </dependency>
  
      <dependency>
        <id>junit</id>
        <version>3.7</version>
      </dependency>
      
      <dependency>
        <id>cactus</id>
        <version>1.2</version>
      </dependency>
      
    </dependencies>
    
    
    <build>
      <nagEmailAddress>commons-dev@jakarta.apache.org</nagEmailAddress>
      <sourceDirectory>src/java</sourceDirectory>
      <unitTestSourceDirectory>src/test</unitTestSourceDirectory>
      
      <integrationUnitTestSourceDirectory/>
      <aspectSourceDirectory/>
      
      <!-- Unit test classes -->
      <unitTest>
        <includes>
          <include>**/Test*.java</include>
        </includes>
      </unitTest>
  
      
      <!-- Integration unit test classes -->
  
      <integrationUnitTestPatterns></integrationUnitTestPatterns>
  
      <!-- J A R  R E S O U R C E S -->
      <!-- Resources that are packaged up inside the JAR file -->
      <resources>
        <includes>
          <include>**/*.properties</include>
        </includes>
      </resources>
    </build>
  </project>
  
  
  
  1.1                  jakarta-commons-sandbox/resources/project.properties
  
  Index: project.properties
  ===================================================================
  # -------------------------------------------------------------------
  # P R O J E C T  P R O P E R T I E S
  # -------------------------------------------------------------------
  
  compile.debug = on
  compile.optimize = off
  compile.deprecation = off
  
  maven.jarResources.basedir=${basedir}/src/java
   
  
  # use Sun coding standards
  
  maven.checkstyle.lcurly.type = eol
  maven.checkstyle.lcurly.method = eol
  maven.checkstyle.lcurly.other = eol
  #maven.checkstyle.header.file = src/conf/checkstyle-LICENSE.txt
  maven.checkstyle.header.ignore.line = 1,2,3,4,5,6
  maven.checkstyle.const.pattern = ^[a-z][a-zA-Z0-9]*$
  
  # disable these non-critical errors to highlight
  # more important ones line missing javadoc
  
  maven.checkstyle.max.line.len = 100
  maven.checkstyle.ignore.whitespace = true
  maven.checkstyle.ignore.public.in.interface = true
  
  
  
  
  
  1.1                  jakarta-commons-sandbox/resources/maven.xml
  
  Index: maven.xml
  ===================================================================
  <project default="java:jar" xmlns:j="jelly:core">
  
    <!-- we can customize the Maven build here -->
    	
  </project>
  
  
  
  1.1                  jakarta-commons-sandbox/resources/xdocs/todo.xml
  
  Index: todo.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <title>TODO</title>
      <author email="jstrachan@apache.org">James Strachan</author>
    </properties>
  
    <body>
      <section name="TODO"> 
        <p>
          The following is a list of items that need to be completed in
          Jelly.  Contributions are welcome!.
        </p>
        
  <table border="1">
  
    <tr>
      <th width="80%">Action Item</th>
      <th width="20%">Volunteer</th>
    </tr>
  
    <tr>
      <td><strong>Review Abstractions</strong>.  Review the abstractions
          provided by the <code>MessageResources</code> and
          <code>MessageResourcesFactory</code> classes, especially as
          compared to other APIs that provide pluggable factory and instance
          implementations (JAXP, JSSE, JNDI, etc.), and refactor as needed.</td>
      <td align="center"></td>
    </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 align="center"></td>
    </tr>
  
  </table>
  
      </section>
    </body>
  </document>
  
  
  
  
  1.1                  jakarta-commons-sandbox/resources/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
   <properties>
    <title>Resources : Resource bundle component</title>
    <author email="jstrachan@apache.org">James Strachan</author>
   </properties>
  
  <body>
  
  <section name="Resources : Resource bundle component">
  
  <section name="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>
  </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="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 Jakarta Commons.</p>
  
  <p>No external configuration files are utilized.</p>
  </section>
  
  
  <section name="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://jakarta.apache.org/struts">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 proposed package name for the new component is
  <code>org.apache.commons.resources</code>.</p>
  
  </section>
  
  </section>
  
  
  </body>
  </document>
  
  
  
  
  1.1                  jakarta-commons-sandbox/resources/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Resources">
  
    <title>Resources</title>
    <organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo>
  
    <body>
      <menu name="Jelly">
        <item name="Overview"                href="/index.html"/>
        <item name="To Do List"              href="/todo.html"/>
      </menu>
    </body>
  </project>
  
  
  

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


Mime
View raw message