[richfaces-svn-commits] JBoss Rich Faces SVN: r690 - trunk/docs/userguide/en/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue May 8 05:19:56 EDT 2007
Author: smukhina
Date: 2007-05-08 05:19:56 -0400 (Tue, 08 May 2007)
New Revision: 690
Modified:
trunk/docs/userguide/en/included/dropDownMenu.desc.xml
trunk/docs/userguide/en/included/dropDownMenu.xml
trunk/docs/userguide/en/included/menuGroup.desc.xml
trunk/docs/userguide/en/included/menuGroup.xml
trunk/docs/userguide/en/included/menuItem.desc.xml
trunk/docs/userguide/en/included/menuItem.xml
trunk/docs/userguide/en/included/menuSeparator.desc.xml
Log:
Modified: trunk/docs/userguide/en/included/dropDownMenu.desc.xml
===================================================================
--- trunk/docs/userguide/en/included/dropDownMenu.desc.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/dropDownMenu.desc.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -6,7 +6,7 @@
</keywordset>
</sectioninfo>
- <para>The <rich:dropDownMenu> component is used for multilevel dropdown menu creation.</para>
+ <para>The <rich:dropDownMenu> component is used for a multilevel dropdown menu creation.</para>
<figure>
<title><rich:dropDownMenu> component</title>
<mediaobject>
Modified: trunk/docs/userguide/en/included/dropDownMenu.xml
===================================================================
--- trunk/docs/userguide/en/included/dropDownMenu.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/dropDownMenu.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -47,7 +47,7 @@
<![CDATA[
...
<rich:dropDownMenu value="Item1">
- <!—Nested menu components-->
+ <!--Nested menu components-->
</rich:dropDownMenu>
...
]]>
@@ -68,7 +68,7 @@
<section>
<title>Details of Usage</title>
<para>
- All attributes except the "value" are not required. The "value" attribute defines representation text.
+ All attributes except the "value" are not required. The "value" attribute defines a representation text.
</para>
<para>
Also instead of the "value" attribute you can use the "label" facet.
@@ -86,13 +86,13 @@
]]>
</programlisting>
<para>
- Use the "event" attribute to define the an event on the representation element that triggers the menu appearance. The example of menu appearance on a click could be seen below.
+ Use the "event" attribute to define an event on the representation element that triggers a menu appearance. An example of a menu appearance on a click could be seen below.
</para>
<programlisting role="xml">
<![CDATA[
...
<rich:dropDownMenu event="onclick" value="Item1">
- <!—Nested menu components-->
+ <!--Nested menu components-->
</rich:dropDownMenu>
...
]]>
@@ -104,22 +104,22 @@
<listitem><para>Server (on default)</para></listitem>
</itemizedlist>
<para>
- The common submission of the form is performed and a page is completely refreshed.
+ The common submission of a form is performed and a page is completely refreshed.
</para>
<itemizedlist>
<listitem><para>Ajax</para></listitem>
</itemizedlist>
<para>
- Ajax form submission is performed additionally specified elements in the "reRender" attribute are reRendered.
+ Ajax form submission is performed, additionally specified elements in the "reRender" attribute are reRendered.
</para>
<itemizedlist>
<listitem><para>None</para></listitem>
</itemizedlist>
<para>
- The"action" and "actionListener" item's attributes are ignored. Menu items don't fire any submits itself. Behavior is fully defined by the components nested to items.
+ The"action" and "actionListener" item's attributes are ignored. Menu items don't fire any submits itself. Behavior is fully defined by the components nested into items.
</para>
<note><title>Note:</title>
- As the <rich:dropDownMenu> component doesn't provide own form use it in <form>…</h:form>.
+ As the <rich:dropDownMenu> component doesn't provide its own form, use it in <form>-</h:form>.
</note>
<para>
The "direction" and "jointPoint" attributes are used for the definition ways of menu appearance as it's shown in the example below.
@@ -128,24 +128,24 @@
Possible values for the "direction" attribute are:
</para>
<itemizedlist>
- <listitem><para>top-left – menu attached to top-right corner of the label;</para></listitem>
- <listitem><para>top-right – menu attached to top-left corner of the label;</para></listitem>
- <listitem><para>bottom-left – menu attached to bottom-right corner of the label;</para></listitem>
- <listitem><para>bottom-right – menu attached to bottom-left corner of the label;</para></listitem>
- <listitem><para>auto – smart positioning activated.</para></listitem>
+ <listitem><para>top-left - a menu attached to the top-right corner of the label;</para></listitem>
+ <listitem><para>top-right - a menu attached to the top-left corner of the label;</para></listitem>
+ <listitem><para>bottom-left - a menu attached to the bottom-right corner of the label;</para></listitem>
+ <listitem><para>bottom-right - a menu attached to the bottom-left corner of the label;</para></listitem>
+ <listitem><para>auto - a smart positioning activation.</para></listitem>
</itemizedlist>
<para>
Possible values for the "jointPoint" attribute are:
</para>
<itemizedlist>
- <listitem><para>tr – top-right point of the label element;</para></listitem>
- <listitem><para>tl – top-left point of the label element;</para></listitem>
- <listitem><para>br – bottom-right point of the label element;</para></listitem>
- <listitem><para>bl – bottom-left point of the label element;</para></listitem>
- <listitem><para>auto – smart positioning activated.</para></listitem>
+ <listitem><para>tr - top-right point of the label element;</para></listitem>
+ <listitem><para>tl - top-left point of the label element;</para></listitem>
+ <listitem><para>br - bottom-right point of the label element;</para></listitem>
+ <listitem><para>bl - bottom-left point of the label element;</para></listitem>
+ <listitem><para>auto - smart positioning activation.</para></listitem>
</itemizedlist>
<para>
- On default the "direction" and "jointPoint" attributes define as "auto".
+ On default the "direction" and "jointPoint" attributes define as "auto".
</para>
<para>
Example.
@@ -171,7 +171,7 @@
</mediaobject>
</figure>
<para>
- You can correct an offset of the popup list relatively the label using following attributes: "horizontalOffset" and "verticalOffset".
+ You can correct an offset of the popup list relatively to the label using following attributes: "horizontalOffset" and "verticalOffset".
</para>
<para>
Example.
@@ -180,7 +180,7 @@
<![CDATA[
...
<rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0">
- <!—Nested menu components-->
+ <!-Nested menu components-->
</rich:dropDownMenu>
...
]]>
@@ -203,14 +203,14 @@
Skin parameters redefinition:
</para>
<para>
- For skinnability implementation the components uses style class redefinition method. Default style classes are mapped on skin parameters.
+ For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.
</para>
<para>
- To redefine appearance of all dropDownMenus at once there are two ways:
+ There are two ways to redefine appearance of all dropDownMenus at once :
</para>
<itemizedlist>
<listitem><para>Redefine corresponding skin parameters.</para></listitem>
- <listitem><para>Add to user's stylesheets style classes used by panel.</para></listitem>
+ <listitem><para>Add to user's stylesheets style classes used by a panel.</para></listitem>
</itemizedlist>
<table>
<title>Label Skin parameters redefinition</title>
@@ -308,7 +308,7 @@
<section>
<title> Definition custom style classes </title>
<para>
- On the screenshot, there are classes' names that define element label.
+ On the screenshot, there are classes' names that define an element label.
</para>
<figure>
<title>Classes' names</title>
@@ -330,25 +330,25 @@
<tbody>
<row>
<entry>Rich-label-text-decor</entry>
- <entry>Defines the text style of representation element</entry>
+ <entry>Defines the text style of a representation element</entry>
</row>
<row>
<entry>Rich-ddmenu-label</entry>
- <entry>Defines the class for wrapping div element at representation element</entry>
+ <entry>Defines the class for wrapping div element of a representation element</entry>
</row>
<row>
<entry>Rich-ddmenu-label-select</entry>
- <entry>Defines the class for wrapping div element at selected representation element</entry>
+ <entry>Defines the class for wrapping div element of the selected representation element</entry>
</row>
<row>
<entry>Rich-ddmenu-label-unselect</entry>
- <entry>Defines the class for wrapping div element at not selected representation element</entry>
+ <entry>Defines the class for wrapping div element of a representation element that isn't selected</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
- On the screenshot, there are classes' names that define element popup.
+ On the screenshot, there are classes' names that define an element popup.
</para>
<figure>
<title>Classes' names</title>
@@ -370,17 +370,17 @@
<tbody>
<row>
<entry>Rich-menu-list-border</entry>
- <entry>Defines the class for elements of borders</entry>
+ <entry>Defines a class for borders elements</entry>
</row>
<row>
<entry>Rich-menu-list-border</entry>
- <entry>Defines the class for general background list</entry>
+ <entry>Defines the class for a general background list</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
- In order to redefine style for all menus on the page with using CSS it's enough to create classes with the same names and define in its necessary properties.
+ In order to redefine style for all menus on a page using CSS, it's enough to create classes with the same names and define the necessary properties in them.
</para>
<para>
To change style peculiarities of the particular menus define your own style classes in the corresponding simple toggle panels attributes.
Modified: trunk/docs/userguide/en/included/menuGroup.desc.xml
===================================================================
--- trunk/docs/userguide/en/included/menuGroup.desc.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/menuGroup.desc.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -6,7 +6,7 @@
</keywordset>
</sectioninfo>
- <para>The <rich:menuGroup> component is used for definition an expandable group of items inside of popup list or another group.</para>
+ <para>The <rich:menuGroup> component is used to define an expandable group of items inside of a popup list or another group.</para>
<figure>
<title><rich:menuGroup> component</title>
<mediaobject>
Modified: trunk/docs/userguide/en/included/menuGroup.xml
===================================================================
--- trunk/docs/userguide/en/included/menuGroup.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/menuGroup.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -72,10 +72,10 @@
<section>
<title>Details of Usage</title>
<para>
- The "value" attribute defines representation text of the group element on the page.
+ The "value" attribute defines text representation of a group element on a page.
</para>
<para>
- The "icon" attribute defines an icon. The "iconDisabled" attribute defines an icon for disabled group. Also you can use the "icon" and "iconDisabled" facets. If the facets are defined, corresponding of the "icon" and "iconDisabled" attributes are ignored and facets content is shown as icon. You can use it for realization checkboxes for groups.
+ The "icon" attribute defines an icon. The "iconDisabled" attribute defines an icon for a disabled group. Also you can use the "icon" and "iconDisabled" facets. If the facets are defined, the corresponding "icon" and "iconDisabled" attributes are ignored and facets content is shown as icon. It could be used for items checkboxes implementation.
</para>
<para>
Example.
@@ -90,10 +90,10 @@
]]>
</programlisting>
<para>
- The "iconFolder" and "iconFolderDisabled" attributes are defined for using icons as folder icon. The "iconFolder" and "iconFolderDisabled" facets use content as folder icon representation.
+ The "iconFolder" and "iconFolderDisabled" attributes are defined for using icons as a folder icon. The "iconFolder" and "iconFolderDisabled" facets use content as folder icon representation.
</para>
<para>
- The "direction" attribute is used for the definition ways of menu's appearance as it's shown in the example below.
+ The "direction" attribute is used to define the ways of menu's appearance as it's shown in the example below.
</para>
<para>Possible values are:</para>
<itemizedlist>
@@ -102,7 +102,7 @@
<listitem><para>auto – smart positioning activated.</para></listitem>
</itemizedlist>
<para>
- On default the "direction" attribute defines as "auto".
+ On default the "direction" attribute is defined as "auto".
</para>
<para>
@@ -111,7 +111,7 @@
<![CDATA[
...
<rich:menuGroup value="Active" direction="left"
- <!—Nested menu components-->
+ <!--Nested menu components-->
</rich:menuGroup>
...
]]>
Modified: trunk/docs/userguide/en/included/menuItem.desc.xml
===================================================================
--- trunk/docs/userguide/en/included/menuItem.desc.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/menuItem.desc.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -6,7 +6,7 @@
</keywordset>
</sectioninfo>
- <para>The <rich:menuItem> component is used for definition the single item inside of popup list.</para>
+ <para>The <rich:menuItem> component is used for definition of a single item inside of a popup list.</para>
<figure>
<title><rich:menuItem> component</title>
<mediaobject>
Modified: trunk/docs/userguide/en/included/menuItem.xml
===================================================================
--- trunk/docs/userguide/en/included/menuItem.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/menuItem.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -70,10 +70,10 @@
<section>
<title>Details of Usage</title>
<para>
- The "value" attribute defines representation text for the item element.
+ The "value" attribute defines text representation for an item element.
</para>
<para>
- The "icon" attribute defines icon. The "iconDisabled" attribute defines icon for disabled item. Also you can use the "icon" and "iconDisabled" facets. If the facets are defined, corresponding of the "icon" and "iconDisabled" attributes are ignored and facets content is shown as icon. You can use it for realization checkboxes for items.
+ The "icon" attribute defines an icon. The "iconDisabled" attribute defines an icon for a disabled item. Also you can use the "icon" and "iconDisabled" facets. If the facets are defined, the corresponding "icon" and "iconDisabled" attributes are ignored and the facets content is shown as an icon. It could be used for items checkboxes implementation.
</para>
<para>
Example.
@@ -89,7 +89,7 @@
</programlisting>
<para>
- Switching mode could be chosen with the <rich: menuItem> attribute "mode" with three possible parameters.
+ A switching mode could be chosen with the <rich: menuItem> attribute "mode" with three possible parameters.
</para>
<itemizedlist>
<listitem><para>Server (on default)</para></listitem>
@@ -101,16 +101,16 @@
<listitem><para>Ajax</para></listitem>
</itemizedlist>
<para>
- Ajax form submission is performed additionally specified elements in the "reRender" attribute are reRendered.
+ Ajax form submission is performed, additionally specified elements in the "reRender" attribute are reRendered.
</para>
<itemizedlist>
<listitem><para>None</para></listitem>
</itemizedlist>
<para>
- The "action" and "actionListener" item's attributes are ignored. Menu items don't fire any submits itself. Behavior is fully defined by the components nested to items.
+ The "action" and "actionListener" items attributes are ignored. Menu items don't fire any submits itself. Behavior is fully defined by components nested to items.
</para>
<para>
- For example, you can put any content into the item. In this case you should set the "mode" attribute as "none".
+ For example, you can put any content into an item but in this case you should set the "mode" attribute as "none".
</para>
<para>
Example.
@@ -129,7 +129,7 @@
]]>
</programlisting>
<para>
- You can use "disabled" attribute to set item's state.
+ You can use the "disabled" attribute to set item state.
</para>
<para>
Example.
Modified: trunk/docs/userguide/en/included/menuSeparator.desc.xml
===================================================================
--- trunk/docs/userguide/en/included/menuSeparator.desc.xml 2007-05-08 01:58:53 UTC (rev 689)
+++ trunk/docs/userguide/en/included/menuSeparator.desc.xml 2007-05-08 09:19:56 UTC (rev 690)
@@ -6,7 +6,7 @@
</keywordset>
</sectioninfo>
- <para>The <rich:menuSeparator> component is used for definition horizontal separator that can be placed between groups or items.</para>
+ <para>The <rich:menuSeparator> component is used for definition of a horizontal separator that can be placed between groups or items.</para>
<figure>
<title><rich:menuSeparator></title>
<mediaobject>
More information about the richfaces-svn-commits
mailing list