From richfaces-svn-commits at lists.jboss.org Tue Nov 22 18:37:10 2011
Content-Type: multipart/mixed; boundary="===============4899417840249060576=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r22976 -
 modules/docs/trunk/Component_Reference/src/main/docbook/en-US.
Date: Tue, 22 Nov 2011 18:37:09 -0500
Message-ID: <201111222337.pAMNb90f024962@svn01.web.mwc.hst.phx2.redhat.com>

--===============4899417840249060576==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: bleathem
Date: 2011-11-22 18:37:09 -0500 (Tue, 22 Nov 2011)
New Revision: 22976

Modified:
   modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo=
nent_Reference-Output_and_messages.xml
Log:
Grammar cleanup of the notify component documentation

Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha=
p-Component_Reference-Output_and_messages.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Output_and_messages.xml	2011-11-22 23:04:07 UTC (rev 22975)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp=
onent_Reference-Output_and_messages.xml	2011-11-22 23:37:09 UTC (rev 22976)
@@ -242,37 +242,29 @@
     <section id=3D"sect-Component_Reference-Output_and_messages-richnotify=
">
         <title><sgmltag>&lt;rich:notify&gt;</sgmltag></title>
         <para>
-            The <sgmltag>&lt;rich:notify&gt;</sgmltag> component serves fo=
r advanced user interaction, giving user instant feedback on what's happeni=
ng in application in form of notifications.
+            The <sgmltag>&lt;rich:notify&gt;</sgmltag> component serves fo=
r advanced user interaction, using notification boxes to give the user inst=
ant feedback on what's happening within the application.
+            Each time this component is rendered, a floating notification =
box is displayed in the selected corner of the browser screen.
         </para>
-        <para>
-            Each time this component is rendered, floating notification bo=
x is displayed in the selected corner of the browser screen.
-        </para>
         =

         <section id=3D"sect-Component_Reference-richnotify-Basic_usage">
             <title>Basic usage</title>
             <para>
-                The <sgmltag>&lt;rich:notify&gt;</sgmltag> has two message=
 customization attributes: <parameter>summary</parameter> is short text sum=
marizing the message, while <parameter>detail</parameter> configures detail=
ed body of the message.
+                The <sgmltag>&lt;rich:notify&gt;</sgmltag> has two message=
 customization attributes: <parameter>summary</parameter> is short text sum=
marizing the message, while <parameter>detail</parameter> configures the de=
tailed body of the message.
+                Both attributes have their counterparts in form of facets =
with the same names as the corresponding attributes.
             </para>
-            <para>
-                Both attributes have their counterparts in form of facets =
with same names as attributes.
-            </para>
         </section>
 =

         <section id=3D"sect-Component_Reference-richnotify-Customizing_not=
ifications">
             <title>Customizing notifications</title>
             <para>
-                Notification appears on the page each them they are render=
ed, on full-page or ajax requests.
+                A notification appears on the page each time it is rendere=
d, either on full-page or ajax requests.
+                The notification remains on the screen for 8 seconds and t=
hen disappears.
+                Users can close the notification with the close button in =
the top-right corner of the notification.
             </para>
             <para>
-                Notifications are waiting on the screen for 8 seconds and =
then they disappear.
+                Notification stacks can be used to create sequences. For c=
ustomization of stacking see the <sgmltag>&lt;rich:notifyStack&gt;</sgmltag=
> component.
             </para>
             <para>
-                Notification stacks and creates sequences. For customiziti=
on of stacking see <sgmltag>&lt;rich:notifyStack&gt;</sgmltag> component.
-            </para>
-            <para>
-                User can close notification with close button in the top-r=
ight corner of each notification.
-            </para>
-            <para>
                 There are several attributes that can change default behav=
ior:
             </para>
              <itemizedlist>
@@ -308,7 +300,7 @@
                 </listitem>
             </itemizedlist>
             <note>
-                Nonblocking notifications can be clicked through, but beca=
use they are using jQuery mechanism to bypass events, only jQuery event han=
dlers are triggered. It specifically means that standard links won't be tri=
ggered.
+                Nonblocking notifications can be clicked through, but beca=
use they are using jQuery mechanism to bypass events, only jQuery event han=
dlers are triggered. IThis means that standard links won't be triggered.
             </note>
         </section>
         =

