Author: smukhina
Date: 2008-07-15 08:51:09 -0400 (Tue, 15 Jul 2008)
New Revision: 9606
Modified:
trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml
trunk/docs/userguide/en/src/main/docbook/included/comboBox.xml
trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml
trunk/docs/userguide/en/src/main/docbook/included/dragIndicator.xml
trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml
trunk/docs/userguide/en/src/main/docbook/included/effect.xml
trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
trunk/docs/userguide/en/src/main/docbook/included/form.xml
trunk/docs/userguide/en/src/main/docbook/included/include.xml
trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml
trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml
trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
trunk/docs/userguide/en/src/main/docbook/included/menuGroup.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/message.xml
trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml
trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCtechreqs.xml
Log:
http://jira.jboss.com/jira/browse/RF-3875
RF guide review
Modified: trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/actionparam.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -57,7 +57,7 @@
</emphasis> and <emphasis role="bold">
<property><f:actionListener></property>
</emphasis>.</para>
- <para>At the render phase, it's decoded by parent component
(<emphasis role="bold">
+ <para>At the render phase, it's decoded by parent component
(<emphasis role="bold">
<property><h:commandLink></property>
</emphasis> or like) as usual. At the process request phase, if the
parent component
performs an action event, update the
<emphasis><property>"value"</property></emphasis>
specified in the
<emphasis><property>"assignTo"</property></emphasis>
Modified: trunk/docs/userguide/en/src/main/docbook/included/comboBox.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/comboBox.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/comboBox.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -253,7 +253,7 @@
</para></listitem>
</itemizedlist>
</para>
- <!-- <para>It's possible to handle events for comboBox from
JavaScript code. A simplest example of usage JavaScript API is placed below:</para>
+ <!-- <para>It's possible to handle events for comboBox from
JavaScript code. A simplest example of usage JavaScript API is placed below:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -321,13 +321,13 @@
</emphasis> out from
<emphasis role="bold">
<property><h:outputText></property>
- </emphasis>to provide component's correct work.
+ </emphasis>to provide component's correct work.
</para>
</note>
- <!-- <para>It's possible to handle events for contextMenu from
JavaScript code. A simplest example of usage JavaScript API is placed below:</para>
+ <!-- <para>It's possible to handle events for contextMenu from
JavaScript code. A simplest example of usage JavaScript API is placed below:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -428,14 +428,14 @@
<property>"action"</property>
</emphasis> and <emphasis>
<property>"actionListener"</property>
- </emphasis> item's attributes are ignored. Menu items don't
fire any submits
+ </emphasis> item's attributes are ignored. Menu items
don't fire any submits
themselves. The behavior is fully defined by the components nested inside
items.</para>
<template
<para>emphasis role="bold">
<property><contextMenu></property>
</emphasis> could not be generated for every component where
it's defined. Templating could
be used instead. So only representation data could be loaded from server. And
markup
- could be evaluated on client side. So it's should accept
macrosubstitutions like
+ could be evaluated on client side. So it's should accept
macrosubstitutions like
{value} </para>
</para-->
Modified: trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/dataFilterSlider.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -133,7 +133,7 @@
<property><rich:dataFilterSlider></property>
</emphasis> component has no skin parameters and special <emphasis>
<property>style classes</property></emphasis>, as it consists
of one element generated with a your method on the server. To
- define some style properties such as an indent or a border, it's possible to
use <emphasis>
+ define some style properties such as an indent or a border, it's possible
to use <emphasis>
<property>"style"</property>
</emphasis> and <emphasis>
<property>"styleClass"</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dragIndicator.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dragIndicator.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/dragIndicator.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -267,7 +267,7 @@
<para>The <emphasis
role="bold"><property><rich:dragIndicator></property></emphasis>
component has no skin parameters and special <emphasis>
<property>style classes</property></emphasis>, as it consists of
one element
generated with a your method on the server. To define some style properties such as
an indent
- or a border, it's possible to use <emphasis>
+ or a border, it's possible to use <emphasis>
<property>"style"</property></emphasis> and
<emphasis>
<property>"styleClass"</property></emphasis>
attributes on the component.</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -98,7 +98,7 @@
The
<property>dragSupport</property>
tag inside a component completely specifies the events and
- JavaScript required to use the component and it's children
+ JavaScript required to use the component and it's children
for dragging as part of a drag-and-drop operation. In order
to work, though,
<property>dragSupport</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/effect.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -145,10 +145,10 @@
<emphasis>
<property>"for"</property>
</emphasis> attribute defines the id of the component or html tag, the effect
is attached
- to. Richfaces converts the <emphasis>
+ to. RichFaces converts the <emphasis>
<property>"for"</property>
</emphasis> attribute value to the client id of the component if such
component is found. If
- not, the value is left as is for possible wiring with on the DOM element's id
on the client
+ not, the value is left as is for possible wiring with on the DOM element's
id on the client
side. By default, the target of the effect is the same element that effect pointed
to.
However, the target element is might be overridden with <emphasis>
<property>"targetId"</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/fileUpload.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -357,7 +357,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>It's possible to handle events for fileUpload using JavaScript
code. A simplest example of usage JavaScript API is placed below:</para>
+ <para>It's possible to handle events for fileUpload using
JavaScript code. A simplest example of usage JavaScript API is placed below:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/form.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/form.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -87,7 +87,7 @@
]]></programlisting>
<para>This example shows that in order to make <emphasis
role="bold">
<property><t:datascroller></property>
- </emphasis> submissions to be Ajax ones it's required only to place this
<emphasis role="bold">
+ </emphasis> submissions to be Ajax ones it's required only to place
this <emphasis role="bold">
<property><t:datascroller></property>
</emphasis> into <emphasis role="bold">
<property><a4j:form></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/include.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/include.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/include.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -56,7 +56,7 @@
<a4j:commandButton action="next" reRender="wizard"/>
...
]]></programlisting>
-<para>And in faces-config it's defined:</para>
+<para>And in faces-config it's defined:</para>
<para>
<emphasis role="bold">Example:</emphasis>
Modified: trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -137,7 +137,7 @@
if the attribute is
"true"
after the current value reaches the border value
- it's be reversed to another border value after next
+ it's be reversed to another border value after next
increasing/decreasing. In other case possibilities
of next increasing/decreasing are locked
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -240,7 +240,7 @@
<para>In addition, RichFaces allows using either a component id or client id if
you apply the
query to a JSF component. When you define a selector, RichFaces examines its
content and
- tries to replace the defined in the selector id with a component id if it's
found.</para>
+ tries to replace the defined in the selector id with a component id if
it's found.</para>
<para>For example, you have the following code:</para>
<programlisting role="XML"><![CDATA[...
Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -100,7 +100,7 @@
<note><title>Note:</title><para>A bean class transmitted into
value should <code>implement Serializable</code> interface.
</para>
</note>
- <para>Hence, when using the component it's possible to output your data of
any type on a page with Ajax requests.</para>
+ <para>Hence, when using the component it's possible to output your data
of any type on a page with Ajax requests.</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuGroup.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuGroup.desc.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuGroup.desc.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -21,7 +21,7 @@
<title>Key Features</title>
<itemizedlist>
<listitem><para>Highly customizable
look-and-feel</para></listitem>
- <listitem><para>Grouping of any menu's
items</para></listitem>
+ <listitem><para>Grouping of any menu's
items</para></listitem>
<listitem><para>Pop-up appearance event
customization</para></listitem>
<listitem><para>Support for disabling</para></listitem>
<listitem><para>Smart user-defined
positioning</para></listitem>
Modified: trunk/docs/userguide/en/src/main/docbook/included/message.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/message.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/message.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -74,7 +74,7 @@
<para> The component has the same behavior as standard <emphasis
role="bold">
<property><h:message></property>
</emphasis>component except next two features: <itemizedlist>
- <listitem><para>It's ajaxRendered. It means that the component is
reRendered after Ajax request
+ <listitem><para>It's ajaxRendered. It means that the
component is reRendered after Ajax request
automatically without outputPanel usage</para></listitem>
<listitem><para>The component optionally provides "passed"
state which will be shown if no message is displayed</para></listitem>
<listitem><para>Provides possibility to add some marker to message.
By default a marker element
Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -107,7 +107,7 @@
<para> The <emphasis>
<property>"selection" </property>
</emphasis> attribute stores the collection of items selected by you.
In the example
- below after submitting the form the current collection is placed in the
object's
+ below after submitting the form the current collection is placed in the
object's
property and then <emphasis role="bold">
<property><rich:dataTable></property>
</emphasis> with selected items is shown. </para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml
===================================================================
---
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++
trunk/docs/userguide/en/src/main/docbook/included/recursiveTreeNodesAdaptor.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -199,7 +199,7 @@
<para>
<emphasis><property>"for"</property></emphasis>
attribute defines the id of the component or html tag, the effect will be attached to.
Richfaces converts the
<emphasis><property>"for"</property></emphasis>
attribute value to the client id of the component if such component is found. If not, the
value is left as is for possible
-wiring with on the DOM element's id on the client side.
+wiring with on the DOM element's id on the client side.
By default, the target of the effect is the same element that effect pointed to. However,
the target element
is might be overridden with
<emphasis><property>"effectId"</property></emphasis>
option passed with
<emphasis><property>"params"</property></emphasis>
attribute of with function paramenter.
Modified: trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2008-07-15
12:35:17 UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2008-07-15
12:51:09 UTC (rev 9606)
@@ -81,7 +81,7 @@
<property>"hideWhenScrolling"</property>
</emphasis>. If attribute value is "true" data is hidden
during scrolling. </para>
- <para> It's possible to select the whole row with onclick on the row or
some set of rows.
+ <para> It's possible to select the whole row with onclick on the row
or some set of rows.
Selection is optional and availability of such feature is defined on the component.
There are
two ways to select a few rows: <itemizedlist>
<listitem><para>Just clicking the columns one by
one.</para></listitem>
@@ -94,7 +94,7 @@
the next JS API: <itemizedlist>
<listitem><para><code>collapse(columnId)</code> -
Performs the collapse action for the column with the
corresponding id</para></listitem>
- </itemizedlist> It's possible to sort the table content after clicks on
the header. The
+ </itemizedlist> It's possible to sort the table content after clicks
on the header. The
feature is optional. Every column should be pointed to the comparator method that
is used
for sorting the table. In case the
<emphasis
role="bold"><property><rich:scrollableDataTable></property></emphasis>
is already sorted by some column
@@ -132,7 +132,7 @@
<code>org.richfaces.model.selection.Selection</code> interface,
containing current
collection of objects selected by you.</para>
<para>In the following example when you submit the form, current collection of
the selected objects
- is placed in the object's property. Then on complete action the <emphasis
role="bold">
+ is placed in the object's property. Then on complete action the
<emphasis role="bold">
<property><rich:modalPanel></property>
</emphasis> with selected data is shown.</para>
<para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -74,7 +74,7 @@
<para>
To specify text information, labeled on a <emphasis
role="bold"><property><rich:toolTip></property></emphasis>,
use
<emphasis><property>"value"</property></emphasis>
attribute.
Images, links, buttons and other RichFaces components also may be put and
composed inside <emphasis
role="bold"><property><rich:toolTip></property></emphasis>.
- Text, specified between <property>tooltip's</property> start
and end tags will be rendered in browser as simple text.
+ Text, specified between <property>tooltip's</property>
start and end tags will be rendered in browser as simple text.
<emphasis
role="bold"><property><rich:toolTip></property></emphasis>
borders stretch to enclose it contents.
</para>
<para>
@@ -85,7 +85,7 @@
<note>
<title>Note:</title>
<para>
- It is recommended to specify
<emphasis><property>"id"</property></emphasis>
for parent page element to ensure <property>tooltip's</property> correct
work.
+ It is recommended to specify
<emphasis><property>"id"</property></emphasis>
for parent page element to ensure <property>tooltip's</property>
correct work.
</para>
</note>
<note>
@@ -131,7 +131,7 @@
<emphasis
role="bold"><property><rich:toolTip></property></emphasis>
may also be invoked by JS API function.
List of JS API functions available for <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
is listed <link linkend="tab_jsapi">below</link>.
JS API functions are defined for a page element, the <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
is applied to. Thus, <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
can be defined separately from that page element.
- It is necessary to specify
<emphasis><property>"ids"</property></emphasis>
for both and set <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
<emphasis><property>"attached"</property></emphasis>
attribute's value to "false" (see the example below).
+ It is necessary to specify
<emphasis><property>"ids"</property></emphasis>
for both and set <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
<emphasis><property>"attached"</property></emphasis>
attribute's value to "false" (see the example below).
</para>
<programlisting role="XML"><![CDATA[...
<rich:panel id="paneld"
onclick="#{rich:component("tooltipId")}.show();">
@@ -205,7 +205,7 @@
<para>
By default, <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
appears smart positioned. But as you can see from the previous example, you
can define an appearance direction via the corresponding attribute
<emphasis><property>"direction"</property></emphasis>.
- And also it's possible to define vertical and horizontal offsets relatively to a
mouse position.
+ And also it's possible to define vertical and horizontal offsets relatively
to a mouse position.
</para>
<para>
Disabled <emphasis
role="bold"><property><rich:toolTip></property></emphasis>
is rendered to a page as usual but JS that responds for its activation is disabled until
<code>enable()</code> is called.
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCSettings.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -114,7 +114,7 @@
RichFaces installs its ViewHandler in any case, so in case
of two frameworks, for example RichFaces + Facelets, no
changes in settings are required. Although, when more then
- one framework (except RichFaces) is used, it's possible to
+ one framework (except RichFaces) is used, it's possible to
use the
<code>VIEW_HANDLERS</code>
parameter defining these frameworks view handlers according
@@ -320,7 +320,7 @@
<para>
<property>JBoss Portlets</property>
have support since version Ajax4jsf 1.1.1. This support is
- improved in Richfaces 3.2.1. Provide your feedback on
+ improved in RichFaces 3.2.1. Provide your feedback on
compatible with RichFaces if you face some problems.
</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml 2008-07-15 12:35:17 UTC
(rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml 2008-07-15 12:51:09 UTC
(rev 9606)
@@ -920,9 +920,9 @@
<section id="DisableSkins">
<?dbhtml filename="DisableSkins.html"?>
- <title>How to disable skinability?</title>
+ <title>How to disable skinnability?</title>
<para>There is possibility to use special skin with name
"plain". It doesn't have
- any parameters. It's necessary for embedding RichFaces
components into
+ any parameters. It's necessary for embedding RichFaces
components into
existing projecst which have its own styles.</para>
<para>For information you can see discussion about this problem on
the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&...
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCtechreqs.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCtechreqs.xml 2008-07-15 12:35:17
UTC (rev 9605)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCtechreqs.xml 2008-07-15 12:51:09
UTC (rev 9606)
@@ -62,7 +62,7 @@
<listitem><para>Browser (on client side)</para></listitem>
- <listitem><para>Richfaces framework</para></listitem>
+ <listitem><para>RichFaces framework</para></listitem>
</itemizedlist>
<section id="SupportedJavaVersions">