Author: vkorluzhenko
Date: 2007-09-21 12:01:43 -0400 (Fri, 21 Sep 2007)
New Revision: 3056
Modified:
trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
trunk/docs/userguide/en/src/main/docbook/included/form.xml
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/push.xml
trunk/docs/userguide/en/src/main/docbook/included/region.xml
trunk/docs/userguide/en/src/main/docbook/included/spacer.xml
trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml
trunk/docs/userguide/en/src/main/docbook/included/support.xml
trunk/docs/userguide/en/src/main/docbook/included/toolBarGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/tree.xml
Log:
http://jira.jboss.com/jira/browse/RF-769 Added commas to attributes by E. Hvasko
Modified: trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-09-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -75,7 +75,7 @@
a good place for update the list of re-rendered components, for example.
Ajax Listener is not invoked for non-Ajax request and when RichFaces works in "Ajax
Request generates
Non-Ajax Response" mode. Therefore, Ajax Listener invocation is a good indicator
that Ajax response is going to be processed.
-Attribute 'type' defines the fully qualified Java class name for listener. This
class should implement org.ajax4jsf.framework.ajax.AjaxListener
+Attribute "type" defines the fully qualified Java class name for
listener. This class should implement org.ajax4jsf.framework.ajax.AjaxListener
interface. You can access to the source of the event (Ajax component) using
event.getSource() call.
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/form.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-09-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -57,7 +57,7 @@
<property>"true"</property>
</emphasis>, it becomes possible to set Ajax submission way for any
components inside, i.e. not a page URL is used as an <emphasis >
<property>"action"</property>
- </emphasis> attribute, but the javascript:A4J.AJAX.Submit(...) call. In this
case, rendering is defined as reRender=list of Ids for the form element
itself.</para>
+ </emphasis> attribute, but the javascript:A4J.AJAX.Submit(...) call. In this
case, rendering is defined as "reRender"=list of Ids for the form
element itself.</para>
<para>Example</para>
<programlisting role="XML"><![CDATA[<a4j:form
id="helloForm" ajaxSubmit="true" reRender="table">
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-09-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -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, action and actionListener can be invoked, and reRendering
some parts of
+ Action attributes. Hence, "action" and
"actionListener" can be invoked, and reRendering some parts of
the page fired after calling function. </para>
<para> When using the <emphasis role="bold">
<property><a4j:jsFunction></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-09-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -84,7 +84,7 @@
<para>As it was shown in the example above there are two main
components:</para>
<itemizedlist>
<listitem>
- createContent 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 >
+ "createContent" 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>"value"</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-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/message.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -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 'showSummary'
defines possibility to
+ state defined (on initial rendering).Boolean attribute
"showSummary" 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-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -249,11 +249,11 @@
RichFaces Development Forum</ulink>.</para>
<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 'showWhenRendered' and 'keepVisualState'.
</para>
- <para> showWhenRendered - This boolean attribute is used if modalPanel should
be rendered after
+ attributes like "showWhenRendered" and
"keepVisualState". </para>
+ <para> "showWhenRendered" - This boolean attribute is used if
modalPanel should be rendered after
first page loading. </para>
- <para> keepVisualState - Used if modalPanel should save state after submission.
If
- keepVisualState=true then parameters which modalPanel has during opening should be
submitted
+ <para> "keepVisualState" - Used if modalPanel should save
state after submission. If
+ "keepVisualState"=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-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -77,9 +77,9 @@
</h:panelGrid>
</a4j:outputPanel>
]]></programlisting>
- <para>In addition to the areas directly indicated in reRender attribute of Ajax
components, <emphasis role="bold">
+ <para>In addition to the areas directly indicated in
"reRender" attribute of Ajax components, <emphasis
role="bold">
<property><a4j:outputPanel></property>
- </emphasis> allows to update a part of a page basing on its own flag. The
flag is defined by the ajaxRendered 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 "ajaxRendered" 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>"reRender
"</property></emphasis> attribute refers directly to the updating
panelGrid and not to the framing outputPanel, and it's more semantically
correct.</para>
<para><emphasis
role="bold"><property><a4j:outPanel></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'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 keepTransient 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'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 "keepTransient" 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 "f:verbatim" attribute, <emphasis
role="bold">
<property><a4j:outputPanel></property>
</emphasis> doesn't improve this JSF implementation option in any
way, so you still have to use this tag where it'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-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/page.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -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><a4j:page></property></emphasis>
usage is required.</para>
<para>The component is rendered as a full HTML page template (it was shown in
the example). The "<emphasis >
<property>head</property>
- </emphasis>" section is defined with the help of the corresponding
facet with the name="head" and also there is an attribute with the same
name for contentType definition.</para>
+ </emphasis>" section is defined with the help of the corresponding
facet with the name="head" and also there is an attribute with the same
name for "contentType" 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-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/panel.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -142,15 +142,15 @@
<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> styleClass and style </listitem>
- <listitem> headerClass and headerStyle </listitem>
- <listitem> bodyClass and bodyStyle </listitem>
+ <listitem> "styleClass" and "style"
</listitem>
+ <listitem> "headerClass" and
"headerStyle" </listitem>
+ <listitem> "bodyClass" and "bodyStyle"
</listitem>
</itemizedlist>
<para>Moreover, to add e.g. some JavaScript effects, events defined on it are
used.</para>
<itemizedlist>
- <listitem> onmouseover </listitem>
- <listitem> onclick </listitem>
- <listitem> onmouseout </listitem>
+ <listitem> "onmouseover" </listitem>
+ <listitem> "onclick" </listitem>
+ <listitem> "onmouseout" </listitem>
<listitem> etc. </listitem>
</itemizedlist>
Modified: trunk/docs/userguide/en/src/main/docbook/included/push.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-09-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -57,7 +57,7 @@
There are some attributes which allows to customize of the component behaviour:
</para>
<para>
-'interval' - Interval (in ms) for call push requests. Default value 1000 (1
sec).
+"interval" - Interval (in ms) for call push requests. Default value
1000 (1 sec).
<!-- If "0" a connection is permanent. Also you can set different value for
parameter 'timeout'. -->
</para>
<para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/region.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-09-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/region.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -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
"link1" and the internal one is decoded for the
"link2".</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 selfRendered attribute setting to
<emphasis><property>"true"</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 "selfRendered" attribute setting to
<emphasis><property>"true"</property></emphasis>
on <emphasis role="bold">
<property><a4j:region></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't come into a component tree as well as omitting of <emphasis
role="bold">
<property><a4j:outputPanel></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/spacer.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/spacer.xml 2007-09-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/spacer.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -71,8 +71,8 @@
<property><rich:spacer></property>
</emphasis> is a simple layout component which represents a transparent
<property>spacer</property>. Thus, the main attributes that define its
style are <emphasis>
- <property>style</property>
- </emphasis> and
<emphasis><property>styleClass</property>.</emphasis></para>
+ <property>"style"</property>
+ </emphasis> and
<emphasis><property>"styleClass"</property>.</emphasis></para>
<para>In addition, the attributes are responsible for the component size:
<emphasis>
<property>"width"</property>
</emphasis> and
<emphasis><property>"height"</property>.</emphasis></para>
@@ -94,9 +94,9 @@
own CSS (replacing in the result properties defined in a skin with your
own).</para>
<para>To define appearance of the particular
<property>spacer</property>, it's possible
to write your own CSS classes and properties in the component style attributes
- (<emphasis><property>style</property>, </emphasis>
+ (<emphasis><property>"style"</property>,
</emphasis>
<emphasis>
- <property>styleClass</property>
+ <property>"styleClass"</property>
</emphasis>) modifying component property.</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml 2007-09-21
15:55:29 UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/suggestionBox.xml 2007-09-21
16:01:43 UTC (rev 3056)
@@ -193,7 +193,7 @@
<section>
<para>
There is possibility to define what be shown if the autocomplete returns empty list.
-Attribute "nothingLabel" or facet with the same name could be used for it.
+Attribute "nothingLabel" 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-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/support.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -102,7 +102,7 @@
<para><emphasis
><property>"ajaxSingle"</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>"limitToList"</property></emphasis> is
an attribute that allows to limit areas, which are updated after the responses. Only
these components defined in the reRender attribute are updated. </para>
+ <para><emphasis
><property>"limitToList"</property></emphasis> is
an attribute that allows to limit areas, which are updated after the responses. Only
these components defined in the "reRender" attribute are updated.
</para>
</listitem>
</itemizedlist></para>
<para><emphasis role="bold">Example
1:</emphasis></para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/toolBarGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/toolBarGroup.xml 2007-09-21 15:55:29
UTC (rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/toolBarGroup.xml 2007-09-21 16:01:43
UTC (rev 3056)
@@ -167,9 +167,9 @@
<emphasis
<property>style class</property></emphasis> of a
generated component, i.e.
to redefine at once all
<property>toolBarGroups</property> appearance on a page, redefine this class
in your CSS.</para>
- <para>The component also has the standard attribute style and <emphasis
+ <para>The component also has the standard attribute "style" and
<emphasis
-><property>style class</property></emphasis> that could redefine an
+><property>"style class"</property></emphasis>
that could redefine an
appearance of particular component variants.
</para>
<para>It's necessary to define a class according to the corresponding
name, so as an
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-09-21 15:55:29 UTC
(rev 3055)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-09-21 16:01:43 UTC
(rev 3056)
@@ -72,7 +72,7 @@
<title>Details of Usage</title>
<para>As it has been mentioned <link
linkend="tree">above</link> the tree component allows to render any
tree-like structure
of data.</para>
- <para>A bean property is passed into a tree
<property>value</property> attribute. The property
+ <para>A bean property is passed into a tree
<property>"value"</property> attribute. The property
keeps the structure of a org.richfaces.component.TreeNode type (you could have a
look at this
interface description in the <ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichface...