Author: smukhina
Date: 2008-08-15 10:06:34 -0400 (Fri, 15 Aug 2008)
New Revision: 10116
Modified:
trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml
trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml
trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
Log:
https://jira.jboss.org/jira/browse/RF-3692 - the is checked
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-08-15 13:49:26 UTC
(rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-08-15 14:06:34 UTC
(rev 10116)
@@ -29,7 +29,7 @@
</mediaobject>
</figure>
<para>
- Here are main directories with descriptions:
+ Here are the main directories with descriptions:
</para>
<table>
<title>The project structure</title>
@@ -77,7 +77,7 @@
</tgroup>
</table>
<para>
- It is necessary to extend predefined structure with the following directories:
+ It is necessary to extend a predefined structure with the following directories:
</para>
<table>
<title>The project structure</title>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml 2008-08-15 13:49:26 UTC
(rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/protoui.xml 2008-08-15 14:06:34 UTC
(rev 10116)
@@ -45,14 +45,14 @@
<para>
All information about styles applied to the <emphasis
role="bold">
<property><inputDate></property>
- </emphasis> component is considered in the following chapter.
+ </emphasis> component is provided in the following chapter.
</para>
<para>
This is the result of your prototype which shows a simple page with an input
field and an icon indicating that
this is a date field:
</para>
<figure>
- <title>The date field component prototype implemented in HTML with an
icon</title>
+ <title>The date field component prototype implementation in HTML with an
icon</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/protoui.png"/>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml 2008-08-15 13:49:26 UTC
(rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml 2008-08-15 14:06:34 UTC
(rev 10116)
@@ -17,8 +17,8 @@
in order to create and to deliver the resource.
</para>
<para>
- So, you need to proceed to the
<property>inputDate/src/main/config/resources</property> directory and
- register following resources in the
<property>resource-config.xml</property> file:
+ Hence, you need to proceed to the
<property>inputDate/src/main/config/resources</property> directory and
+ register the following resources in the
<property>resource-config.xml</property> file:
</para>
<itemizedlist>
<listitem>
@@ -45,7 +45,7 @@
</listitem>
</itemizedlist>
<para>
- <ulink url="examples/resource-config.xml">Here</ulink> you could
find a full example of the <property>resource-config.xml</property>
+ <ulink url="examples/resource-config.xml">Here</ulink> you could
find a complete example of the <property>resource-config.xml</property>
for the <emphasis
role="bold"><property><inputDate></property></emphasis>
component.
</para>
<section id="resconf">
@@ -73,12 +73,12 @@
</resource>
...]]></programlisting>
<para>
- There are two element in the example above:
+ There are two elements in the example above:
an obligatory <emphasis
role="bold"><property><name></property></emphasis>
element which defines resource name and
a <emphasis
role="bold"><property><path></property></emphasis>
element which defines the path to the resource.
The <emphasis
role="bold"><property><path></property></emphasis>
element is optional as it is possible to register
dynamic resources with the
<emphasis><property>"class"</property></emphasis>
attribute.
- For example you could register dynamic created image as it is shown in the following
example:
+ For example you could register a dynamically created image as it is shown in the
following example:
</para>
<programlisting role="XML"><![CDATA[...
<resource class="org.mycompany.renderkit.html.images.inputDate">
@@ -108,7 +108,7 @@
</resource>
...]]></programlisting>
<para>
- Sometimes the definition of content type of the resource is needed, so it is possible
to add
+ Sometimes the definition of a content type of the resource is needed, so it is
possible to add
the <emphasis
role="bold"><property><content-type></property></emphasis>
element with the proper MIME type.
</para>
<para>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml 2008-08-15 13:49:26
UTC (rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/rendererbase.xml 2008-08-15 14:06:34
UTC (rev 10116)
@@ -40,7 +40,7 @@
The <code>InputDateRendererBase</code> class extends a
<code>HeaderResourcesRendererBase</code>
class. In the <code>HeaderResourcesRendererBase</code> class all the
<code>encode()</code> methods for
the right resources encoding
- are already realized, so in the <code>InputDateRendererBase</code> class you
need to override
+ are already implemented, so in the <code>InputDateRendererBase</code> class
you need to override
the <code>decode()</code> method only:
</para>
<programlisting role="JAVA"><![CDATA[ ...
@@ -165,7 +165,7 @@
}
...]]></programlisting>
<para>
- Finally on the the <property>Renderer Response</property> phase the value
of the component is rendered back to the view.
+ Finally on the <property>Renderer Response</property> phase the value of
the component is rendered back to the view.
The converter is responsible for transforming the object data back in to a string
representation, so you need to
implement <code>getValueAsString()</code> method:
</para>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml 2008-08-15 13:49:26
UTC (rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/taghandler.xml 2008-08-15 14:06:34
UTC (rev 10116)
@@ -18,7 +18,7 @@
indicate which JSF <code>UIComponent</code> is needed for the application.
The custom tag has a corresponding tag handler class, which is responsible for creating
the <code>UIComponent</code>
and transferring each declarative JSP tag attribute to the
<code>UIComponent</code> instance.
- So you need a custom <property>tag class</property> that returns
+ Hence you need a custom <property>tag class</property> that returns
the component type (<code>org.mycompany.InputDate</code>) and the renderer
(<code>org.mycompany.InputDateRenderer</code>).
</para>
<para>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml 2008-08-15 13:49:26 UTC
(rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/template.xml 2008-08-15 14:06:34 UTC
(rev 10116)
@@ -132,7 +132,7 @@
<note>
<title>Note:</title>
<para>
- As is easy to see, in the <property>Template Skeleton</property> the
Renderer Baseclass is
<code>org.ajax4jsf.renderkit.AjaxComponentRendererBase</code>.
+ As it is seen in the <property>Template Skeleton</property> the Renderer
Baseclass is <code>org.ajax4jsf.renderkit.AjaxComponentRendererBase</code>.
You need to define Renderer Base class special for the <emphasis
role="bold"><property><inputDate></property></emphasis>
component.
In the next section <link linkend="rendererbase">"Creating a
Renderer Base class"</link>
we will create Renderer Base class
<code>org.mycompany.renderkit.InputDateRendererBase</code>.
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml 2008-08-15 13:49:26 UTC
(rev 10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/ui_conf.xml 2008-08-15 14:06:34 UTC
(rev 10116)
@@ -41,7 +41,7 @@
</para>
</tip>
<para>
- Application instance stores resources defined in the descriptors at application
start-up, so it is neccessary to register
+ Application instance stores resources defined in the descriptors at application
start-up, so it is necessary to register
following classes:
</para>
<itemizedlist>
Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml 2008-08-15 13:49:26 UTC (rev
10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/modules/intro.xml 2008-08-15 14:06:34 UTC (rev
10116)
@@ -13,20 +13,20 @@
<para>
The major benefit of the JSF framework is a component based architecture.
The component in JSF is not just a set of HTML code rendered and interpreted by a
browser.
- The JSF component is a composition of a client-side widget coupled with the
server-side object
+ The JSF component is a combination of a client-side widget coupled with the
server-side object
that represents component behavior including data validation, events handling,
business layers bean binding, etc.
</para>
<para>
- In contrast to a page-oriented development approach,
+ Comparing to a page-oriented development approach,
JSF allows to use a component-oriented paradigm to build a well-designed,
highly customizable UI interface based on reusable components.
</para>
- <para>
- However, there is not yet enough sets of rich components on the market that might
enable the rapid application developments.
- One of important problems is a long and very complicated process of the component
creation.
- Even the very primitive JSF component requires to write the
<property>UIComponent</property> class,
+ <para>
+ However, there is not yet enough sets of rich components on the market that might
enable the rapid application development.
+ One of the most important problems is a time-consuming and very complicated
process of the component creation.
+ Even the very primitive JSF component requires the
<property>UIComponent</property> class,
<property>Renderer class</property>, <property>Tag
class</property>
- and a faces configuration file
(<property>faces-config.xml</property>).
+ and a faces configuration file
(<property>faces-config.xml</property>) to be written.
</para>
<para>
In order to use the component library in a Facelets environment,
@@ -36,9 +36,9 @@
Creation of the rich component takes even more time.
You have to provide the <property>ListenerTagHandler
class</property>, a class for creating a listener interface,
an event processing method name in a listener interface,
- an event class, render specific classes for each possible render kit used with
the component.
+ an event class, render specific classes for each possible render kit used with
the component.
</para>
- <para>
+ <para>
Therefore, the process of JSF component creation is pretty complicated but
repeatable.
Jonas Jacobi and John R. Fallows in their "Pro JSF and Ajax Bulling Rich
Internet Components" book describe
the process in details.
@@ -46,20 +46,20 @@
for <property>Component Development Kit (CDK)</property> - a
sub-project of <property>RichFaces</property>
that allows you to easily create rich components with built-in Ajax support.
- <!--With version 1.1, Ajax4jsf introduces the Component Factory - a
Maven-driven process based on CDK.-->
+ <!--With version 1.1, Ajax4jsf introduces the Component Factory - a
Maven-driven process based on CDK.-->
</para>
- <para>
- The significant features of the <property>Component Development Kit
(CDK)</property> are:
+ <para>
+ The significant features of the <property>Component Development Kit
(CDK)</property> are:
</para>
- <itemizedlist>
- <listitem>
+ <itemizedlist>
+ <listitem>
<para>
Quick development start.
A new component development starts from a pre-generated component project
template.
- It contains the whole required infrastructure and necessary files
generated.
+ It contains the whole required infrastructure and necessary files
generated.
It's necessary only to have a <ulink
url="http://maven.apache.org">Maven</ulink> installed.
- All other required stuff will be loaded and configured automatically.
- </para>
+ All other required stuff will be loaded and configured automatically.
+ </para>
</listitem>
<listitem>
<para>
@@ -89,7 +89,7 @@
At the moment of generating the initial project structure,
the <property>Unit Test classes</property> are also
generated.
The <property>RichFaces</property> also provides the
Mock-test facility that allows to emulate
- a run-time environment and automatically test the components before their
are gathered into the result library.
+ a run-time environment and automatically test components before their are
gathered into the result library.
</para>
</listitem>
<listitem>
@@ -107,6 +107,6 @@
RichFaces comes with a number of predefined skins to get you started,
but you can also easily create your own custom skins.
</para>
- </listitem>
+ </listitem>
</itemizedlist>
</chapter>
\ No newline at end of file
Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-08-15 13:49:26 UTC (rev
10115)
+++ trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-08-15 14:06:34 UTC (rev
10116)
@@ -30,7 +30,7 @@
</para>
</listitem>
<listitem>
- <para> Browser (on client side) </para>
+ <para> Browser (on the client side) </para>
</listitem>
</itemizedlist>
<para> After the <property>Maven</property> is installed you should
configure it. In this case,
@@ -89,15 +89,15 @@
</pluginRepository>
</pluginRepositories>
</profile>
-...]]>
+...]]>
</programlisting>
- <para> In order to activate new profile, please, add the following after the
+ <para> In order to activate a new profile, add the following after the
<property>profiles</property> section: </para>
<programlisting role="XML"><![CDATA[...
<activeProfiles>
<activeProfile>cdk</activeProfile>
</activeProfiles>
-...]]>
+...]]>
</programlisting>
<note>
<title>Note:</title>
@@ -110,7 +110,7 @@
<para> The environment is set up now to use the <property>Component
Development Kit
(CDK)</property>. </para>
<para> We are going to create two components throughout the RichFaces CDK
Developer Guide, but
- at first you need take the following steps in order to set up the
+ at first you need take the following steps to set up the
<property>Project</property> and create your library: </para>
<itemizedlist>
<listitem>
@@ -181,7 +181,7 @@
<version>3.2.1.GA</version>
</dependency>
</dependencies>
-</project>]]>
+</project>]]>
</programlisting>
</listitem>
<listitem>