@@ -354,16 +346,12 @@
             <title>Basic usage</title>
             <para>
                 The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> componen=
t is built on top of <sgmltag>&lt;rich:notify&gt;</sgmltag>, the difference=
 is in usage.
+                The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> componen=
t displays <code>FacesMessage</code>s associated with a given component, si=
milar to <sgmltag>&lt;rich:message&gt;</sgmltag>: one notification is displ=
ayed for first <code>FacesMessage</code> in the stack that is risen either =
programatically or during conversion/validation of the component.
+                The severity of the message determines the color and icon =
of the resulting notification.
             </para>
             <para>
-                Component displays <code>FacesMessage</code>s associated w=
ith given component, similarry to <sgmltag>&lt;rich:message&gt;</sgmltag>: =
one notification is displayed for first <code>FacesMessage</code> in stack,=
 raisen either programatically or during component conversion or validation.
+                For customization of notification behavior, please refer t=
o <link linkend=3D"sect-Component_Reference-richnotify-Customizing_notifica=
tions">Customizing notifications</link> of <sgmltag>&lt;rich:notify&gt;</sg=
mltag>.
             </para>
-            <para>
-                Severify of message which triggers notification determines=
 color and icon of notification.
-            </para>
-            <para>
-                For customization of notifications behavior refer to <link=
 linkend=3D"sect-Component_Reference-richnotify-Customizing_notifications">=
Customizing notifications</link> of <sgmltag>&lt;rich:notify&gt;</sgmltag>.
-            </para>
         </section>
         =

         <section id=3D"sect-Component_Reference-richnotifyMessage-Referenc=
e_data">
@@ -395,10 +383,10 @@
         <section id=3D"sect-Component_Reference-richnotifyMessage-Style_cl=
asses_and_skin_parameters">
             <title>Style classes and skin parameters</title>
             <para>
-                Note that <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> sh=
ares common classes with <sgmltag>&lt;rich:notify&gt;</sgmltag>, since for =
each JSF message, exactly one notification is rendered. =

+                Note that <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> sh=
ares common classes with <sgmltag>&lt;rich:notify&gt;</sgmltag>, since ther=
e is exactly one notification rendered for each JSF message.
             </para>
             <para>
-                The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> specific=
 classes are redefining look for various message severity levels. =

+                The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> specific=
 classes are redefining the look for various message severity levels.
             </para>
             <xi:include href=3D"skinning/tabl-richnotifyMessage.xml" xmlns=
:xi=3D"http://www.w3.org/2001/XInclude" />
         </section>
@@ -407,7 +395,7 @@
     <section id=3D"sect-Component_Reference-Output_and_messages-richnotify=
Messages">
         <title><sgmltag>&lt;rich:notifyMessages&gt;</sgmltag></title>
         <para>
-            The <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> component i=
s same as <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag>, but each of availa=
ble messages generates one notification. =

+            The <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> component i=
s the same as the <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> component, =
but each of the available messages generates one notification.
         </para>
         <para>
             <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> shares the same=
 set of attributes with <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> =

@@ -474,31 +462,31 @@
         <section id=3D"sect-Component_Reference-richnotifyStack-Basic_usag=
e">
             <title>Basic usage</title>
             <para>
-                They are three alternative ways how to bind notification w=
ith stack:
+                They are three alternative ways to bind notifications with=
 a stack:
             </para>
             <itemizedlist>
                 <listitem>
                     <para>
-                        <emphasis>wrapping</emphasis>: nesting <sgmltag>&l=
t;rich:notify&gt;</sgmltag>, <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> =
or <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> bounds notifications with=
 stack which is wrapping them
