You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2006/02/11 03:30:08 UTC

svn commit: r376912 - in /struts/action/trunk/xdocs/faqs: kickstart.fml kickstart.xml newbie.fml newbie.xml

Author: husted
Date: Fri Feb 10 18:30:07 2006
New Revision: 376912

URL: http://svn.apache.org/viewcvs?rev=376912&view=rev
Log:
FAQ Plugin
* Migrate Kickstart and Newbie FAQ to plugin format. 

Added:
    struts/action/trunk/xdocs/faqs/kickstart.fml
      - copied, changed from r376902, struts/action/trunk/xdocs/faqs/kickstart.xml
    struts/action/trunk/xdocs/faqs/newbie.fml
      - copied, changed from r376902, struts/action/trunk/xdocs/faqs/newbie.xml
Removed:
    struts/action/trunk/xdocs/faqs/kickstart.xml
    struts/action/trunk/xdocs/faqs/newbie.xml

Copied: struts/action/trunk/xdocs/faqs/kickstart.fml (from r376902, struts/action/trunk/xdocs/faqs/kickstart.xml)
URL: http://svn.apache.org/viewcvs/struts/action/trunk/xdocs/faqs/kickstart.fml?p2=struts/action/trunk/xdocs/faqs/kickstart.fml&p1=struts/action/trunk/xdocs/faqs/kickstart.xml&r1=376902&r2=376912&rev=376912&view=diff
==============================================================================
--- struts/action/trunk/xdocs/faqs/kickstart.xml (original)
+++ struts/action/trunk/xdocs/faqs/kickstart.fml Fri Feb 10 18:30:07 2006
@@ -16,66 +16,12 @@
 <!--
 // ======================================================================== 78
 -->
-<document>
-    <properties>
-        <title>Kickstart FAQ</title>
-    </properties>
-    <body>
-        <a name="faq"/>
-        <section name="Kickstart FAQ">
+<faqs title="Kickstart FAQ">
+    <part>
 
-            <a name="contents"/>
-            <subsection name="Index">
-
-                <p>
-                    Here are answers to the usual getting-started questions.
-                </p>
-
-                <ul>
-                    <li>
-                        <a href="#why">Why do we need Struts Action
-                            Framework?</a>
-                    </li>
-                    <li>
-                        <a href="#how">How does Struts Action work?</a>
-                    </li>
-                    <li>
-                        <a href="#compat">Is Struts Action Framework
-                            compatible with other Java technologies?</a>
-                    </li>
-                    <li>
-                        <a href="#who">Who wrote Struts Action Framework?</a>
-                    </li>
-                </ul>
-                <ul>
-                    <li>
-                        <a href="#where">Where can I get a copy of Struts
-                            Action Framework?</a>
-                    </li>
-                    <li>
-                        <a href="#install">How do I install Struts Action
-                            Framework?</a>
-                    </li>
-                    <li>
-                        <a href="#jar">When do I need the struts-action.jar on
-                            my classpath?</a>
-                    </li>
-                    <li>
-                        <a href="#tests">Does Struts Action Framework provide
-                            its own unit tests?</a>
-                    </li>
-                </ul>
-            </subsection>
-
-            <p>
-                For other kickstart questions, see the
-                <a href="http://struts.apache.org/faqs.html">Apache Struts
-                    Site FAQ</a>
-                .
-            </p>
-
-            <a name="why"/>
-            <subsection name="Why do we need Struts Action Framework?">
+        <faq id="why">
+            <question>Why do we need Struts Action Framework?"</question>
+            <answer>
                 <p>Java technologies give developers a serious boost when
                     creating and maintaining applications to meet the demands
                     of today's public Web sites and enterprise intranets.
@@ -83,11 +29,15 @@
                     technologies into a unified framework. The end result is a
                     cooperative, synergistic framework, suitable for
                     development teams, independent developers, and everyone in
-                    between.</p>
-            </subsection>
+                    between.
+                </p>
 
-            <a name="how"/>
-            <subsection name="How does Struts Action Framework work?">
+            </answer>
+        </faq>
+
+        <faq id="how">
+            <question>How does Struts Action Framework work?</question>
+            <answer>
                 <p>Java Servlets are designed to handle requests made by Web
                     browsers. Server pages are designed to create dynamic Web
                     pages that can turn billboard sites into live
@@ -96,18 +46,22 @@
                     browsers to the appropriate server page. This makes Web
                     applications much easier to design, create, and
                     maintain.</p>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="compat"/>
