5:37 p.m.
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-Component_Reference-Output_and_messages.xml
Log:
Grammar cleanup of the notify component documentation
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_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-Component_Reference-Output_and_messages.xml 2011-11-22
23:37:09 UTC (rev 22976)
@@ -242,37 +242,29 @@
<section
id="sect-Component_Reference-Output_and_messages-richnotify">
<title><sgmltag><rich:notify></sgmltag></title>
<para>
- The <sgmltag><rich:notify></sgmltag> component
serves for advanced user interaction, giving user instant feedback on what's happening
in application in form of notifications.
+ The <sgmltag><rich:notify></sgmltag> component
serves for advanced user interaction, using notification boxes to give the user instant
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 box is displayed
in the selected corner of the browser screen.
- </para>
<section id="sect-Component_Reference-richnotify-Basic_usage">
<title>Basic usage</title>
<para>
- The <sgmltag><rich:notify></sgmltag> has two
message customization attributes: <parameter>summary</parameter> is short text
summarizing the message, while <parameter>detail</parameter> configures
detailed body of the message.
+ The <sgmltag><rich:notify></sgmltag> has two
message customization attributes: <parameter>summary</parameter> is short text
summarizing the message, while <parameter>detail</parameter> configures the
detailed 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="sect-Component_Reference-richnotify-Customizing_notifications">
<title>Customizing notifications</title>
<para>
- Notification appears on the page each them they are rendered, on
full-page or ajax requests.
+ A notification appears on the page each time it is rendered, either on
full-page or ajax requests.
+ The notification remains on the screen for 8 seconds and then
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 customization of
stacking see the <sgmltag><rich:notifyStack></sgmltag>
component.
</para>
<para>
- Notification stacks and creates sequences. For customizition of stacking
see <sgmltag><rich:notifyStack></sgmltag> component.
- </para>
- <para>
- User can close notification with close button in the top-right corner of
each notification.
- </para>
- <para>
There are several attributes that can change default behavior:
</para>
<itemizedlist>
@@ -308,7 +300,7 @@
</listitem>
</itemizedlist>
<note>
- Nonblocking notifications can be clicked through, but because they are
using jQuery mechanism to bypass events, only jQuery event handlers are triggered. It
specifically means that standard links won't be triggered.
+ Nonblocking notifications can be clicked through, but because they are
using jQuery mechanism to bypass events, only jQuery event handlers are triggered. IThis
means that standard links won't be triggered.
</note>
</section>
@@ -354,16 +346,12 @@
<title>Basic usage</title>
<para>
The <sgmltag><rich:notifyMessage></sgmltag>
component is built on top of <sgmltag><rich:notify></sgmltag>,
the difference is in usage.
+ The <sgmltag><rich:notifyMessage></sgmltag>
component displays <code>FacesMessage</code>s associated with a given
component, similar to <sgmltag><rich:message></sgmltag>: one
notification is displayed 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 with
given component, similarry to <sgmltag><rich:message></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 to <link
linkend="sect-Component_Reference-richnotify-Customizing_notifications">Customizing
notifications</link> of <sgmltag><rich:notify></sgmltag>.
</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="sect-Component_Reference-richnotify-Customizing_notifications">Customizing
notifications</link> of <sgmltag><rich:notify></sgmltag>.
- </para>
</section>
<section
id="sect-Component_Reference-richnotifyMessage-Reference_data">
@@ -395,10 +383,10 @@
<section
id="sect-Component_Reference-richnotifyMessage-Style_classes_and_skin_parameters">
<title>Style classes and skin parameters</title>
<para>
- Note that
<sgmltag><rich:notifyMessage></sgmltag> shares common classes
with <sgmltag><rich:notify></sgmltag>, since for each JSF
message, exactly one notification is rendered.
+ Note that
<sgmltag><rich:notifyMessage></sgmltag> shares common classes
with <sgmltag><rich:notify></sgmltag>, since there is exactly
one notification rendered for each JSF message.
</para>
<para>
- The <sgmltag><rich:notifyMessage></sgmltag>
specific classes are redefining look for various message severity levels.
+ The <sgmltag><rich:notifyMessage></sgmltag>
specific classes are redefining the look for various message severity levels.
</para>
<xi:include href="skinning/tabl-richnotifyMessage.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
@@ -407,7 +395,7 @@
<section
id="sect-Component_Reference-Output_and_messages-richnotifyMessages">
<title><sgmltag><rich:notifyMessages></sgmltag></title>
<para>
- The <sgmltag><rich:notifyMessages></sgmltag>
component is same as <sgmltag><rich:notifyMessage></sgmltag>,
but each of available messages generates one notification.
+ The <sgmltag><rich:notifyMessages></sgmltag>
component is the same as the
<sgmltag><rich:notifyMessage></sgmltag> component, but each of
the available messages generates one notification.
</para>
<para>
<sgmltag><rich:notifyMessages></sgmltag> shares the
same set of attributes with
<sgmltag><rich:notifyMessage></sgmltag>
@@ -474,31 +462,31 @@
<section
id="sect-Component_Reference-richnotifyStack-Basic_usage">
<title>Basic usage</title>
<para>
- They are three alternative ways how to bind notification with stack:
+ They are three alternative ways to bind notifications with a stack:
</para>
<itemizedlist>
<listitem>
<para>
- <emphasis>wrapping</emphasis>: nesting
<sgmltag><rich:notify></sgmltag>,
<sgmltag><rich:notifyMessage></sgmltag> or
<sgmltag><rich:notifyMessages></sgmltag> bounds notifications
with stack which is wrapping them
+ <emphasis>wrapping</emphasis>: nesting
<sgmltag><rich:notify></sgmltag>,
<sgmltag><rich:notifyMessage></sgmltag> or
<sgmltag><rich:notifyMessages></sgmltag> binds notifications
with the stack in which they are wrapped
</para>
</listitem>
<listitem>
<para>
- <emphasis>binding by id</emphasis>: notification can
be bound directly to stack using it's <code>componentId</code> in
attribute <parameter>stack</parameter>
+ <emphasis>binding by id</emphasis>: notification can
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 default
stack is used when no other binding is defined for a given notification
</para>
</listitem>
</itemizedlist>
<programlisting language="XML"
role="XML"><xi:include parse="text"
href="extras/exam-Component_Reference-richnotifyStack-Basic_usage.xml_sample"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
<para>
- The sample above defines stack explicitly, where notifications uses stack
in that they are wrapped.
+ The sample above defines the stack explicitly, where notifications use
the stack in which they are wrapped.
</para>
<para>
- The sample bellow uses notification, which is rendered into top-left
screen corner. Notification is bound to stack using its id.
+ The sample bellow uses a notification rendered into the top-left corner
of the screen. The notification is bound to a stack using it's id.
</para>
<programlisting language="XML"
role="XML"><xi:include parse="text"
href="extras/exam-Component_Reference-richnotifyStack-Binding_by_stack_id.xml_sample"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
</section>
@@ -506,17 +494,17 @@
<section
id="sect-Component_Reference-richnotifyStack-Positioning_notifications">
<title>Positioning notifications</title>
<para>
- To redefine positioning of notification, one needs to define stack and
bind it with given notification.
+ To redefine the position of a notification, one needs to define a stack
and bind it with the given notification.
</para>
<para>
- <sgmltag><rich:notifyStack></sgmltag> uses
<parameter>position</parameter> attribute which places stack and its
notifications into one of four corners: <code>topRight</code> (default),
<code>bottomRight</code>, <code>bottomLeft</code>,
<code>topLeft</code>.
+ <sgmltag><rich:notifyStack></sgmltag> uses the
<parameter>position</parameter> attribute to place the stack and it's
notifications into one of four corners: <code>topRight</code> (default),
<code>bottomRight</code>, <code>bottomLeft</code>,
<code>topLeft</code>.
</para>
</section>
<section
id="sect-Component_Reference-richnotifyStack-Stacking_notifications">
<title>Stacking notifications</title>
<para>
- There are two attributes which influences how notifications are placed
into stack:
+ There are two attributes which influences how notifications are placed
into a stack:
</para>
<itemizedlist>
<listitem>
@@ -529,11 +517,11 @@
</listitem>
</itemizedlist>
<para>
- Following sample shows stack which will place new notification as first -
incoming message will appear first, causing all notifications currently in stack to shift.
Adequately, messages on the end of stack will be then removed from stack as first.
+ The following sample shows a stack which will place new notifications up
front - the incoming message will appear first, causing all notifications currently in
stack to shift. Subsequently, messages at the end of stack will be then removed.
</para>
<programlisting language="XML"
role="XML"><xi:include parse="text"
href="extras/exam-Component_Reference-richnotifyStack-Stacking_method_first.xml_sample"
xmlns:xi="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 notification, it
is removed from start, causing all other notifications to shift.
+ On the other hand, stacking method <code>last</code> provides
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 notifications to shift.
</para>
</section>