+                        <emphasis>wrapping</emphasis>: nesting <sgmltag>&l=
t;rich:notify&gt;</sgmltag>, <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> =
or <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> binds notifications with =
the stack in which they are wrapped
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <emphasis>binding by id</emphasis>: notification c=
an be bound directly to stack using it's <code>componentId</code> in attrib=
ute <parameter>stack</parameter>
+                        <emphasis>binding by id</emphasis>: notification c=
an be bound directly to a stack using it's <code>componentId</code> in the =
<parameter>stack</parameter> attribute
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <emphasis>using default stack</emphasis>: default =
stack is used when no other binding is defined for given notification
+                        <emphasis>using default stack</emphasis>: a defaul=
t stack is used when no other binding is defined for a given notification
                     </para>
                 </listitem>
             </itemizedlist>
             <programlisting language=3D"XML" role=3D"XML"><xi:include pars=
e=3D"text" href=3D"extras/exam-Component_Reference-richnotifyStack-Basic_us=
age.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></programlis=
ting>
             <para>
-                The sample above defines stack explicitly, where notificat=
ions uses stack in that they are wrapped.
+                The sample above defines the stack explicitly, where notif=
ications use the stack in which they are wrapped.
             </para>
             <para>
-                The sample bellow uses notification, which is rendered int=
o top-left screen corner. Notification is bound to stack using its id.
+                The sample bellow uses a notification rendered into the to=
p-left corner of the screen. The notification is bound to a stack using it'=
s id.
             </para>
             <programlisting language=3D"XML" role=3D"XML"><xi:include pars=
e=3D"text" href=3D"extras/exam-Component_Reference-richnotifyStack-Binding_=
by_stack_id.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></pr=
ogramlisting>
         </section>
@@ -506,17 +494,17 @@
         <section id=3D"sect-Component_Reference-richnotifyStack-Positionin=
g_notifications">
             <title>Positioning notifications</title>
             <para>
-                To redefine positioning of notification, one needs to defi=
ne stack and bind it with given notification. =

+                To redefine the position of a notification, one needs to d=
efine a stack and bind it with the given notification.
             </para>
             <para>
-                <sgmltag>&lt;rich:notifyStack&gt;</sgmltag> uses <paramete=
r>position</parameter> attribute which places stack and its notifications i=
nto one of four corners: <code>topRight</code> (default), <code>bottomRight=
</code>, <code>bottomLeft</code>, <code>topLeft</code>.
+                <sgmltag>&lt;rich:notifyStack&gt;</sgmltag> uses the <para=
meter>position</parameter> attribute to place the stack and it's notificati=
ons into one of four corners: <code>topRight</code> (default), <code>bottom=
Right</code>, <code>bottomLeft</code>, <code>topLeft</code>.
             </para>
         </section>
         =

         <section id=3D"sect-Component_Reference-richnotifyStack-Stacking_n=
otifications">
             <title>Stacking notifications</title>
             <para>
-                There are two attributes which influences how notification=
s are placed into stack: =

+                There are two attributes which influences how notification=
s are placed into a stack:
             </para>
             <itemizedlist>
                 <listitem>
@@ -529,11 +517,11 @@
                 </listitem>
             </itemizedlist>
             <para>
-                Following sample shows stack which will place new notifica=
tion as first - incoming message will appear first, causing all notificatio=
ns currently in stack to shift. Adequately, messages on the end of stack wi=
ll be then removed from stack as first.
+                The following sample shows a stack which will place new no=
tifications up front - the incoming message will appear first, causing all =
notifications currently in stack to shift. Subsequently, messages at the en=
d of stack will be then removed.
             </para>
             <programlisting language=3D"XML" role=3D"XML"><xi:include pars=
e=3D"text" href=3D"extras/exam-Component_Reference-richnotifyStack-Stacking=
_method_first.xml_sample" xmlns:xi=3D"http://www.w3.org/2001/XInclude" /></=
programlisting>
             <para>
-                On the other hand, stacking method <code>last</code> does =
provide method to place messages on the end of stack, and when removing not=
ification, it is removed from start, causing all other notifications to shi=
ft.
+                On the other hand, stacking method <code>last</code> provi=
des a method to place messages on the end of the stack, and when removing a=
 notification, it is removed from the start, causing all other notification=
s to shift.
             </para>
         </section>
         =



--===============4899417840249060576==--