-            <subsection
-                    name="Is Struts Action Framework compatible with other Java technologies?">
+        <faq id="compat">
+            <question>Is Struts Action Framework compatible with other Java
+                technologies?</question>
+            <answer>
                 <p>Yes. Struts is committed to supporting industry standards.
                     Struts acts as an integrator of Java technologies so that
                     they can be used in the &quot;real world&quot;.</p>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="who"/>
-            <subsection name="Who wrote Struts Action Framework?">
+        <faq id="who">
+            <question>Who wrote Struts Action Framework"</question>
+            <answer>
                 <p>There are several
                     <a href="../volunteers.html">active committers</a>
                     to the Apache Struts project, working cooperatively from
@@ -132,20 +86,23 @@
                     based on JavaServerFaces, called Shale. Both Struts Action
                     Framework and Struts Shale are first-class citizens of the
                     Apache Struts project.</p>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="where"/>
-            <subsection
+        <faq id="where">
+            <answer
                     name="Where can I get a copy of Struts Action Framework?">
                 <p>The best place to download Apahce Struts products is at
                     <a href="http://struts.apache.org/">struts.apache.org</a>
                     . The nightly builds are very stable, and recommended as
                     the best place to start today.
                 </p>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="install"/>
-            <subsection name="How do I install Struts Action Framework?">
+        <faq id="install">
+            <question>How do I install Struts Action Framework?</question>
+            <answer>
                 <p>To develop applications with Struts, you can usually just
                     add the Struts JAR file
                     to your Java development environment. You can then start
@@ -182,11 +139,13 @@
                         containers</a>
                     are available.
                 </p>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="jar"/>
-            <subsection
-                    name="When do I need &quot;struts-action.jar&quot; on my classpath?">
+        <faq id="jar">
+            <question>When do I need &quot;struts-action.jar&quot; on my
+                classpath?</question>
+            <answer>
                 <p>When you are compiling an application that uses the Struts
                     classes, you must have the &quot;struts-action.jar&quot;
                     on the classpath your
@@ -229,11 +188,13 @@
                             /path/to/struts-action.jar:$CLASSPATH $@</em>
                     </li>
                 </ul>
-            </subsection>
+            </answer>
+        </faq>
 
-            <a name="tests"/>
-            <subsection
-                    name="Does Struts Action Framework include its own unit tests?">
+        <faq id="tests">
+            <question>Does Struts Action Framework include its own unit
+                tests?</question>
+            <answer>
                 <p>
                     Struts Action Framework currently has two testing
                     environments, to reflect the fact that
@@ -270,9 +231,7 @@
                     <a href="http://jakarta.apache.org/cactus">Cactus</a>
                     .
                 </p>
-            </subsection>
-
-
-        </section>
-    </body>
-</document>
+            </answer>
+        </faq>
+    </part>
+</faqs>

Copied: struts/action/trunk/xdocs/faqs/newbie.fml (from r376902, struts/action/trunk/xdocs/faqs/newbie.xml)
URL: http://svn.apache.org/viewcvs/struts/action/trunk/xdocs/faqs/newbie.fml?p2=struts/action/trunk/xdocs/faqs/newbie.fml&p1=struts/action/trunk/xdocs/faqs/newbie.xml&r1=376902&r2=376912&rev=376912&view=diff
==============================================================================
--- struts/action/trunk/xdocs/faqs/newbie.xml (original)
+++ struts/action/trunk/xdocs/faqs/newbie.fml Fri Feb 10 18:30:07 2006
@@ -16,124 +16,12 @@
 <!--
 // ======================================================================== 78
 -->
