Author: atsebro Date: 2009-06-20 09:14:39 -0400 (Sat, 20 Jun 2009) New Revision: 14667 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.desc.xml branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.xml Log: RF-7406: a4j:form component description review: Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.desc.xml =================================================================== --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.desc.xml 2009-06-20 13:14:16 UTC (rev 14666) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.desc.xml 2009-06-20 13:14:39 UTC (rev 14667) @@ -8,8 +8,8 @@ </keywordset> </sectioninfo> <title>Description</title> - <para>The <emphasis role="bold"> - <property>&lt;a4j:form&gt;</property> - </emphasis> component is very similar to the same component from the JSF HTML library, the only slight difference is in generation of links inside and possibility of Ajax by-default submission.</para> + <para> + The <emphasis role="bold"><property>&lt;a4j:form&gt;</property></emphasis> component is very similar to JSF <emphasis role="bold"><property>&lt;h:form&gt;</property></emphasis> the only difference is in generation of links inside and possibility of default Ajax submission. + </para> </section> </chapter> Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.xml =================================================================== --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.xml 2009-06-20 13:14:16 UTC (rev 14666) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/form.xml 2009-06-20 13:14:39 UTC (rev 14667) @@ -36,7 +36,7 @@ </table> <section> - <title>Creating on a page</title> + <title>Creating the Component with a Page Tag</title> <para>Component definition on a page is similar to definition of the original component from JSF HTML library. </para> <para> @@ -61,8 +61,9 @@ ...]]></programlisting> </section> <section> - <title>Key attributes and ways of usage</title> - <para>The difference with the original component is that all hidden fields + <title>Details of usahe</title> + <para> + The difference with the original component is that all hidden fields required for command links are always rendered and it doesn't depend on links rendering on the initial page. It solves the problem with invalid links that weren't rendered on a page immediately, but after @@ -97,44 +98,23 @@ ... </a4j:form> ]]></programlisting> - <para>This example shows that in order to make <emphasis role="bold"> - <property>&lt;t:datascroller&gt;</property> - </emphasis> submissions to be Ajax ones it&apos;s required only to - place this <emphasis role="bold"> - <property>&lt;t:datascroller&gt;</property> - </emphasis> into <emphasis role="bold"> - <property>&lt;a4j:form&gt;</property> - </emphasis>. In the other case it is necessary to redefine renders for - its child links elements that are defined as <emphasis role="bold"> - <property>&lt;h:commandLink&gt;</property> - </emphasis> and can't be made Ajax ones with using e.g. <emphasis - role="bold"> - <property>&lt;a4j:support&gt;</property> - </emphasis>. </para> - <para> With the help of <emphasis> - <property>&quot;limitToList&quot;</property> - </emphasis> attribute you can limit areas, which are updated after the - responses. If <emphasis> - <property>&quot;limitToList&quot;</property> - </emphasis> is true, only the reRender attribute is taken in account. - Therefore, if you use blocks of text wrapped with <emphasis - role="bold"> - <property>&lt;a4j:outputPanel&gt;</property> - </emphasis> and <code>ajaxRendered= &quot;true&quot;</code>, - blocks of text are ignored. </para> - <para> Information about the <emphasis> - <property>&quot;process&quot;</property> - </emphasis> attribute usage you can find in the - <link linkend="process"> &quot;Decide what to process&quot; </link> guide section. </para> + <para> + This example shows that in order to make <emphasis role="bold"><property>&lt;t:datascroller&gt;</property></emphasis> submissions to be Ajax ones it&apos;s required only to place this <emphasis role="bold"><property>&lt;t:datascroller&gt;</property></emphasis> into <emphasis role="bold"><property>&lt;a4j:form&gt;</property></emphasis>. + In the other case it is necessary to redefine renders for its child links elements that are defined as <emphasis role="bold"><property>&lt;h:commandLink&gt;</property></emphasis> and can't be made Ajax ones with using e.g. <emphasis role="bold"><property>&lt;a4j:support&gt;</property></emphasis>. + </para> + <para> + With the help of <emphasis><property>&quot;limitToList&quot;</property></emphasis> attribute you can limit areas, which are updated after the responses. + If <emphasis><property>&quot;limitToList&quot;</property></emphasis> is true, only the reRender attribute is taken in account. + Therefore, if you use blocks of text wrapped with <emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis> and <code>ajaxRendered= &quot;true&quot;</code>, blocks of text are ignored. + </para> + <para> + Information about the <emphasis><property>&quot;process&quot;</property></emphasis> attribute usage you can find in the &quot;<link linkend="process">Decide what to process</link>&quot; guide section. + </para> </section> <section> <title>Relevant resources links</title> <para> - <ulink - url="http://livedemo.exadel.com/richfaces-demo/richfaces/form.jsf?c=... - >On the component LiveDemo page</ulink> you can see the example of <emphasis - role="bold"> - <property>&lt;a4j:form&gt;</property> - </emphasis> usage and sources for the given example. </para> + Vizit <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/form.jsf?c=... at RichFaces Livedemo for examples of component usage and their sources. + a</para> </section> </chapter>