Author: smukhina Date: 2007-09-24 11:55:23 -0400 (Mon, 24 Sep 2007) New Revision: 3073 Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml trunk/docs/userguide/en/src/main/docbook/included/message.xml trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml trunk/docs/userguide/en/src/main/docbook/included/page.xml trunk/docs/userguide/en/src/main/docbook/included/panel.xml trunk/docs/userguide/en/src/main/docbook/included/region.xml trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml trunk/docs/userguide/en/src/main/docbook/included/support.xml Log: http://jira.jboss.com/jira/browse/RF-769 Added highlighting to a newly marked attributes Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -68,7 +68,7 @@ <section> <title>Key attributes and ways of usage</title> <para> As the component uses Ajax request to get data from server - it has all common Ajax - Action attributes. Hence, &quot;action&quot; and &quot;actionListener&quot; can be invoked, and reRendering some parts of + Action attributes. Hence, &quot;action&quot; and<emphasis><property> &quot;actionListener&quot; </property></emphasis>can be invoked, and reRendering some parts of the page fired after calling function. </para> <para> When using the <emphasis role="bold"> <property>&lt;a4j:jsFunction&gt;</property> Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -84,7 +84,7 @@ <para>As it was shown in the example above there are two main components:</para> <itemizedlist> <listitem> - &quot;createContent&quot; specifies a method accepting 2 parameters. The first (of java.io.OutputStream type) defines a stream, where any binary data is output. The second (of java.lang.Object type) contains deserialized object with data specified in the <emphasis > + <emphasis><property> &quot;createContent&quot; </property></emphasis>specifies a method accepting 2 parameters. The first (of java.io.OutputStream type) defines a stream, where any binary data is output. The second (of java.lang.Object type) contains deserialized object with data specified in the <emphasis > <property>&quot;value&quot;</property> </emphasis> attribute. </listitem> Modified: trunk/docs/userguide/en/src/main/docbook/included/message.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/message.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/message.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -99,7 +99,7 @@ <para> The following example shows different variants of customization of the component. The attribute 'passedLabel' is used for definition the label to be displayed when no message appears. But the message component isn't appears before the form submission even with passed - state defined (on initial rendering).Boolean attribute &quot;showSummary&quot; defines possibility to + state defined (on initial rendering).Boolean attribute<emphasis><property> &quot;showSummary&quot; </property></emphasis>defines possibility to display summary portion of displayed messages. The facets "errorMarker" and 'passedMarker' set corresponding images for markers. </para> Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -249,11 +249,11 @@ <para> There is a possibility to restore of the previous component state on a page (including position on the screen) after submitting and reloading. The modalPanel has some special - attributes like &quot;showWhenRendered&quot; and &quot;keepVisualState&quot;. </para> - <para> &quot;showWhenRendered&quot; - This boolean attribute is used if modalPanel should be rendered after + attributes like <emphasis><property>&quot;showWhenRendered&quot;</emphasis></property> and <emphasis><property>&quot;keepVisualState&quot;</emphasis></property>. </para> + <para> <emphasis><property>&quot;showWhenRendered&quot;</emphasis></property> - This boolean attribute is used if modalPanel should be rendered after first page loading. </para> - <para> &quot;keepVisualState&quot; - Used if modalPanel should save state after submission. If - &quot;keepVisualState&quot;=true then parameters which modalPanel has during opening should be submitted + <para><emphasis><property><emphasis><property> &quot;keepVisualState&quot;</property></emphasis> </property></emphasis>- Used if modalPanel should save state after submission. If + <emphasis><property> &quot;keepVisualState&quot;</property></emphasis>=true then parameters which modalPanel has during opening should be submitted and passed to new page. </para> <para> Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -77,9 +77,9 @@ </h:panelGrid> </a4j:outputPanel> ]]></programlisting> - <para>In addition to the areas directly indicated in &quot;reRender&quot; attribute of Ajax components, <emphasis role="bold"> + <para>In addition to the areas directly indicated in<emphasis><property> &quot;reRender&quot; </property></emphasis>attribute of Ajax components, <emphasis role="bold"> <property>&lt;a4j:outputPanel&gt;</property> - </emphasis> allows to update a part of a page basing on its own flag. The flag is defined by the &quot;ajaxRendered&quot; attribute. The flag is commonly used when a part of a page must be updated or can be updated on any response.</para> + </emphasis> allows to update a part of a page basing on its own flag. The flag is defined by the<emphasis><property> &quot;ajaxRendered&quot; </property></emphasis>attribute. The flag is commonly used when a part of a page must be updated or can be updated on any response.</para> <para><emphasis role="bold">Example:</emphasis></para> <programlisting role="XML"><![CDATA[<a4j:outputPanel ajaxRendered="true"> <h:messages/> @@ -116,7 +116,7 @@ ]]></programlisting> <para>As you see, the code is very similar to the one shown above, but <emphasis ><property>&quot;reRender &quot;</property></emphasis> attribute refers directly to the updating panelGrid and not to the framing outputPanel, and it&apos;s more semantically correct.</para> <para><emphasis role="bold"><property>&lt;a4j:outPanel&gt;</property></emphasis> should be used for non-JSF component part framing, which is to be updated on Ajax response, as Ajax4jsf specifies the list of updating areas as a list of an existing JSF component. </para> - <para>On default non-JSF context isn&apos;t saved in a component tree, but is rendered anew every time. To accelerate the processing speed and Ajax response input speed, Ajax4jsf saves non-JSF context in a component tree on default. This option could be canceled by &quot;keepTransient&quot; attribute that cancels transient flag forced setting for child components. This flag setting keeps the current value set by child components.</para> + <para>On default non-JSF context isn&apos;t saved in a component tree, but is rendered anew every time. To accelerate the processing speed and Ajax response input speed, Ajax4jsf saves non-JSF context in a component tree on default. This option could be canceled by<emphasis><property> &quot;keepTransient&quot; </property></emphasis>attribute that cancels transient flag forced setting for child components. This flag setting keeps the current value set by child components.</para> <para>Note: In JSF 1.1 implementation and lower, where non-JSF context should be framed with the &quot;f:verbatim&quot; attribute, <emphasis role="bold"> <property>&lt;a4j:outputPanel&gt;</property> </emphasis> doesn&apos;t improve this JSF implementation option in any way, so you still have to use this tag where it&apos;s necessary without Ajax4jsf usage. </para> Modified: trunk/docs/userguide/en/src/main/docbook/included/page.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -82,7 +82,7 @@ </emphasis> on a page round the Ajax updatable area. In the last versions of both frameworks the problem is successfully fixed and no <emphasis role="bold"><property>&lt;a4j:page&gt;</property></emphasis> usage is required.</para> <para>The component is rendered as a full HTML page template (it was shown in the example). The &quot;<emphasis > <property>head</property> - </emphasis>&quot; section is defined with the help of the corresponding facet with the name=&quot;head&quot; and also there is an attribute with the same name for &quot;contentType&quot; definition.</para> + </emphasis>&quot; section is defined with the help of the corresponding facet with the name=&quot;head&quot; and also there is an attribute with the same name for<emphasis><property> &quot;contentType&quot; </property></emphasis>definition.</para> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/panel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/panel.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/panel.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -142,9 +142,9 @@ <para>As it has been mentioned <link linkend="panel">above</link>, the component is mostly used for a page style definition, hence the main attributes are style ones.</para> <itemizedlist> - <listitem> &quot;styleClass&quot; and &quot;style&quot; </listitem> - <listitem> &quot;headerClass&quot; and &quot;headerStyle&quot; </listitem> - <listitem> &quot;bodyClass&quot; and &quot;bodyStyle&quot; </listitem> + <listitem><emphasis><property> &quot;styleClass&quot; </property></emphasis>and &quot;style&quot; </listitem> + <listitem><emphasis><property> &quot;headerClass&quot; </property></emphasis>and<emphasis><property> &quot;headerStyle&quot; </property></emphasis></listitem> + <listitem><emphasis><property> &quot;bodyClass&quot; </property></emphasis>and<emphasis><property> &quot;bodyStyle&quot; </property></emphasis></listitem> </itemizedlist> <para>Moreover, to add e.g. some JavaScript effects, events defined on it are used.</para> <itemizedlist> Modified: trunk/docs/userguide/en/src/main/docbook/included/region.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -85,7 +85,7 @@ <!--..Some content that will be decoded on server after Ajax request.--> </a4j:region >]]></programlisting> <para>Therefore, the external region is decoded for the &quot;link1&quot; and the internal one is decoded for the &quot;link2&quot;.</para> - <para>Ajax4jsf allows setting Ajax responses rendering directly basing on component tree nodes without referring to the JSP (XHTML) page code. It could be defined by &quot;selfRendered&quot; attribute setting to <emphasis><property>&quot;true&quot;</property></emphasis> on <emphasis role="bold"> + <para>Ajax4jsf allows setting Ajax responses rendering directly basing on component tree nodes without referring to the JSP (XHTML) page code. It could be defined by<emphasis><property> &quot;selfRendered&quot; </property></emphasis>attribute setting to <emphasis><property>&quot;true&quot;</property></emphasis> on <emphasis role="bold"> <property>&lt;a4j:region&gt;</property> </emphasis> and could help considerably speed up a response output. However, this rapid processing could cause missing of transient components that present on view and don&apos;t come into a component tree as well as omitting of <emphasis role="bold"> <property>&lt;a4j:outputPanel&gt;</property> @@ -115,7 +115,7 @@ <para>This example shows that one of the regions is decoded when a link is used inside. Nevertheless, if after processing the &quot;link1&quot; is clicked, the first region passes into Encode as a root region and encode performance time is reduced. This optimization doesn&apos;t allow data update out of the - region and should be implemented very carefully. The data out of the region described with &quot;renderRegionOnly&quot;=&quot;false&quot; is updated successfully.</para> + region and should be implemented very carefully. The data out of the region described with<emphasis><property> &quot;renderRegionOnly&quot;</property></emphasis>=&quot;false&quot; is updated successfully.</para> </section> <section> <title>Relevant resources links</title> Modified: trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -193,7 +193,7 @@ <section> <para> There is possibility to define what be shown if the autocomplete returns empty list. -Attribute &quot;nothingLabel&quot; or facet with the same name could be used for it. +Attribute<emphasis><property> &quot;nothingLabel&quot; </property></emphasis>or facet with the same name could be used for it. </para> <para> <emphasis role="bold">Example:</emphasis> Modified: trunk/docs/userguide/en/src/main/docbook/included/support.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-09-24 14:02:29 UTC (rev 3072) +++ trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-09-24 15:55:23 UTC (rev 3073) @@ -102,7 +102,7 @@ <para><emphasis ><property>&quot;ajaxSingle&quot;</property></emphasis> is an attribute that allows submission on the server only component sending a request, as if the component presented on a separate form. </para> - <para><emphasis ><property>&quot;limitToList&quot;</property></emphasis> is an attribute that allows to limit areas, which are updated after the responses. Only these components defined in the &quot;reRender&quot; attribute are updated. </para> + <para><emphasis ><property>&quot;limitToList&quot;</property></emphasis> is an attribute that allows to limit areas, which are updated after the responses. Only these components defined in the <emphasis><property> &quot;reRender&quot; </property></emphasis>attribute are updated. </para> </listitem> </itemizedlist></para> <para><emphasis role="bold">Example 1:</emphasis></para> @@ -123,7 +123,7 @@ </h:inputText> <h:outputText value="#{person.name}" id="test"/> </form>]]></programlisting> - <para>In this example the component &quot;h:messages&quot; is always updated (as it capturing all Ajax requests, located in ajaxRendered <emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis>), except the case when a response is sent from the input component from the example. On sending this component marks that updating area is limited to the defined in it components, it means that on its usage with &quot;limitToList&quot;=&quot;true&quot; the only component updated is the one with &quot;d&quot;=&quot;test&quot;.</para> + <para>In this example the component &quot;h:messages&quot; is always updated (as it capturing all Ajax requests, located in ajaxRendered <emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis>), except the case when a response is sent from the input component from the example. On sending this component marks that updating area is limited to the defined in it components, it means that on its usage with<emphasis><property> &quot;limitToList&quot;</property></emphasis>=&quot;true&quot; the only component updated is the one with &quot;d&quot;=&quot;test&quot;.</para> <itemizedlist> <listitem> <emphasis role="bold">Limitation of requests frequency and updates quantity after the responses. </emphasis>