rdonkin     2003/02/03 09:58:31

  Modified:    fileupload project.xml
               fileupload/xdocs index.xml
  Added:       fileupload/xdocs navigation.xml overview.xml tasks.xml
  Log:
  Created a basic maven documentation.
  
  Revision  Changes    Path
  1.13      +6 -0      jakarta-commons/fileupload/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/fileupload/project.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- project.xml       20 Dec 2002 04:09:08 -0000      1.12
  +++ project.xml       3 Feb 2003 17:58:30 -0000       1.13
  @@ -80,6 +80,12 @@
         <email>[EMAIL PROTECTED]</email>
         <organization>Zenplex</organization>
       </developer>
  +    <developer>
  +      <name>Robert Burrell Donkin</name>
  +      <id>rdonkin</id>
  +      <email>[EMAIL PROTECTED]</email>
  +      <organization/>
  +    </developer>
     </developers>
     
     <dependencies>
  
  
  
  1.2       +17 -34    jakarta-commons/fileupload/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/fileupload/xdocs/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml 15 Aug 2002 07:50:20 -0000      1.1
  +++ index.xml 3 Feb 2003 17:58:30 -0000       1.2
  @@ -25,41 +25,24 @@
         </p>
       </section>
   
  -    <section name="Using FileUpload">
  -      <p>
  -        Your application should detect whether or not FileUpload should be
  -        invoked, based on the HTTP method and the content type of the request.
  -      </p>
  -      <p>
  -        Assuming that you have decided that FileUpload should be invoked, you
  -        might write the following code to handle a file upload request:
  -<pre>
  -    // Create a new file upload handler
  -    FileUpload upload = new FileUpload();
  -
  -    // Set upload parameters
  -    upload.setSizeMax(MAX_UPLOAD_SIZE);
  -    upload.setSizeThreshold(MAX_MEMORY_SIZE);
  -    upload.setRepositoryPath(TEMP_DIR);
  -
  -    // Parse the request
  -    List items = upload.parseRequest(request);
  -
  -    // Process the uploaded fields
  -    Iterator iter = items.iterator();
  -    while (iter.hasNext()) {
  -        FileItem item = (FileItem) iter.next();
  -
  -        if (item.isFormField()) {
  -            processTextParameter(request, item);
  -        } else {
  -            processFileParameter(request, item);
  -        }
  -    }
  -</pre>
  -      </p>
  +    <section name="Downloading Fileupload">
  +        <subsection name='Full Releases'>
  +            <!-- list full releases here -->
  +        </subsection>
  +        <subsection name='Beta Releases'>
  +            <!-- list beta releases here-->
  +        </subsection>
  +        <subsection name='Nightly Builds'>   
  +            <p>
  +            Nightly builds are built every day from the current CVS HEAD. This is 
  +            the latest code and so should be treated with caution!
  +            </p>
  +            <p>
  +            Download nightly builds from 
  +            <a 
href='http://cvs.apache.org/builds/jakarta-commons/nightly/commons-fileupload/'>here</a>.
  +            </p>
  +        </subsection>
       </section>
  -
     </body>
   
   </document>
  
  
  
  1.1                  jakarta-commons/fileupload/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Betwixt">
  
    <title>FileUpload</title>
    <organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo>
  
    <body>
      <menu name="FileUpload">
        <item name="Home"                href="/index.html"/>
        <item name="Overview"            href="/overview.html"/>
        <item name="To Do List"          href="/tasks.html"/>
      </menu>
    </body>
  </project>
  
  
  
  1.1                  jakarta-commons/fileupload/xdocs/overview.xml
  
  Index: overview.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
   <properties>
    <title>Fileupload Overview</title>
    <author email="[EMAIL PROTECTED]">Robert Burrell Donkin</author>
   </properties>
  
  <body>
  
      <section name="Using FileUpload">
        <p>
          Your application should detect whether or not FileUpload should be
          invoked, based on the HTTP method and the content type of the request.
        </p>
        <p>
          Assuming that you have decided that FileUpload should be invoked, you
          might write the following code to handle a file upload request:
  <pre>
      // Create a new file upload handler
      FileUpload upload = new FileUpload();
  
      // Set upload parameters
      upload.setSizeMax(MAX_UPLOAD_SIZE);
      upload.setSizeThreshold(MAX_MEMORY_SIZE);
      upload.setRepositoryPath(TEMP_DIR);
  
      // Parse the request
      List items = upload.parseRequest(request);
  
      // Process the uploaded fields
      Iterator iter = items.iterator();
      while (iter.hasNext()) {
          FileItem item = (FileItem) iter.next();
  
          if (item.isFormField()) {
              processTextParameter(request, item);
          } else {
              processFileParameter(request, item);
          }
      }
  </pre>
        </p>
      </section>
  
  </body>
  </document>
  
  
  
  1.1                  jakarta-commons/fileupload/xdocs/tasks.xml
  
  Index: tasks.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <title>TODO</title>
      <author email="[EMAIL PROTECTED]">Robert Burrell Donkin</author>
    </properties>
  
    <body>
      <section name="TODO list">
        <p>
          The following is a list of items that need to be completed in
          Fileupload.  Contributions are welcome! 
        </p>
      
      <subsection name="High priority"> 
        <ul>
          <li>
              <strong>Comprehensive unit test</strong>
              covering all the existing functionality. 
          </li>
          <li>
              <strong>Comprehensive Documentation</strong>
              for all the existing functionality.
          </li>
         </ul>
      </subsection>
      
      <subsection name="Medium priority"> 
      </subsection>
      
      <subsection name="Low priority"> 
      </subsection>
  </section>
  <section name='Completed'>
      <subsection name="Since Last Release"> 
      </subsection>
  </section>
    </body>
  </document>
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to