-<document>
-
-    <properties>
-        <title>Newbie FAQ</title>
-    </properties>
-    <body>
-        <section href="faq" name="Newbie FAQ">
-
-            <a name="contents"/>
-            <subsection name="Index">
-
-                <p>
-                    Here are answers to the most common questions people ask
-                    when using
-                    the framework on their first project.
-                </p>
-
-                <ul>
-
-                    <li>
-                        <a href="#modules">What is a modular application? What
-                            does
-                            module-relative mean?</a>
-                    </li>
-
-                    <li>
-                        <a href="#naming">Why are some of the class and
-                            element names
-                            counter-intuitive?</a>
-                    </li>
-
-                    <li>
-                        <a href="#actionForms">Whither ActionForms?</a>
-                    </li>
-
-                    <li>
-                        <a href="#actionFormInterface">Why is ActionForm a
-                            base class rather than an interface?</a>
-                    </li>
-
-                    <li>
-                        <a href="#news">Can I use other beans or hashmaps with
-                            ActionForms?</a>
-                    </li>
-
-                    <li>
-                        <a href="#authenticate">How can I authenticate my
-                            users?</a>
-                    </li>
-
-                    <li>
-                        <a href="#jsp">Do I have to use JSPs with my
-                            application?</a>
-                    </li>
-
-                    <li>
-                        <a href="#formbeans">Do ActionForms have to be true
-                            JavaBeans?</a>
-                    </li>
-
-                    <li>
-                        <a href="#separate">Do I have to have a separate
-                            ActionForm bean
-                            for every HTML form?</a>
-                    </li>
-
-                    <li>
-                        <a href="#prepopulate">How can I prepopulate a
-                            form?</a>
-                    </li>
-
-                    <li>
-                        <a href="#noForm">Can I have an Action without a
-                            form?</a>
-                    </li>
-
-                    <li>
-                        <a href="#requiredif">Can you give me a simple example
-                            of using the requiredif Validator rule?</a>
-                    </li>
-
-                    <li>
-                        <a href="#validate">When is the best time to validate
-                            input?</a>
-                    </li>
-
-                    <li>
-                        <a href="#avoidValidate">How can I avoid validating a
-                            form before data is entered?</a>
-                    </li>
-
-                    <li>
-                        <a href="#wizard">How can I create a "wizard"
-                            workflow?</a>
-                    </li>
-
-                    <li>
-                        <a href="#chaining">How can I "chain" Actions?</a>
-                    </li>
-
-                </ul>
-
-                <p>
-                    If you like to
-                    <a href="helping.html">contribute</a>
-                    ,
-                    there is a list of
-                    <a href="#undocumented">undocumented questions</a>
-                    at the end of this page.
-                </p>
-
-            </subsection>
-
-
-            <a name="modules"/>
-            <subsection
-                    name="What is a modular application? What does module-relative mean?">
+<faqs title="Newbie FAQ">
+        <part>
 
+            <faq id="modules">
+	    <question>What is a modular application? What does module-relative mean?</question>                    
+            <answer>
                 <p>
                     Since Struts 1.1, the framework supports multiple
                     application modules. All applications have at
@@ -178,12 +66,12 @@
                     that was assembled from several
                     applications that were created independently.
                 </p>
+            </answer>
+            </faq>
 
-            </subsection>
-
-            <a name="naming"/>
-            <subsection
-                    name="Why are some of the class and element names counter-intuitive?">
+            <faq id="naming">
+            <question>Why are some of the class and element names counter-intuitive?</question>
+            <answer>
                 <p>
                     The framework grew in the telling and, as it evolved, some
                     of the names
@@ -197,10 +85,12 @@
                     down early and
                     then become difficult to change.
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="actionForms"/>
-            <subsection name="Whither ActionForms?">
+            <faq id="actionForms">
+            <question>Whither ActionForms?</question>
+	    <answer>
                 <p>
                     <a href="http://www.mail-archive.com/struts-user@jakarta.apache.org/msg19281.html">
                         http://www.mail-archive.com/struts-user@jakarta.apache.org/msg19281.html</a>
@@ -212,11 +102,12 @@
                         http://www.mail-archive.com/struts-user@jakarta.apache.org/msg20833.html</a>
                     <br/>
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="actionFormInterface"/>
-            <subsection
-                    name="Why is ActionForm a base class rather than an interface?">
+            <faq id="actionFormInterface">
+            <question>Why is ActionForm a base class rather than an interface?</question>
+            <answer>
                 <p>
                     Originally, the rationale as that making ActionForm a
                     class takes advantage of the single
@@ -248,10 +139,12 @@
                     <a href="https://formdef.dev.java.net/">FormDef</a>
                     .
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="JavaBeans"/>
-            <subsection name="Do ActionForms have to be true JavaBeans?">
+            <faq id="JavaBeans">
+            <question>Do ActionForms have to be true JavaBeans?</question>
+            <answer>
                 <p>
                     The utilities that the framework uses (Commons-BeanUtils
                     since 1.1) require that ActionForm properties follow
@@ -278,11 +171,12 @@
                     <a href="#otherBeans">Using Hashmaps with ActionForms</a>
                     in this FAQ.
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="otherBeans"/>
-            <subsection
-                    name="Can I use other beans or hashmaps with ActionForms?">
+            <faq id="otherBeans">
+            <question>Can I use other beans or hashmaps with ActionForms?</question>
+            <answer>
                 <p>
                     Yes. There are several ways that you can use other beans
                     or hashmaps with ActionForms.
@@ -404,10 +298,12 @@
                         Map-Backed ActionForms</a>
                     (since Struts 1.1)
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="authenticate"/>
-            <subsection name="How can I authenticate my users?">
+            <faq id="authenticate">
+            <question>How can I authenticate my users?</question>
+            <answer>
                 <p>
                     <a href="http://www.mail-archive.com/struts-user@jakarta.apache.org/msg24504.html">
                         http://www.mail-archive.com/struts-user@jakarta.apache.org/msg24504.html</a>
