Author: ochikvina
Date: 2009-08-17 03:55:09 -0400 (Mon, 17 Aug 2009)
New Revision: 15181
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml
Log:
https://jira.jboss.org/jira/browse/RF-7685 - component description review;
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.desc.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -7,7 +7,7 @@
</sectioninfo>
<section>
<title>Description</title>
- <para>The component for definition lists rendering that allows choosing data
from a model
+ <para>The component to render definition lists that allows choosing data from a
model
and obtains built-in support of Ajax updates.</para>
<figure>
<title><emphasis
role="bold"><property><rich:dataDefinitionList></property></emphasis>
component</title>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataDefinitionList.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -73,13 +73,13 @@
<title>Details of Usage</title>
<para>The <emphasis role="bold">
<property><rich:dataDefinitionList></property>
- </emphasis> component allows to generate an definition list from a
model.</para>
+ </emphasis> component allows to generate a definition list from a
model.</para>
<para>The component has the <emphasis>
<property>"term"</property>
</emphasis> facet, which corresponds to the <emphasis>
<property>"type"</property>
</emphasis> parameter for the <emphasis role="bold">
- <property><DT></property>
+ <property><dt></property>
</emphasis> HTML element.</para>
<para>Here is an example:</para>
@@ -115,18 +115,18 @@
<para>In the example the <emphasis>
<property>"rows"</property>
- </emphasis> attribute limits number of output elements of the list.</para>
+ </emphasis> attribute limits a number of output elements of the
list.</para>
- <para><emphasis>
+ <para>The <emphasis>
<property>"first"</property>
- </emphasis> attribute defines first element for output. <emphasis>
+ </emphasis> attribute defines the first element for output. <emphasis>
<property>"title"</property>
- </emphasis> are used for popup title.</para>
+ </emphasis> is used for a popup title.</para>
- <para>The component was created basing on the <emphasis
role="bold">
- <property><a4j:repeat></property>
- </emphasis> component and as a result it could be partially updated with Ajax.
<emphasis>
- <property>The "ajaxKeys"</property>
+ <para>The <emphasis role="bold">
+ <property><rich:dataDefinitionList></property>
+ </emphasis> component could be partially updated with Ajax. The <emphasis>
+ <property>"ajaxKeys"</property>
</emphasis> attribute allows to define row keys that are updated after an Ajax
request, you need to pass an array with key (lines) of the list that you want to be
updated after the Ajax request is executed.</para>
<para>Here is an example:</para>
@@ -143,7 +143,7 @@
...
]]></programlisting>
- <para> In the example <emphasis>
+ <para> In the example the <emphasis>
<property>"reRender"</property>
</emphasis> attribute contains value of <emphasis>
<property>"id"</property>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.desc.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.desc.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -7,7 +7,7 @@
</sectioninfo>
<section>
<title>Description</title>
- <para>The component for unordered lists rendering that allows choosing data
from a model
+ <para>The component to render unordered lists that allows choosing data from a
model
and obtains built-in support of Ajax updates.</para>
<figure>
<title><emphasis
role="bold"><property><rich:dataList></property></emphasis>
component</title>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataList.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -80,7 +80,7 @@
</emphasis> attribute, which corresponds to the <emphasis>
<property>"type"</property>
</emphasis> parameter for the <emphasis role="bold">
- <property><UL></property>
+ <property><ul></property>
</emphasis> HTML element and defines a marker type. Possible values for
<emphasis>
<property>"type"</property>
</emphasis> attribute are: "disc",
@@ -118,16 +118,16 @@
<para>In the example the <emphasis>
<property>"rows"</property>
- </emphasis> attribute limits number of output elements of the
list.</para>
+ </emphasis> attribute limits a number of output elements of the
list.</para>
- <para><emphasis>
+ <para>The <emphasis>
<property>"first"</property>
- </emphasis> attribute defines first element for output. <emphasis>
+ </emphasis> attribute defines the first element for output. <emphasis>
<property>"title"</property>
- </emphasis> are used for popup title. See picture below:</para>
+ </emphasis> is used for a popup title. See the picture below:</para>
<figure>
- <title><emphasis role="bold">
+ <title>The <emphasis role="bold">
<property><rich:dataList></property>
</emphasis> component with <emphasis>
<property>"title"</property>
@@ -139,9 +139,11 @@
</mediaobject>
</figure>
- <para>The component was created basing on the <emphasis
role="bold">
- <property><a4j:repeat></property>
- </emphasis> component and as a result it could be partially updated with
Ajax. <emphasis>
+ <para>The <emphasis role="bold">
+ <property><rich:dataList></property>
+ </emphasis>
+ component could be partially updated with
+ Ajax. The <emphasis>
<property>"ajaxKeys"</property>
</emphasis> attribute allows to define row keys that are updated after an
Ajax request.</para>
<para>Here is an example:</para>
@@ -161,7 +163,7 @@
<para> In the example <emphasis>
<property>"reRender"</property>
- </emphasis> attribute contains value of <emphasis>
+ </emphasis> attribute contains the value of <emphasis>
<property>"id"</property>
</emphasis> attribute for <emphasis role="bold">
<property><rich:dataList></property>
@@ -257,7 +259,7 @@
</mediaobject>
</figure>
- <para>In the example the font style for list item text was
changed.</para>
+ <para>In the example the font style for the text of the list item was
changed.</para>
<para>Also it's possible to change styles of particular <emphasis
role="bold"
<property><rich:dataList></property></emphasis>
component. In this case you should create own style classes and use them in corresponding
<emphasis role="bold"
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.desc.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -7,7 +7,7 @@
</sectioninfo>
<section>
<title>Description</title>
- <para>The component for ordered lists rendering that allows choosing data from
a model
+ <para>The component to render ordered lists that allows choosing data from a
model
and obtains built-in support of Ajax updates.</para>
<figure>
<title><emphasis
role="bold"><property><rich:dataOderedList></property></emphasis>
component</title>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2009-08-14
22:10:22 UTC (rev 15180)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/dataOrderedList.xml 2009-08-17
07:55:09 UTC (rev 15181)
@@ -96,7 +96,7 @@
</emphasis>
parameter for the
<emphasis role="bold">
- <property><OL></property>
+ <property><ol></property>
</emphasis>
HTML element and defines a marker type. Possible values for
<emphasis>
@@ -126,7 +126,7 @@
<emphasis role="bold">
<property><rich:dataOrderedList></property>
</emphasis>
- component with
+ component with the
<emphasis>
<property>"type"</property>
</emphasis>
@@ -144,27 +144,26 @@
<emphasis>
<property>"rows"</property>
</emphasis>
- attribute limits number of output elements of the list.
+ attribute limits a number of output elements of the list.
</para>
- <para>
+ <para>The
<emphasis>
<property>"first"</property>
</emphasis>
- attribute defines first element for output.
+ attribute defines the first element for output.
<emphasis>
<property>"title"</property>
</emphasis>
- are used for popup title.
+ is used for a popup title.
</para>
<para>
- The component was created basing on the
- <emphasis role="bold">
- <property><a4j:repeat></property>
+ The <emphasis role="bold">
+ <property><rich:dataOrderedList></property>
</emphasis>
- component and as a result it could be partially updated with
- Ajax.
+ component could be partially updated with
+ Ajax. The
<emphasis>
<property>"ajaxKeys"</property>
</emphasis>
@@ -191,11 +190,11 @@
<emphasis>
<property>"reRender"</property>
</emphasis>
- attribute contains value of
+ attribute contains value of the
<emphasis>
<property>"id"</property>
</emphasis>
- attribute for
+ attribute for the
<emphasis role="bold">
<property><rich:dataOrderedList></property>
</emphasis>