You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cr...@apache.org on 2002/06/17 11:11:07 UTC

cvs commit: xml-cocoon2/src/webapp/samples/xmlform/wizard start.xml

crossley    2002/06/17 02:11:07

  Modified:    src/documentation/xdocs/userdocs/concepts book.xml
               src/webapp/samples samples.xml
               src/webapp/samples/xmlform README.txt sitemap.xmap
               src/webapp/samples/xmlform/wizard start.xml
  Added:       src/documentation/xdocs/userdocs/concepts xmlform.xml
               src/webapp/samples/xmlform overview.html
  Log:
  Add new XMLForm Overview document, gleaning text from the temporary README.
  Fixed overview documentation and link from Samples page.
  PR: 9720 [PATCH] Form handling documentation link does not work
  Submitted by: Andrew Savory <an...@luminas.co.uk>
  
  Revision  Changes    Path
  1.5       +1 -0      xml-cocoon2/src/documentation/xdocs/userdocs/concepts/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/concepts/book.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- book.xml	28 Apr 2002 18:11:12 -0000	1.4
  +++ book.xml	17 Jun 2002 09:11:06 -0000	1.5
  @@ -22,6 +22,7 @@
       <menu-item label="Persistence" href="persistence.html"/>
       <menu-item label="StoreJanitor" href="storejanitor.html"/>
       <menu-item label="XMLSearching" href="xmlsearching.html"/>
  +    <menu-item label="XMLForm" href="xmlform.html"/>
       <menu-item label="Databases" href="databases.html"/>
       <menu-item label="Modules" href="modules.html"/>
     </menu>
  
  
  
  1.1                  xml-cocoon2/src/documentation/xdocs/userdocs/concepts/xmlform.xml
  
  Index: xmlform.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "document-v10.dtd">
  
  <document>
    <header>
      <title>XMLForm Handling</title>
      <authors>
        <person name="Ivelin Ivanov" email="ivelin@apache.org"/>
        <person name="Daniel Fagerstrom" email="daniel.fagerstrom@swipnet.se"/>
      </authors>
    </header>
    <body>
      <s1 title="Notice">
        <p>This document is based on components included in the current Cocoon 2.1
        distribution. If you do not have this version, you can obtain it from
        the <link href="../../index.html">Apache Cocoon</link> web site. Be sure
        to look at the WARNING document that accompanies such pre-release versions.
        </p>
      </s1>
  
      <s1 title="Introduction">
        <p>The XMLForm framework is inspired by Apache Jakarta Struts and
        W3C XForms.</p>
  
        <p>Its goal is to:</p>
  
        <ul>
  
        <li>Ease the development of sophisticated web applications
        utilizing complex data types and multi-page transactions</li>
  
        <li>Provide an automated 2 way mapping between
        <![CDATA[
        HTML Forms <-> XML <-> JavaBeans
        ]]></li>
  
        <li>Use standard XML schema languages like XML Schema, Relax-NG,
        Schematron for data validation</li>
  
        <li>Promote complete reuse of Cocoon Actions for:</li>
        <ul>
          <li>UI centric web applications - HTML, WML, UXL, VoiceML,
          etc.</li>
          <li>Web Services (based on the REST paradigm)</li>
          <li>Remote Portal Forms. (An interactive extension of static
          content formats like Netscape RSS)</li>
        </ul>
        <li>Utilize XPath tools like Apache Jakarta Commons JXPath for
        read/write access to JavaBeans, DOM nodes and mixed objects.</li>
        <li>Utilize the existing Cocoon XML functional testing framework
        - AntEater.</li>
        </ul>
  
        <p>The current implementation offers the following features:</p>
  
        <ol>
          <li>Automated 2 way binding of HTML Forms to JavaBeans (and DOM
          nodes) through XPath</li>
          <li>Automatic validation of JavaBeans(and DOM nodes) through
          Schematron schemas</li>
          <li>Intermediate XForms like XML markup for form views</li>
        </ol>
      </s1>
  
      <s1 title="Background">
        <p>The aim of XMLForm, is to build and edit an xml document
        (called the instance), subject to constraints from some schema
        (XMLSchema, Schematron, ...), through a sequence of form pages.
        The instance is either a dom-document or a Java bean-structure or
        a mix. XMLForm consist, of three main components:</p>
  
        <ul>
        <li>Form - is responsible for the instance and validation of it.
        Form objects are stored in request attributes for one page forms
        and session attributes for wizards (multi page forms). A Form can
        be populated from the request parameters. This is the "model in
        MVC terms.</li>
  
        <li>XMLFormTransformer - takes a form descriptor, (similar to
        XForms) as input and  fill it with data and error messages from a
        Form object that is referred in an attribute. This is the "view"
        in MVC terms.</li>
  
        <li>AbstractXMLFormAction, (WizardAction) - creates the Form
        object if necessary and populates it with data based on the
        request parameters. It can also take care of flow handling and
        checkbox state. This is the "controller" in MVC terms.</li>
        </ul>
  
      </s1>
  
      <s1 title="Demonstration">
       <p>
        See XMLForm in action with the 
        <link href="../../overview.html#samples">Cocoon Samples</link> ...
        <link href="../../../samples/xmlform/">XMLForm Demonstration</link>
       </p>
      </s1>
  
      <s1 title="Further information">
      <p>See the
       <link href="../../howto/xmlform-wizard/howto-xmlform-wizard.html">Cocoon XMLForm How-To</link>
      </p>
  
      <p>Please discuss Cocoon XMLForm on the
      <link href="../../mail-lists.html">mailing lists</link>
      </p>
  
      </s1>
    </body>
  </document>
  
  
  
  1.12      +7 -13     xml-cocoon2/src/webapp/samples/samples.xml
  
  Index: samples.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/webapp/samples/samples.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- samples.xml	16 Jun 2002 07:10:27 -0000	1.11
  +++ samples.xml	17 Jun 2002 09:11:07 -0000	1.12
  @@ -69,22 +69,16 @@
      </sample>
     </group>
     
  -  <group name="Form Handling">
  -   <sample name="Documentation" href="xmlform/README.txt">
  +  <group name="XMLForm Handling">
  +   <sample name="Documentation" href="xmlform/overview.html">
       Introduction to Cocoon's form handling framework,
  -    which provides 
  -        <xlink:link href="http://www.w3.org/MarkUp/Forms/">XForms</xlink:link>
  -    based markup, 
  -        <xlink:a href="http://www.ascc.net/xml/resource/schematron/schematron.html">Schematron</xlink:a>
  -    instance validation and
  -    automated binding to 
  -        <xlink:a href="http://java.sun.com/products/javabeans/">JavaBeans</xlink:a> and 
  -        <xlink:a href="http://www.w3.org/DOM/">DOM</xlink:a> instances.   
  +    which provides W3C XForms based markup, Schematron instance validation,
  +    and automated binding to JavaBeans and DOM instances.   
      </sample>
   
      <sample name="Examples" href="xmlform/wizard.html">
  -        Presents a sophisticated form handling demo - 
  -        multi page wizard with two way navigation.
  +    Presents a sophisticated form handling demo ...
  +    multi-page wizard with two-way navigation.
      </sample>
     </group>
     
  
  
  
  1.3       +9 -72     xml-cocoon2/src/webapp/samples/xmlform/README.txt
  
  Index: README.txt
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/webapp/samples/xmlform/README.txt,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- README.txt	22 May 2002 03:56:05 -0000	1.2
  +++ README.txt	17 Jun 2002 09:11:07 -0000	1.3
  @@ -1,78 +1,17 @@
  +================================================================================
  +NOTE: information from this document is being gradually moved into
  +xdocs/userdocs/concepts/xmlform.xml
  +================================================================================
   
  +<snip moved Ivelin Ivanov Introduction/>
   
  -The XMLForm framework is inspired by Apache Jakarta Struts and W3C XForms. 
  +<snip moved Daniel Fagerstrom Background/>
   
  -Its goal is to:
   
  -* Ease the development of sophisticated web applications utilizing complex data types and multi-page transactions
  +--------------------------------------------------------------------------------
   
  -* Provide an automated 2 way mapping between HTML Forms <-> XML <-> JavaBeans
  -
  -* Use standard XML schema languages like XML Schema, Relax-NG, Schematron for data validation
  -
  -* Promote complete reuse of Cocoon Actions for:
  -	- UI centric web applications - HTML, WML, UXL, VoiceML, etc.
  -	- Web Services (based on the REST paradigm)
  -    - Remote Portal Forms. (An interactive extension of static content formats like Netscape RSS)
  -
  -* Utilize XPath tools like Apache Jakarta Commons JXPath for read/write access to JavaBeans, DOM nodes and mixed objects.
  -
  -* Utilize the existing Cocoon XML functional testing framework - AntEater.
  -
  ---------------------------------------------------------------------------------------------
  -
  -The current implementation offers the following features:
  -
  -1) Automated 2 way binding of HTML Forms to JavaBeans (and DOM nodes) through XPath
  -2) Automatic validation of JavaBeans(and DOM nodes) through Schematron schemas
  -3) Intermediate XForms like XML markup for form views
  -
  ---------------------------------------------------------------------------------------------
  -
  -To try the demo, link to:
  -
  -http://localhost:8080/cocoon/samples/xmlform/wizard.html
  -
  ---------------------------------------------------------------------------------------------
  -
  -For questions contact:
  -
  -Ivelin Ivanov, ivelin@apache.org
  -
  -
  ---------------------------------------------------------------------------------------------
  -
  -Following is a summary provided by Daniel Fagerstrom <da...@swipnet.se>
  -
  -
  -Background
  -----------
  -
  -The aim of XMLForm, is to build and edit an xml document (called the
  -instance), subject to constraints from some schema (XMLSchema, Schematron,
  -...), through a sequence of form pages. The instance is either a
  -dom-document or a Java bean-structure or a mix. XMLForm consist, of
  -three main components:
  -
  -* Form - is responsible for the instance and validation of it. Form objects
  -are stored in request attributes for one page forms and session attributes
  -for wizards (multi page forms). A Form can be populated from the request
  -parameters. This is the "model in MVC terms.
  -
  -* XMLFormTransformer - takes a form descriptor, (similar to XForms) as input
  -and  fill it with data and error messages from a Form object that is
  -referred in an attribute. This is the "view" in MVC terms.
  -
  -* AbstractXMLFormAction, (WizardAction) - creates the Form object if
  -necessary and populates it with data based on the request parameters. It can
  -also take care of flow handling and checkbox state. This is the "controller" in MVC terms.
  -
  -
  -
  -
  ---------------------------------------------------------------------------------------------
  -
  -Following are copies of the announcement emails send to the Cocoon development mailing list.
  +Following are copies of the announcement emails send to the Cocoon development
  +mailing list.
   cocoon-dev@xml.apache.org <co...@xml.apache.org>
   
   
  @@ -164,8 +103,6 @@
   Cc: "Oliver Becker" <ob...@informatik.hu-berlin.de>; "Rick Jelliffe" <ri...@allette.com.au>; "Dmitri Plotnikov" <dm...@plotnix.com>
   Sent: Sunday, March 24, 2002 7:03 AM
   Subject: [Announcement] Fast Schematron Validation Here !
  -
  -
   
   We've got the rainbow !
   
  
  
  
  1.3       +6 -1      xml-cocoon2/src/webapp/samples/xmlform/sitemap.xmap
  
  Index: sitemap.xmap
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/webapp/samples/xmlform/sitemap.xmap,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sitemap.xmap	23 May 2002 13:39:47 -0000	1.2
  +++ sitemap.xmap	17 Jun 2002 09:11:07 -0000	1.3
  @@ -28,7 +28,12 @@
       <map:pipeline>
   
         <map:match pattern="">
  -        <map:redirect-to uri="wizard.html"/>
  +        <map:redirect-to uri="overview.html"/>
  +      </map:match>
  +
  +      <map:match pattern="overview.html">
  +       <map:read src="overview.html"/>
  +       <map:serialize type="html"/>
         </map:match>
   
         <!-- A non-trivial example - Feedback Wizard -->
  
  
  
  1.1                  xml-cocoon2/src/webapp/samples/xmlform/overview.html
  
  Index: overview.html
  ===================================================================
  <html>
  <head>
   <title>Demonstration of XMLForm</title>
  </head>
  <body bgcolor="#FFFFFF">
  <h1>Demonstration of XMLForm</h1>
  
  <p>
  Here is the <a href="wizard.html">XMLForm Demonstration</a>
  </p>
  
  <p>
  See the Apache Cocoon documentation
  <a href="../../documents/userdocs/concepts/xmlform.html">XMLForm Handling</a>
  for an overview and the 
  <a href="../../documents/howto/xmlform-wizard/howto-xmlform-wizard.html">Cocoon XMLForm How-To</a>
  </p>
  
  <p>
  The Cocoon XMLForm handling framework provides
  <a href="http://www.w3.org/MarkUp/Forms/">W3C XForms</a> based markup,
  <a href="http://www.ascc.net/xml/resource/schematron/schematron.html">Schematron</a>
  instance validation, and automated binding to
  <a href="http://java.sun.com/products/javabeans/">JavaBeans</a> and
  <a href="http://www.w3.org/DOM/">DOM</a> instances.
  </p>
  </body>
  </html>
  
  
  
  1.2       +7 -4      xml-cocoon2/src/webapp/samples/xmlform/wizard/start.xml
  
  Index: start.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/webapp/samples/xmlform/wizard/start.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- start.xml	20 May 2002 13:33:50 -0000	1.1
  +++ start.xml	17 Jun 2002 09:11:07 -0000	1.2
  @@ -13,12 +13,15 @@
   
           <tr>
               <td align="center" class="info">
  -                <code>
  +                <p>
                   This wizard will collect feedback information
                   for the     
  -                <a href="http://xml.apache.org/cocoon">Apache Cocoon</a>
  -                project !
  -                </code>
  +                <a href="http://xml.apache.org/cocoon/">Apache Cocoon</a>
  +                project.
  +                </p>
  +                <p>
  +                 See <a href="overview.html">overview</a> documentation.
  +                </p>
               </td>
           </tr>
            
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org