[richfaces-svn-commits] JBoss Rich Faces SVN: r2654 - trunk/docs/userguide/en/src/main/docbook/included.

Author: smukhina Date: 2007-08-31 09:40:47 -0400 (Fri, 31 Aug 2007) New Revision: 2654 Modified: trunk/docs/userguide/en/src/main/docbook/included/effect.xml trunk/docs/userguide/en/src/main/docbook/included/messages.desc.xml trunk/docs/userguide/en/src/main/docbook/included/messages.xml trunk/docs/userguide/en/src/main/docbook/included/push.xml Log: http://jira.jboss.com/jira/browse/RF-398 some spelling mistakes are corrected Modified: trunk/docs/userguide/en/src/main/docbook/included/effect.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-08-31 12:58:25 UTC (rev 2653) +++ trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-08-31 13:40:47 UTC (rev 2654) @@ -130,14 +130,13 @@ </figure> <para> -<emphasis><property>&quot;name&quot;</property></emphasis> attribute defines a name of the JavaScript function will -be generated on the page when the component is rendered. You can invoke this function to activate the effect. The function accesses one parameter. +<emphasis><property>&quot;name&quot;</property></emphasis> attribute defines a name of the JavaScript function that is +be generated on a page when the component is rendered. You can invoke this function to activate the effect. The function accesses one parameter. It is a set of effect options in JSON format. </para> <para> -<emphasis><property>&quot;type&quot;</property></emphasis> attribute defines the type of an effect. For example, "Fade", "Blind", "Opacity". Have a look at <ulink url="http://script.aculo.us">scriptaculous documentation</ulink> -for set of available effect. +<emphasis><property>&quot;type&quot;</property></emphasis> attribute defines the type of an effect. For example, "Fade", "Blind", "Opacity". Have a look at <ulink url="http://script.aculo.us">scriptaculous documentation</ulink> for set of available effect. </para> <para> Modified: trunk/docs/userguide/en/src/main/docbook/included/messages.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/messages.desc.xml 2007-08-31 12:58:25 UTC (rev 2653) +++ trunk/docs/userguide/en/src/main/docbook/included/messages.desc.xml 2007-08-31 13:40:47 UTC (rev 2654) @@ -25,10 +25,10 @@ <title>Key Features</title> <itemizedlist> <listitem>Highly customizable look and feel</listitem> - <listitem>Track both traditional and ajax based requests</listitem> - <listitem>Optional tooltip to display the detail portion of the messages</listitem> + <listitem>Track both traditional and Ajax based requests</listitem> + <listitem>Optional tooltip to display a detailed part of the messages</listitem> <listitem>Additionally customizable via attributes and facets</listitem> - <listitem>Additionally provides of three parts to be optionally defined: marker, label and header</listitem> + <listitem>Additionally provides of three parts to be optionally defined: marker, label and header</listitem> </itemizedlist> </section> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/messages.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/messages.xml 2007-08-31 12:58:25 UTC (rev 2653) +++ trunk/docs/userguide/en/src/main/docbook/included/messages.xml 2007-08-31 13:40:47 UTC (rev 2654) @@ -78,23 +78,23 @@ request automatically without outputPanel usage.</listitem> <listitem>The component optionally provides &quot;passed&quot; state which will be shown if no message to be displayed.</listitem> - <listitem>Provides possibility to add some marker to message. By default marker element + <listitem>Provides possibility to add some marker to message. By default, a marker element isn&apos;t shown.</listitem> </itemizedlist> </para> - <para>Component provides three parts to be optionally defined: marker, informational label - before the marker for the every message and header element placed before the messages list. + <para>The component provides three parts to be optionally defined: marker, informational label + before the marker for every message and header element placed before the messages list. Header and marker are optional. They don&apos;t present by default for compatibility with standard messages. Labels are displayed for errors and one passed label is displayed optionally (if it&apos;s defined) when no errors occured.</para> - <para> Set of facet which can be used for marker defining: <itemizedlist> + <para> Set of facet which can be used for a marker defining: <itemizedlist> <listitem>header. This facet defines additional content to be displayed near the list. Header is positioned on top of the messages component.</listitem> - <listitem>passedHeader. This facet is provided to allow end developer set a header content to be displayed if there are no messages.</listitem> - <listitem>passedMarker. This facet is provided to allow set a marker to be displayed if there is no message.</listitem> - <listitem>errorMarker. This facet is provided to allow set a marker to be displayed if there is a message with a severity class of &quot;ERROR&quot;.</listitem> - <listitem>fatalMarker. This facet is provided to allow set a marker to be displayed if there is a message with a severity class of &quot;FATAL&quot;.</listitem> - <listitem>infoMarker. This facet is provided to allow set a marker to be displayed if there is a message with a severity class of &quot;INFO&quot;.</listitem> - <listitem>warnMarker. This facet is provided to allow set a marker to be displayed if there is an message with a severity class of &quot;WARN&quot;.</listitem> + <listitem>passedHeader. This facet is provided to allow an end developer setting a header content to be displayed if there are no messages.</listitem> + <listitem>passedMarker. This facet is provided to allow setting a marker to be displayed if there is no message.</listitem> + <listitem>errorMarker. This facet is provided to allow setting a marker to be displayed if there is a message with a severity class of &quot;ERROR&quot;.</listitem> + <listitem>fatalMarker. This facet is provided to allow setting a marker to be displayed if there is a message with a severity class of &quot;FATAL&quot;.</listitem> + <listitem>infoMarker. This facet is provided to allow setting a marker to be displayed if there is a message with a severity class of &quot;INFO&quot;.</listitem> + <listitem>warnMarker. This facet is provided to allow setting a marker to be displayed if there is an message with a severity class of &quot;WARN&quot;.</listitem> </itemizedlist> </para> @@ -135,7 +135,7 @@ <para>To redefine appearance of all <emphasis role="bold"> <property>&lt;rich:messages&gt;</property> </emphasis> components, you may define the properties of the predefined style classes in the - common CSS style sheet used on the page (there are no skin parameters and predefined values by + common CSS style sheet used on a page (there are no skin parameters and predefined values by default to make it compatible with the standard message component). </para> </section> @@ -206,7 +206,7 @@ </emphasis> components on a page using CSS, it&apos;s enough to create classes with the same names and define the necessary properties in them.</para> - <para>To change the style of particular <emphasis role="bold"> + <para>To change the style of a particular <emphasis role="bold"> <property>&lt;rich:messages&gt;</property> </emphasis> components define your own style classes in the corresponding <emphasis role="bold"> <property>&lt;rich:messages&gt;</property> Modified: trunk/docs/userguide/en/src/main/docbook/included/push.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-08-31 12:58:25 UTC (rev 2653) +++ trunk/docs/userguide/en/src/main/docbook/included/push.xml 2007-08-31 13:40:47 UTC (rev 2654) @@ -58,7 +58,7 @@ </para> <para> 'interval' - Interval (in ms) for call push requests. Default value 1000 (1 sec). -<!-- If "0" a connection is permanent. Also user can set different value for parameter 'timeout'. --> +<!-- If "0" a connection is permanent. Also you can set different value for parameter 'timeout'. --> </para> <para> Code for registration of listener: