Author: lfryc(a)redhat.com Date: 2011-11-23 08:57:15 -0500 (Wed, 23 Nov 2011) New Revision: 22981 Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml Log: RFPL-1857: Document third-party dependencies for non-maven based projects Modified: modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml =================================================================== --- modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-11-23 13:31:16 UTC (rev 22980) +++ modules/docs/trunk/Developer_Guide/src/main/docbook/en-US/chap-Developer_Guide-Getting_started_with_RichFaces.xml 2011-11-23 13:57:15 UTC (rev 22981) @@ -38,6 +38,205 @@ </para> --> + <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Technical_Requirements-Project_libraries_and_dependencies"> + <title>Project libraries and dependencies</title> + + <para> + RichFaces library comes in form of Java archives for Core Framework and Components. + </para> + + <itemizedlist> + <title>RichFaces libraries</title> + <listitem> + <para> + <filename>richfaces-core-api.jar</filename> + </para> + </listitem> + <listitem> + <para> + <filename>richfaces-core-impl.jar</filename> + </para> + </listitem> + <listitem> + <para> + <filename>richfaces-components-api.jar</filename> + </para> + </listitem> + <listitem> + <para> + <filename>richfaces-components-ui.jar</filename> + </para> + </listitem> + </itemizedlist> + + <para> + The framework depends on third-party dependencies which can be classified to mandatory and optional (libraries enabling certain functionality). + </para> + <para> + Note that these dependencies may depend on their own runtime dependencies. + </para> + + <itemizedlist> + <title>Mandatory third-party dependencies</title> + <listitem> + <para> + Java Server Faces 2.x implementation + </para> + <itemizedlist> + <listitem> + <para> + <filename>javax.faces.jar</filename> (version <code>2.1.3</code> or higher) + </para> + </listitem> + <listitem> + <para> + or <filename>myfaces-impl.jar</filename> (version <code>2.1.4</code> or higher) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Google Guava + </para> + <itemizedlist> + <listitem> + <para> + <filename>guava.jar</filename> (version <code>r08</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + CSS Parser + </para> + <itemizedlist> + <listitem> + <para> + <filename>cssparser.jar</filename> (version <code>0.9.5</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Simple API for CSS + </para> + <itemizedlist> + <listitem> + <para> + <filename>sac.jar</filename> (version <code>1.3</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + + <itemizedlist> + <title>Optional third-party dependencies</title> + <listitem> + <para> + Bean validation (JSR-303) integration for client-side validation (JSR-303 API and Implementation) + </para> + <itemizedlist> + <listitem> + <para> + <filename>validation-api.jar</filename> (version <code>1.0.0.GA</code>) + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + <filename>hibernate-validator.jar</filename> (version <code>4.2</code> or higher) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Push transport library - Atmosphere (without dependencies) + </para> + <itemizedlist> + <listitem> + <para> + <filename>atmosphere-runtime.jar</filename> (version <code>0.8.0-RC1</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Push JMS integration (JMS API and Implementation) + </para> + <itemizedlist> + <listitem> + <para> + <filename>jms.jar</filename> (version <code>1.1</code>) + </para> + </listitem> + <listitem> + <para> + <filename>hornetq-jms.jar</filename> (version <code>2.2</code> or higher) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Push CDI integration (CDI API and Implementation) + </para> + <itemizedlist> + <listitem> + <para> + <filename>cdi-api.jar</filename> (version <code>1.0-SP4</code>) + </para> + </listitem> + <listitem> + <para> + <filename>javax.inject.jar</filename> (version <code>1</code>) + </para> + </listitem> + <listitem> + <para> + <filename>jsr-250-api.jar</filename> (version <code>1.0</code>) + </para> + </listitem> + <listitem> + <para> + <filename>weld-servlet.jar</filename> (version <code>1.1.0.Final</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Extended caching (EhCache) + </para> + <itemizedlist> + <listitem> + <para> + <filename>ehcache.jar</filename> (version <code>1.6.0</code>) + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + + <note> + <title>Dependencies for servlet containers</title> + <para> + Some of dependencies are part of Java EE 6 specification and thus it is not necessary to include them in projects running on Java EE applications servers. + </para> + <para> + It is still necessary to include them on servlet containers. + </para> + <para> + Dependencies on Servlet API, JSP API and EL API are excluded since these are integral parts of both application servers and servlet containers. + </para> + </note> + </section> </section> <section id="sect-Developer_Guide-Getting_started_with_RichFaces-Development_environments"> @@ -139,7 +338,7 @@ <step id="step-Developer_Guide-Creating_a_project-Add_the_RichFaces_libraries_to_the_project"> <title>Add the RichFaces libraries to the project</title> <para> - Add <filename>richfaces-core-api.jar</filename>, <filename>richfaces-core-impl.jar</filename>, <filename>richfaces-components-api.jar</filename>, and <filename>richfaces-components-ui.jar</filename> into your project. Copy them from the location where you unzipped the RichFaces archive to the <filename>WebContent/WEB-INF/lib/</filename> directory of your project in <application>JBoss Tools</application>. + Add <link linkend="sect-Developer_Guide-Getting_started_with_RichFaces-Technical_Requirements-Project_libraries_and_dependencies">RichFaces libraries and their mandatory dependencies</link> to the project. Copy them from the location where you unzipped the RichFaces archive to the <filename>WebContent/WEB-INF/lib/</filename> directory of your project in <application>JBoss Tools</application>. </para> </step> <step id="step-Developer_Guide-Creating_a_project-Reference_the_tag_libraries">