9:25 a.m.
Author: smukhina
Date: 2007-10-17 10:25:50 -0400 (Wed, 17 Oct 2007)
New Revision: 3427
Modified:
trunk/docs/userguide/en/src/main/docbook/included/jQuery.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml
Log:
http://jira.jboss.com/jira/browse/RF-398
language correction
Modified: trunk/docs/userguide/en/src/main/docbook/included/jQuery.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jQuery.desc.xml 2007-10-17 14:12:18
UTC (rev 3426)
+++ trunk/docs/userguide/en/src/main/docbook/included/jQuery.desc.xml 2007-10-17 14:25:50
UTC (rev 3427)
@@ -9,7 +9,7 @@
<title>Description</title>
<para>The <emphasis role="bold">
<property><rich:jQuery></property>
- </emphasis> allows to apply styles and behaviour to DOM
object.</para>
+ </emphasis> allows to apply styles and behaviour to DOM
objects.</para>
<!--mediaobject>
<imageobject>
@@ -21,7 +21,7 @@
<title>Key Features</title>
<itemizedlist>
<listitem>Presents jQuery JavaScript framework
functionality</listitem>
- <listitem>Allows to apply on to JSF components and other DOM
objects.</listitem>
+ <listitem>Allows to apply onto JSF components and other DOM
objects.</listitem>
<listitem>Works without conflicts with prototype.js
library</listitem>
</itemizedlist>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml 2007-10-17 14:12:18 UTC
(rev 3426)
+++ trunk/docs/userguide/en/src/main/docbook/included/jQuery.xml 2007-10-17 14:25:50 UTC
(rev 3427)
@@ -55,7 +55,7 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>To create the simplest variant on a page use the following
syntax:</para>
+ <para>To create the simplest variant on a page, use the following
syntax:</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -82,22 +82,22 @@
<title>Details of Usage</title>
<para><emphasis role="bold">
<property><rich:jQuery></property>
- </emphasis> can be used in two major modes:</para>
+ </emphasis> can be used in two main modes:</para>
<itemizedlist>
- <listitem>as a one-time query applied immediately or on document ready
event</listitem>
+ <listitem>as a one-time query applied immediately or on a document ready
event</listitem>
<listitem>as a JavaScript function that can be invoked from the JavaScript
code</listitem>
</itemizedlist>
<para>The mode is chosen with <emphasis>
<property>"timing"</property>
- </emphasis> attribute that has following options:</para>
+ </emphasis> attribute that has the following options:</para>
<itemizedlist>
- <listitem>immediate - execution a query immediately</listitem>
- <listitem>onload - execution a query when a document is
loaded</listitem>
- <listitem>onJScall - execution a query by invoked JavaScript function defined
with the <emphasis>
+ <listitem>immediate - applying a query immediately</listitem>
+ <listitem>onload - applying a query when a document is
loaded</listitem>
+ <listitem>onJScall - applying a query by invoked JavaScript function defined
with the <emphasis>
<property>"name"</property>
</emphasis> attribute</listitem>
</itemizedlist>
- <para>Definition the <emphasis>
+ <para>Definition of the <emphasis>
<property>"name"</property>
</emphasis> attribute is mandatory when the value of <emphasis>
<property>"timing"</property>
@@ -107,13 +107,13 @@
<property>"timing"</property>
</emphasis> value equals to
<property>"immediate"</property> or
<property>"onload"</property>, the query is applied
according to this
- value, but you still have an opportunity to invoke it by function
name.</para>
+ value, but you still have an opportunity to invoke it by a function
name.</para>
<para>The <emphasis>
<property>"selector"</property>
- </emphasis> attribute define an object or a list of objects. The query is
defined with the <emphasis>
+ </emphasis> attribute defines an object or a list of objects. The query is
defined with the <emphasis>
<property>"query"</property>
</emphasis>attribute.</para>
- <para>There is an example how to highlight odd rows in a table:</para>
+ <para>Here is an example of how to highlight odd rows in a table:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -156,90 +156,90 @@
<row>
<entry>"p[a]"</entry>
- <entry>In a document find all "p" tags with
"a" tag
- inside</entry>
+ <entry>In a document all "p" tags with
"a" tag
+ inside are selected</entry>
</row>
<row>
<entry>"ul/li"</entry>
- <entry>All "li" elements of unordered
"ul" lists
+ <entry>All "li" elements of unordered
"ul" lists are selected
</entry>
</row>
<row>
<entry>"p.foo[a]"</entry>
<entry>All "p" tags with "foo"
class and inserted
- "a" tag </entry>
+ "a" tag are selected</entry>
</row>
<row>
<entry>"input[@name=bar]"</entry>
<entry>All "input" tags with "name"
attribute which
- value is "bar"</entry>
+ value is "bar" are selected</entry>
</row>
<row>
<entry>"input[@type=radio][@checked]"</entry>
- <entry>Find all "input" tags with attribute
+ <entry>All "input" tags with attribute
"type"="radio" and attribute value =
- "chekced"</entry>
+ "chekced" are selected</entry>
</row>
<row>
<entry>"p,span,td"</entry>
<entry>All tag elements "p"
or"span" or
- "td" </entry>
+ "td" are selected</entry>
</row>
<row>
<entry>"p#secret"</entry>
<entry>"p" paragraph element with
"id"
- identification = "secret" </entry>
+ identification = "secret" is selected</entry>
</row>
<row>
<entry>"p span"</entry>
<entry>"span" tag is a (direct or non-direct) child
of
"p" tag. If it's necessary, use "p
>
- span" or "p/span" </entry>
+ span" or "p/span" is selected</entry>
</row>
<row>
<entry>"p[@foo^=bar]"</entry>
<entry>"p" tag containing "foo"
attribute with
- textual value beginning with "bar" word </entry>
+ textual value beginning with "bar" word is
selected</entry>
</row>
<row>
<entry>"p[@foo$=bar] "</entry>
<entry>"p" tag containing "foo"
attribute with
- textual value ending with "bar" word</entry>
+ textual value ending with "bar" word is
selected</entry>
</row>
<row>
<entry>"p[@foo*=bar] "</entry>
<entry>"p" tag with "foo" attribute
containing
- substring "bar" in any place</entry>
+ substring "bar" in any place is selected</entry>
</row>
<row>
<entry>"p//span "</entry>
- <entry>"span" tag is a (direct or non-direct) child
of
- "p" tag </entry>
+ <entry>"span" tag that is a (direct or non-direct)
child of
+ "p" tag is selected</entry>
</row>
<row>
<entry>"p/../span "</entry>
- <entry>"span" tag is a grandchild of
"p" tag</entry>
+ <entry>"span" tag that is a grandchild of
"p" tag is selected</entry>
</row>
</tbody>
</tgroup>
</table>
- <para>In addition, RichFaces allows using either component id or client id if
you apply the
- query to the JSF component. When you define a selector, RichFaces examines its
content and
- tries to replace the defined in the selector id with component id if
found.</para>
+ <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 component id if it's
found.</para>
<para>For example, you have the following code:</para>
<programlisting role="XML"><![CDATA[...
@@ -263,13 +263,13 @@
...]]></programlisting>
<para>You can define the exact id in the selector if you want. The following
code reference to
- the same set of DOM object:</para>
+ the same set of a DOM object:</para>
<programlisting role="XML"><![CDATA[...
<rich:jQuery selector="#form\\:menu img" query="..." />
...]]></programlisting>
- <para>Pay attention to the double slashes that escapes the colon in the
id.</para>
+ <para>Pay attention to double slashes that escape a colon in the
id.</para>
<para>In case when the <emphasis>
<property>"name"</property>
@@ -278,7 +278,7 @@
</emphasis> generates a JavaScript function that might be used from any place
of JavaScript
code on a page.</para>
- <para>There is an example how to enlarge the picture smoothly on mouse over
event and return
+ <para>There is an example of how to enlarge the picture smoothly on mouse over
event and return
back to the normal size on mouse out:</para>
<programlisting role="XML"><![CDATA[...
@@ -292,24 +292,24 @@
...]]></programlisting>
<para>The JavaScript could use two parameters. The first parameter is a
replacement for the
- selector attribute. Thus, you can share the same query execution it to the
different DOM
- objects. You can use the literal value or the direct reference to the existing DOM
object. The
+ selector attribute. Thus, you can share the same query, applying it to the
different DOM
+ objects. You can use a literal value or a direct reference for an existing DOM
object. The
second parameter can be used to path the specific value inside the query. The JSON
syntax is
used for the second parameter. The "param." namespace is used
for
- referencing to data inside the parameter value.</para>
+ referencing data inside the parameter value.</para>
<para><emphasis role="bold">
<property><rich:jQuery></property>
</emphasis> adds styles and behavior to the DOM object dynamically. This
means if you replace
something on a page during an Ajax response, the applied artifacts will be
overwritten. You
are resistible to apply them again after the Ajax response is
complete.</para>
- <para>Normally, it could be done with reRendering the <emphasis
role="bold">
+ <para>Usually, it could be done with reRendering the <emphasis
role="bold">
<property><rich:jQuery></property>
- </emphasis> components in the same Ajax interaction with the components those
queries are
+ </emphasis> components in the same Ajax interaction with the components these
queries are
applied to. Note, that queries with <emphasis>
<property>"timing"</property>
- </emphasis> attribute set to
<property>"onload"</property> will not be
- invoked even the query is reRendered because, the DOM document is not fully
reloaded during
+ </emphasis> attribute set to
<property>"onload"</property> are not
+ invoked even the query is reRendered, because a DOM document is not fully reloaded
during
the Ajax interaction. If you need to re-applies query with
<property>"onload"</property> value of
<emphasis>
<property>"timing"</property>