Author: cluts
Date: 2008-07-02 07:43:09 -0400 (Wed, 02 Jul 2008)
New Revision: 9366
Modified:
trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
Log:
RF-672 - corrected names of attributes and components
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2008-07-02
11:42:52 UTC (rev 9365)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2008-07-02
11:43:09 UTC (rev 9366)
@@ -46,7 +46,7 @@
a few options to send Ajax requests to the server. Also JSF
page doesn't change from a "regular" JSF page
and you don't need to write any JavaScript or
- XMLHttpRequest objects by hands, everything is done
+ XMLHTTPRequest objects by hands, everything is done
automatically.
</para>
</section>
@@ -135,8 +135,8 @@
<formalpara>
<title>AJAX Action Components</title>
<para>
- There are Ajax Action Components: AjaxCommandButton,
- AjaxCommandLink, AjaxPoll and AjaxSupport and etc. You
+ There are Ajax Action Components: <emphasis
role="bold"><property><a4j:commandButton></property></emphasis>,
+ <emphasis
role="bold"><property><a4j:commandLink></property></emphasis>,
<emphasis
role="bold"><property><a4j:poll></property></emphasis>
and<emphasis
role="bold"><property><a4j:support></property></emphasis>
and etc. You
can use them to send Ajax requests from the client side.
</para>
</formalpara>
@@ -178,7 +178,7 @@
to append any code to a page, put in a placeholder
for it (any empty element). For the same reason,
it's recommended to place messages in the
- <emphasis>
+ <emphasis role="bold">
<property>"AjaxOutput"</property>
</emphasis>
component (as no messages is also a message).
@@ -196,7 +196,7 @@
</listitem>
<listitem>
<para>
- Ajax requests are made by XMLHttpRequest functions
+ Ajax requests are made by XMLHTTPRequest functions
in XML format, but this XML bypasses most
validations and the corrections that might be made
in a browser. Thus, create only a strict
@@ -398,7 +398,7 @@
<property><a4j:outputPanel></property>
</emphasis>
set to
- <property>"true"</property>
+ "true"
allows to define the area of the page that will be
re-rendered even if it is not pointed in the reRender
attribute explicitly. It might be useful if you have an
@@ -706,11 +706,12 @@
</emphasis>
method must return null if you want to have an Ajax
Response with a partual page update. This is regular
- mode called "Ajax request generates Ajax Response". In
+ mode called <code>"Ajax request generates Non-Ajax
+ Response"</code>. In
case of action does not return null, but the action
outcome that matches one of navigation rules, RichFaces
- starts to work in "Ajax request generates Non-Ajax
- Response" mode. This mode might be helpful in two major
+ starts to work in <code>"Ajax request generates Non-Ajax
+ Response"</code> mode. This mode might be helpful in two major
cases:
</para>
<itemizedlist>
@@ -764,8 +765,8 @@
partial page update will occur and you will see
an error message. Otherwize, the application
proceeds to the next page. Make sure, you define
- <redirect/> option for the navigation rule
- to avoid memory leaks.
+ <emphasis
role="bold"><property><redirect/></property></emphasis>
+ option for the navigation rule to avoid memory leaks.
</para>
</listitem>
</itemizedlist>
@@ -778,7 +779,7 @@
<para>
RichFaces allows writing Ajax-enabled JSF application
without writing any Javascript code. However, you can
- still invoke the javascript code if you need. There are
+ still invoke the JavaScript code if you need. There are
several ajax attributes that helps to do it.
</para>
<para>
@@ -1096,11 +1097,11 @@
</para>
<para>
All these tags hide the usual JavaScript activities that
- are required for an XMHttpRequest object building and an
+ are required for an XMHTTPRequest object building and an
Ajax request sending. Also, they allow you to decide
which components of your JSF page are to be re-rendered
as a result of the Ajax response (you can list the IDs
- of these components in the "reRender"
+ of these components in the
<emphasis><property>"reRender"</property></emphasis>
attribute).
</para>
<para>
@@ -1112,7 +1113,7 @@
<property><a4j:commandLink></property>
</emphasis>
tags are used to send an Ajax request on
- "onclick" JavaScript event.
+ <emphasis><property>"onclick"</property></emphasis>
JavaScript event.
</para>
<para>
<emphasis role="bold">
@@ -1217,7 +1218,7 @@
<para>
If you wish to render the content of an Ajax response
outside of the active region then the value of the
- "renderRegionOnly" attribute should be set to
+ <emphasis><property>"renderRegionOnly"</property></emphasis>
attribute should be set to
"false" ("false" is default value).
Otherwise, your Ajax updates are limited to elements of
the active region.
@@ -1230,7 +1231,7 @@
<title>Decide What to Change</title>
<para>
Using IDs in the
<emphasis><property>"reRender"</property></emphasis>
attribute to
- define "AJAX zones" for update works fine in
+ define <code>"AJAX zones"</code> for update works fine
in
many cases.
</para>
<para>
@@ -1510,7 +1511,7 @@
]]></programlisting>
<para>
- The example shows that ORDER parameter defines the order in
+ The example shows that <code>ORDER</code> parameter defines the order in
which particular filter types are used for pages code
correction.
</para>
@@ -1704,8 +1705,8 @@
It's possible to redefine also the
<emphasis>
<property>"onExpired"</property>
- </emphasis>
- framework method that is called on the
+ </emphasis>
+ framework method that is called on the
<emphasis>
<property>"Session Expiration"</property>
</emphasis>
@@ -1967,7 +1968,7 @@
<para>
However, if a
<emphasis role="bold">
- <property><rich-panel></property>
+ <property><rich:panel></property>
</emphasis>
class is specified somewhere on the page, its parameters
are also acquired by all panels on this page.
@@ -2350,7 +2351,7 @@
<listitem>
<para>
- Add a skin definition <contex-param> to
+ Add a skin definition <code><contex-param></code> to
the web.xml of your application. An example is
placed below:
</para>
@@ -2448,13 +2449,8 @@
<listitem>
<para>
The file must be named
- <emphasis role="bold">
- <property>
- <skinName>
- </property>
- </emphasis>
- .skin.properties, in this case, it would
- be called
+ <code><skinName>.skin.properties</code>
+ , in this case, it would be called
<code>newskin.skin.properties</code>
.
</para>
@@ -2463,7 +2459,7 @@
<para>
The first line in this file should be
<code>
- render.kit= <render-kit-id>
+ render.kit=<render-kit-id>
</code>
in this case, it would be called
<code>render.kit=NEW_SKIN</code>
@@ -2771,7 +2767,7 @@
To get a better idea of standard component skinning we
recommend to explore CSS files located in
ui/core/src/main/resources/org/richfaces/ folder of
- Richfaces svn.
+ RichFaces svn.
</para>
@@ -3643,10 +3639,10 @@
<para>
The
- <emphasis><property>name</property></emphasis>
+ <emphasis><property>"e;name"e;</property></emphasis>
attribute of <emphasis
role="bold"><property><u:selector></property></emphasis>
tag defines the CSS
selector, while
- <property>"name"</property>
+ <emphasis><property>"name"</property></emphasis>
attribute of the
<emphasis
role="bold"><property><u:style></property></emphasis>
tag defines what skin constant is mapped to a CSS
@@ -3775,14 +3771,14 @@
<listitem>
<para>
- <property>Dname</property>
+ <code>Dname</code>
defines the name of the new skin
</para>
</listitem>
<listitem>
<para>
- <property>Dpackage</property>
+ <code>Dpackage</code>
base package of the skin. By default
"groupId" of the project is used.
</para>
@@ -3796,14 +3792,14 @@
<listitem>
<para>
- <property>DbaseSkin</property>
+ <code>DbaseSkin</code>
defines the name of the base skin.
</para>
</listitem>
<listitem>
<para>
- <property>DcreateExt</property>
+ <code>DcreateExt</code>
if set to "true", extended CSS classes
are added. For more information, please, see
<link linkend="StControlsSkinning">
@@ -3981,7 +3977,7 @@
"\src\main\resources\SKIN-PACKAGE\SKIN-NAME\css\"
folder). In the example below, it's shown how to
redefine the style properties for the
- "combobox" component.
+ <emphasis
role="bold"><property><rich:combobox></property></emphasis>
component.
</para>
<programlisting role="XML"><![CDATA[...