cziegeler 2003/07/14 02:36:41
Modified: src/documentation/xdocs/userdocs/flow api.xml woody.xml jxforms.xml Log: Making docs validate Revision Changes Path 1.18 +9 -12 cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml Index: api.xml =================================================================== RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v retrieving revision 1.17 retrieving revision 1.18 diff -u -r1.17 -r1.18 --- api.xml 13 Jul 2003 19:53:14 -0000 1.17 +++ api.xml 14 Jul 2003 09:36:41 -0000 1.18 @@ -28,11 +28,11 @@ <p>Classes in packages under <code>java</code> are accessible directly in your scripts.</p> <p>Note that classes under <code>java.lang</code> are not automatically imported, however:</p> - <p><source>var n = new java.lang.Integer(3);</source></p> + <source>var n = new java.lang.Integer(3);</source> <p>All other java packages and classes are accessible under the property <code>Packages</code>:</p> - <p><source>var tree = new Packages.javax.swing.JTree();</source></p> + <source>var tree = new Packages.javax.swing.JTree();</source> <p>You can get the effect of Java imports using the <code>importPackage()</code> and <code>importClass()</code> functions:</p> <table> @@ -63,16 +63,14 @@ </table> <p> If your Java classes have getters and setters you can access them as properties in JavaScript:</p> - <p> <source> var d = new java.util.Date(); d.year = 2003; // same effect as d.setYear(2003); - </source> - </p> + </source> </s1> <s1 title="Flow Object Model"> <p>Cocoon provides a set of system objects for use by Flowscripts. We call this set of objects the Flow Object Model (<em>FOM</em>). - The Flow Object Model contains following objects: + The Flow Object Model contains following objects:</p> <ul> <li><link href="#cocoon">Cocoon</link></li> <li><link href="#request">Request</link></li> @@ -83,7 +81,6 @@ <li><link href="#log">Log</link></li> <li><link href="#WebContinuation">WebContinuation</link></li> </ul> - </p> <s2 title = "Cocoon Object"><anchor id="cocoon"/> <p>The <code>Cocoon</code> object represents the current Cocoon Sitemap. This is the entry point into the FOM. There is one instance of <code>Cocoon</code> which you may access in your scripts as the global variable <code>cocoon</code>, for example like this:</p> <source> @@ -95,31 +92,31 @@ <s3 title="request"> <p>The current Cocoon request:</p> <p> - <em>Property</em> <code>[<link href="#request">Request</link>] request</code> + <em>Property</em> [<link href="#request">Request</link>] request </p> </s3> <s3 title="response"> <p>The current Cocoon response:</p> <p> - <em>Property</em> <code>[<link href="#response">Response</link>] response</code> + <em>Property</em> [<link href="#response">Response</link>] response </p> </s3> <s3 title="session"> <p>The current Cocoon session:</p> <p> - <em>Property</em> <code>[<link href="#session">Session</link>] session</code> + <em>Property</em> [<link href="#session">Session</link>] session </p> </s3> <s3 title="context"> <p>The current Cocoon application context:</p> <p> - <em>Property</em> <code>[<link href="#context">Context</link>] context</code> + <em>Property</em> [<link href="#context">Context</link>] context </p> </s3> <s3 title="log"> <p>A reference to the current logger:</p> <p> - <em>Property</em> <code>[<link href="#log">Log</link>] log</code> + <em>Property</em> [<link href="#log">Log</link>] log </p> </s3> 1.4 +2 -2 cocoon-2.1/src/documentation/xdocs/userdocs/flow/woody.xml Index: woody.xml =================================================================== RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/woody.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- woody.xml 14 Jul 2003 09:29:49 -0000 1.3 +++ woody.xml 14 Jul 2003 09:36:41 -0000 1.4 @@ -63,11 +63,11 @@ <p> </p> <s2 title ="The woody function"><anchor id="woody"/> - <p>The entry point to a Woody form is the <code>woody()</code> function: + <p>The entry point to a Woody form is the <code>woody()</code> function:</p> <p> <em>Function</em> <code>woody(form_function, form_definition, attribut_name)</code> </p> - You call the + <p> You call the <code>woody</code> function from your sitemap to create a new form, for example:</p> <source><![CDATA[ 1.4 +5 -5 cocoon-2.1/src/documentation/xdocs/userdocs/flow/jxforms.xml Index: jxforms.xml =================================================================== RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/jxforms.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- jxforms.xml 14 Jul 2003 01:00:15 -0000 1.3 +++ jxforms.xml 14 Jul 2003 09:36:41 -0000 1.4 @@ -60,13 +60,13 @@ </submit></source> <p> In your Flow script you would supply an appropriate model, for example, like this:</p> - <p><source> + <source> var model = { method: "cash", number: "", expiry: "" } - </source></p> + </source> <p> Since JXForms uses <link href="http://jakarta.apache.org/commons/jxpath">JXPath</link>, your model may consist of any objects that <link href="http://jakarta.apache.org/commons/jxpath">JXPath</link> supports. </p> @@ -74,7 +74,7 @@ Use the <code>setModel()</code> function of the form to associate your model with the form. Then use the <code>sendView()</code> function of the form to display it. Upon submission of the form, the model will be automatically updated and you can take action in your script based on its values: </p> - <p><source> + <source> var model = { method: "cash", number: "", @@ -90,7 +90,7 @@ } else if (model.method == "credit") { .... } - </source></p> + </source> <p> JXForms also supports declarative <link href="#validation">validation</link> of form elements using Schematron, and automated <link href="#backNext">support</link> for back/forward navigation in multi-page forms using continuations. </p> @@ -369,7 +369,7 @@ </p> <p>Computes the value of an xpath expression against the model of this form</p> </s3> - <s3 title = "iterate"><anchor id="getValue"/> + <s3 title = "iterate"><anchor id="iterate"/> <p> <em>Function</em> <code>[java.util.Iterator] iterate([String] xpath)</code> </p>