Author: martinc
Date: Sun Nov 27 11:05:16 2005
New Revision: 349277
URL: http://svn.apache.org/viewcvs?rev=349277&view=rev
Log:
Add an FAQ page, using the Maven plugin to generate it.
Added:
jakarta/commons/proper/fileupload/trunk/xdocs/faq.fml
Modified:
jakarta/commons/proper/fileupload/trunk/project.xml
jakarta/commons/proper/fileupload/trunk/xdocs/index.xml
jakarta/commons/proper/fileupload/trunk/xdocs/navigation.xml
Modified: jakarta/commons/proper/fileupload/trunk/project.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/fileupload/trunk/project.xml?rev=349277&r1=349276&r2=349277&view=diff
==============================================================================
--- jakarta/commons/proper/fileupload/trunk/project.xml (original)
+++ jakarta/commons/proper/fileupload/trunk/project.xml Sun Nov 27 11:05:16 2005
@@ -181,9 +181,12 @@
</build>
<reports>
+ <report>maven-changes-plugin</report>
<report>maven-changelog-plugin</report>
<report>maven-checkstyle-plugin</report>
+ <!--report>maven-clover-plugin</report-->
<report>maven-developer-activity-plugin</report>
+ <report>maven-faq-plugin</report>
<report>maven-file-activity-plugin</report>
<report>maven-javadoc-plugin</report>
<report>maven-jdepend-plugin</report>
@@ -191,8 +194,9 @@
<report>maven-jxr-plugin</report>
<report>maven-license-plugin</report>
<!--report>maven-linkcheck-plugin</report-->
+ <report>maven-pmd-plugin</report>
+ <report>maven-simian-plugin</report>
<report>maven-tasklist-plugin</report>
-<!-- <report>maven-clover-plugin</report> -->
</reports>
</project>
Added: jakarta/commons/proper/fileupload/trunk/xdocs/faq.fml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/fileupload/trunk/xdocs/faq.fml?rev=349277&view=auto
==============================================================================
--- jakarta/commons/proper/fileupload/trunk/xdocs/faq.fml (added)
+++ jakarta/commons/proper/fileupload/trunk/xdocs/faq.fml Sun Nov 27 11:05:16
2005
@@ -0,0 +1,95 @@
+<?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.
+-->
+
+<faqs title="FileUpload FAQ">
+
+ <part id="general">
+ <title>General</title>
+
+ <faq id="empty-parse">
+ <question>
+ Why is parseRequest() returning no items?
+ </question>
+ <answer>
+ This most commonly happens when the request has already been
parsed, or
+ processed in some other way. Since the input stream has aleady
been
+ consumed by that earlier process, it is no longer available for
parsing
+ by Commons FileUpload.
+ </answer>
+ </faq>
+
+ <faq id="read-timeout">
+ <question>
+ Why am I getting "Read timed out" exceptions while parsing?
+ </question>
+ <answer>
+ The most common cause of these exceptions is when FileUpload is
being
+ used on a site that is using the Tomcat ISAPI redirector. There
was a
+ bug in earlier versions of that component that caused problems
with
+ multipart requests. The bug was fixed some time ago, so you
probably
+ just need to pick up a newer version. See the
+ <a
href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=15278";>Tomcat bug
report</a>
+ for full details.
+ </answer>
+ </faq>
+
+ <faq id="class-not-found">
+ <question>
+ Why is NoClassDefFoundError being thrown while parsing?
+ </question>
+ <answer>
+ This most commonly happens when attempting to rely on a shared copy
of
+ the Commons FileUpload jar file provided by your web container.
The
+ solution is to include the FileUpload jar file as part of your
own
+ web application, instead of relying on the container.
+ </answer>
+ </faq>
+ </part>
+
+ <part id="struts">
+ <title>FileUpload and Struts</title>
+
+ <faq id="parse-in-action-fails">
+ <question>
+ I'm using FileUpload in an Action, but it's not working. Why?
+ </question>
+ <answer>
+ Struts recognises multipart requests, and parses them automatically,
+ presenting the request parameters to your code in the same
manner as
+ if they were regular request parameters. Since Struts has
already
+ processed the request, and made it available in your form bean,
the
+ input stream is no longer available for parsing, so attempting
to do
+ so with FileUpload will fail.
+ </answer>
+ </faq>
+
+ <faq id="howto-parse-in-action">
+ <question>
+ But I need to parse the request myself. How can I do that?
+ </question>
+ <answer>
+ Struts parses multipart a request as a part of the process of
populating
+ your form bean from that request. If, for some reason, you need
to have
+ full control over the multipart parsing, you can do so by
configuring
+ your action mapping without an associated form bean. (A better
way of
+ doing this, however, is to replace the default multipart
handler with
+ your own. See the Struts documentation for details.)
+ </answer>
+ </faq>
+ </part>
+
+</faqs>
Modified: jakarta/commons/proper/fileupload/trunk/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/fileupload/trunk/xdocs/index.xml?rev=349277&r1=349276&r2=349277&view=diff
==============================================================================
--- jakarta/commons/proper/fileupload/trunk/xdocs/index.xml (original)
+++ jakarta/commons/proper/fileupload/trunk/xdocs/index.xml Sun Nov 27 11:05:16
2005
@@ -45,6 +45,7 @@
The following documentation is available:
<ul>
<li><a href="using.html">User Guide</a></li>
+ <li><a href="faq.html">Frequently Asked Questions</a></li>
<li><a href="apidocs/index.html">JavaDoc API</a></li>
<li><a href="maven-reports.html">Project Reports</a></li>
</ul>
Modified: jakarta/commons/proper/fileupload/trunk/xdocs/navigation.xml
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/fileupload/trunk/xdocs/navigation.xml?rev=349277&r1=349276&r2=349277&view=diff
==============================================================================
--- jakarta/commons/proper/fileupload/trunk/xdocs/navigation.xml (original)
+++ jakarta/commons/proper/fileupload/trunk/xdocs/navigation.xml Sun Nov 27
11:05:16 2005
@@ -32,6 +32,7 @@
<item name="Overview" href="/index.html"/>
<item name="User guide" href="/using.html"/>
<!--item name="Customization" href="/customizing.html"/-->
+ <item name="FAQ" href="/faq.html"/>
<item name="Javadoc" href="apidocs/index.html"/>
<item name="Mailing lists" href="/mail-lists.html"/>
<item name="Team" href="/team-list.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
