Author: lfryc(a)redhat.com
Date: 2011-11-16 11:28:25 -0500 (Wed, 16 Nov 2011)
New Revision: 22938
Added:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Installing_Atmosphere_libraries.xml_sample
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml
Log:
RFPL-1848: Component Reference: add atmosphere libs installation step
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2011-11-16
13:16:58 UTC (rev 22937)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2011-11-16
16:28:25 UTC (rev 22938)
@@ -538,12 +538,20 @@
<para>
The <sgmltag><a4j:push></sgmltag> component uses the Comet
model for pushing data to the client.
</para>
+
+ <section
id="sect-Component_Reference-a4jpush-Installing_runtime_dependencies">
+ <title>Installing runtime dependencies</title>
+ <para>
+ The <sgmltag><a4j:push></sgmltag> uses
Atmosphere framework on both client-side and server-side. In order to use Atmosphere on
server-side, it is necessary to add Atmosphere libraries into project.
+ </para>
+ <para>
+ In Maven based project, you should add
<code>atmosphere-runtime</code> as runtime dependency (its version is managed
by <code>richfaces-bom</code> that your project should be importing):
+ </para>
+ <programlisting language="XML"
role="XML"><xi:include parse="text"
href="extras/exam-Component_Reference-a4jpush-Installing_Atmosphere_libraries.xml_sample"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ </section>
<section id="sect-Component_Reference-a4jpush-Basic_usage">
<title>Basic usage</title>
- <para>
- The <sgmltag><a4j:push></sgmltag> uses Atmosphere framework
on both client-side and server-side. In order to use Atmosphere on server-side, it is
necessary to add Atmosphere libraries into project.
- </para>
<para>
It is possible to trigger push events on server-side in several ways:
</para>
Added:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Installing_Atmosphere_libraries.xml_sample
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Installing_Atmosphere_libraries.xml_sample
(rev 0)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-a4jpush-Installing_Atmosphere_libraries.xml_sample 2011-11-16
16:28:25 UTC (rev 22938)
@@ -0,0 +1,4 @@
+<dependency>
+ <groupId>org.atmosphere</groupId>
+ <artifactId>atmosphere-runtime</artifactId>
+</dependency>
\ No newline at end of file