@@ -415,10 +311,12 @@
                     <a href="http://www.mail-archive.com/struts-user@jakarta.apache.org/msg22949.html">
                         http://www.mail-archive.com/struts-user@jakarta.apache.org/msg22949.html</a>
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="jsp"/>
-            <subsection name="Do I have to use JSPs with my application?">
+            <faq id="jsp">
+            <question>Do I have to use JSPs with my application?</question>
+            <answer>
 
                 <p>
                     The short answer to this question is: No, you are not
@@ -467,10 +365,12 @@
                     like PHP, into the same web application.
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="formbeans"/>
-            <subsection name="Do ActionForms have to be true JavaBeans?">
+            <faq id="formbeans">
+            <question>Do ActionForms have to be true JavaBeans?</question>
+            <answer>
 
                 <p>ActionForms are added to a servlet scope (session or
                     request)
@@ -612,11 +512,12 @@
                     http://java.sun.com/products/javabeans/docs/beans.101.pdf</a>
 
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="separate"/>
-            <subsection
-                    name="Do I have to have a separate ActionForm bean for every HTML form?">
+            <faq id="separate">
+            <question>Do I have to have a separate ActionForm bean for every HTML form?</question>
+            <answer>
 
                 <p>This is an interesting question. As a newbie, it is a good
                     practice to create a new
@@ -711,10 +612,12 @@
                     combinations.
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="prepopulate"/>
-            <subsection name="How can I prepopulate a form?">
+            <faq id="prepopulate">
+            <question>How can I prepopulate a form?</question>
+            <answer>
 
                 <p>The simplest way to prepopulate a form is to have an
                     <code>Action</code>
@@ -844,10 +747,12 @@
                     </li>
                 </ul>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="noForm"/>
-            <subsection name="Can I have an Action without a form?">
+            <faq id="noForm">
+            <question>Can I have an Action without a form?</question>
+            <answer>
                 <p>
                     Yes. If your
                     <code>Action</code>
@@ -887,11 +792,12 @@
                     even if it is an empty subclass without any properties.
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="requiredif"/>
-            <subsection
-                    name="Can you give me a simple example of using the requiredif Validator rule?">
+            <faq id="requiredif">
+            <question>Can you give me a simple example of using the requiredif Validator rule?</question>
+            <answer>
                 <p>First off, there's an even newer Validator rule called
                     <code>validwhen</code>
                     ,
@@ -971,10 +877,12 @@
                     &lt;/field&gt;
                     &lt;/form&gt;
                 </pre>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="validate"/>
-            <subsection name="When is the best time to validate input?">
+            <faq id="validate">
+            <question>When is the best time to validate input?</question>
+            <answer>
                 <p>
                     This is an excellent question. Let's step back a second
                     and think about a
@@ -1061,11 +969,12 @@
                     <a href="../userGuide/dev_validator.html">
                         User Guide</a>
                 </p>
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="avoidValidate"/>
-            <subsection
-                    name="How can I avoid validating a form before data is entered?">
+            <faq id="avoidValidate">
+            <question>How can I avoid validating a form before data is entered?"</question>
+            <answer>
                 <p>
                     The simplest way is to have two actions. The first one has
                     the job of setting
@@ -1108,10 +1017,12 @@
                     .
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="wizard"/>
-            <subsection name="How can I create a wizard workflow?">
+            <faq id="wizard">
+            <question>How can I create a wizard workflow?</question>
+            <answer>
                 <p>
                     The basic idea is a series of actions with next, back,
                     cancel
@@ -1213,10 +1124,12 @@
                     - the 'cancel' page
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="chaining"/>
-            <subsection name="How can I 'chain' Actions?">
+            <faq id="chaining">
+            <question>How can I 'chain' Actions?</question>
+            <answer>
                 <p>
                     Chaining actions can be done by simply using the proper
                     mapping in your
@@ -1348,12 +1261,12 @@
                     the formbean when the second Action is called.
                 </p>
 
-            </subsection>
+            </answer>
+            </faq>
 
-            <a name="undocumented"/>
-            <subsection
-                    name="If you would like to contribute, here is a list of
-    popular but undocumented questions">
+            <faq id="undocumented">
+            <question>If you would like to contribute, here is a list of popular but undocumented questions</question>
+            <answer>
 
                 <ul>
 
@@ -1366,9 +1279,8 @@
                         ActionMapping, ActionServlet) class?</li>
 
                 </ul>
-
-            </subsection>
-
-        </section>
-    </body>
-</document>
+                
+            </answer>
+            </faq>
+        </part>
+</faqs>



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