[richfaces-svn-commits] JBoss Rich Faces SVN: r16336 - in root/docs/trunk: Component_Development_Kit_Guide and 5 other directories.

Author: SeanRogers Date: 2010-01-20 00:11:39 -0500 (Wed, 20 Jan 2010) New Revision: 16336 Added: root/docs/trunk/pom.xml Modified: root/docs/trunk/Component_Development_Kit_Guide/pom.xml root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_features.xml root/docs/trunk/Component_Reference/pom.xml root/docs/trunk/Developer_Guide/en-US/Author_Group.xml root/docs/trunk/Developer_Guide/en-US/Book_Info.xml root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml root/docs/trunk/Developer_Guide/pom.xml root/docs/trunk/Migration_Guide/pom.xml Log: Added root pom.xml but can no longer build individual books Modified: root/docs/trunk/Component_Development_Kit_Guide/pom.xml =================================================================== --- root/docs/trunk/Component_Development_Kit_Guide/pom.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Component_Development_Kit_Guide/pom.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -3,11 +3,17 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>org.jboss.project</groupId> + <groupId>org.jboss.richfaces</groupId> <artifactId>${docname}-${translation}</artifactId> <version>1.0</version> <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> + + <parent> + <groupId>org.jboss.richfaces</groupId> + <artifactId>docs</artifactId> + <version>1.0</version> + </parent> <properties> <translation>en-US</translation> @@ -185,7 +191,7 @@ <sourceDocumentName>${docname}.xml</sourceDocumentName> <sourceDirectory>.</sourceDirectory> <imageResource> - <directory>${translation}</directory> + <directory>${docname}/${translation}</directory> <includes> <include>images/*</include> </includes> Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_features.xml =================================================================== --- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_features.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Common_features.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -7,23 +7,77 @@ This chapter covers those attributes and features that are common to many of the components in the tag libraries. </para> <section id="sect-Component_Reference-Common_features-Positioning_in_popup_components"> - <title>Positioning in popup components</title> + <title>Positioning and appearance of components</title> <para> - Incomplete + A number of attributes relating to positioning and appearance are common to several components. </para> + <variablelist> + <varlistentry> + <term>disabled</term> + <listitem> + <para> + Specifies whether the component is disabled, which disallows user interaction. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>focus</term> + <listitem> + <para> + References the <varname>id</varname> of an element on which to focus after a request is completed on the client side. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>height</term> + <listitem> + <para> + The height of the component in pixels. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>dir</term> + <listitem> + <para> + Specifies the direction in which to display text that does not inherit its writing direction. Valid values are <literal>LTR</literal> (left-to-right) and <literal>RTL</literal> (right-to-left). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>style</term> + <listitem> + <para> + Specifies Cascading Style Sheet (<acronym>CSS</acronym>) styles to apply to the component. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>styleClass</term> + <listitem> + <para> + Specifies one or more <acronym>CSS</acronym> class names to apply to the component. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>width</term> + <listitem> + <para> + The width of the component in pixels. + </para> + </listitem> + </varlistentry> + </variablelist> </section> <section id="sect-Component_Reference-Common_features-Calling_available_JavaScript_methods"> <title>Calling available JavaScript methods</title> <para> - Client-side JavaScript methods can be called using component events. These JavaScript methods are defined using the relevant event attribute for the component tag. + Client-side JavaScript methods can be called using component events. These JavaScript methods are defined using the relevant event attribute for the component tag. Methods are referenced through typical Java syntax within the event attribute, while any parameters for the methods are obtained through the <varname>data</varname> attribute, and referenced using <acronym>JSF</acronym> Expression Language (<acronym>EL</acronym>). <xref linkend="exam-Component_Reference-data-Data_reference_example" /> a simple reference to a JavaScript method with a single parameter. </para> - </section> - - <section id="sect-Component_Reference-Common_features-Client_side_macro_substitution"> - <title>Client-side macro-substitution</title> <para> - Incomplete + Refer to <xref linkend="sect-Component_Reference-Common_Ajax_attributes-Events_and_JavaScript_interactions" /> or to event descriptions unique to each component for specific usage. </para> </section> Modified: root/docs/trunk/Component_Reference/pom.xml =================================================================== --- root/docs/trunk/Component_Reference/pom.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Component_Reference/pom.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -3,11 +3,17 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>org.jboss.project</groupId> + <groupId>org.jboss.richfaces</groupId> <artifactId>${docname}-${translation}</artifactId> <version>1.0</version> <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> + + <parent> + <groupId>org.jboss.richfaces</groupId> + <artifactId>docs</artifactId> + <version>1.0</version> + </parent> <properties> <translation>en-US</translation> @@ -185,7 +191,7 @@ <sourceDocumentName>${docname}.xml</sourceDocumentName> <sourceDirectory>.</sourceDirectory> <imageResource> - <directory>${translation}</directory> + <directory>${docname}/${translation}</directory> <includes> <include>images/*</include> </includes> Modified: root/docs/trunk/Developer_Guide/en-US/Author_Group.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Author_Group.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Developer_Guide/en-US/Author_Group.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -8,11 +8,72 @@ <author> <firstname>Sean</firstname> <surname>Rogers</surname> + <contrib>Documentation lead for 4.0</contrib> <affiliation> <orgname>Red Hat</orgname> <orgdiv>Engineering Content Services</orgdiv> </affiliation> <email&gt;serogers(a)redhat.com&lt;/email&gt; </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <contrib>Documentation lead for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;smukhina(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Anastasiya</firstname> + <surname>Bogachuk</surname> + <contrib>Documentation for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;abogachuk(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Gleb</firstname> + <surname>Galkin</surname> + <contrib>Documentation for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;ggalkin(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Mikhail</firstname> + <surname>Sorokin</surname> + <contrib>Documentation for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;msorokin(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Alexander</firstname> + <surname>Tsebro</surname> + <contrib>Documentation for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;atsebro(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + <contrib>Documentation for 3.3</contrib> + <affiliation> + <orgname>Exadel</orgname> + <orgdiv>Documentation</orgdiv> + </affiliation> + <email&gt;ochikvina(a)exadel.com&lt;/email&gt; + </author> </authorgroup> Modified: root/docs/trunk/Developer_Guide/en-US/Book_Info.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/Book_Info.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Developer_Guide/en-US/Book_Info.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -13,7 +13,7 @@ <edition>0</edition> <pubsnumber>1</pubsnumber> <abstract> - <para>This book is a comprehensive reference for getting started and + <para>Read this book for a comprehensive guide to getting started and working with RichFaces &VERSION;. It includes details of the architecture, the framework&#39;s use in different applications, and skinning implementations.</para> Modified: root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Developer_Guide/en-US/appe-Developer_Guide-Resources.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -7,7 +7,36 @@ <appendix id="appe-Developer_Guide-Resources"> <title>Resources</title> <para> - Incomplete + Refer to these resources for further information on RichFaces. </para> + <variablelist> + <varlistentry> + <term>JBoss RichFaces</term> + <listitem> + <para> + <ulink url="http://www.jboss.com/richfaces/">http://www.jboss.com/r... + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>RichFaces Project Space</term> + <listitem> + <para> + <ulink url="http://community.jboss.org/en/richfaces">http://communi... + </para> + <para> + Includes forum and wiki. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>RichFaces Team Blog</term> + <listitem> + <para> + <ulink url="http://jroller.com/a4j/">http://jroller.com/a4j/</ul... + </para> + </listitem> + </varlistentry> + </variablelist> </appendix> Modified: root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml =================================================================== --- root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Developer_Guide/en-US/chap-Developer_Guide-Introduction.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -7,7 +7,50 @@ <chapter id="chap-Developer_Guide-Introduction"> <title>Introduction</title> <para> - RichFaces is a rich component library for JavaServer Faces (<acronym>JSF</acronym>) built on the open-source Ajax4jsf framework. It allows easy integration of Ajax capabilities into enterprise application development without needing to use Javascript. + RichFaces is a rich component library for JavaServer Faces (<acronym>JSF</acronym>) 2 built on the open-source Ajax4jsf framework. It allows integration of Ajax capabilities into enterprise web application development without needing to use JavaScript. </para> + <para> + RichFaces leverages several parts of the JSF2 framework including lifecycle, validation, conversion facilities, and management of static and dynamic resources. The RichFaces framework includes components with built-in Ajax support and a customizable look-and-feel that can be incorporated into JSF applications. + </para> + <para> + RichFaces provides a number of advantages for enterprise web application development: + <itemizedlist> + <listitem> + <para> + Build on the benefits of JavaServer Faces with support for Ajax. RichFaces is fully integrated into the JSF lifecycle. While other frameworks only give access to the managed bean facility, RichFaces uses the action and value change listeners, and invokes server-side validators and converters during the Ajax request-response cycle. + </para> + </listitem> + <listitem> + <para> + Add Ajax capability to existing JSF applications. The core Ajax library (<classname>a4j</classname>) adds Ajax functionality into existing pages, such that extra JavaScript code is unnecessary and existing components do not need to be replaced with Ajax ones. RichFaces enables page-wide Ajax support instead of the traditional component-wide support, and events can be defined on the page for invoking an Ajax requests and JSF Component Tree synchronization. + </para> + </listitem> + <listitem> + <para> + Create complex application views using out-of-the-box components. The RichFaces user interface (<acronym>UI</acronym>) library (<classname>rich</classname>) contains components for adding rich interactive features to JSF applications. It extends the RichFaces framework to include a large set of Ajax-enabled components that come with extensive skinning support. Additionally, RichFaces components are designed to be used seamlessly with other 3d-party component libraries on the same page, so you have more options for developing your applications. + </para> + </listitem> + <listitem> + <para> + Write your own customized rich components with built-in Ajax support. The Component Development Kit (<acronym>CDK</acronym>), used for the RichFaces UI library creation, includes a code-generation facility and a templating facility using a JavaServer Pages (<acronym>JSP</acronym>)-like syntax. + </para> + </listitem> + <listitem> + <para> + Package resources with application Java classes. Ajax functionality in RichFaces provides an advanced support for the management of different resources, such as pictures, JavaScript code, and CSS stylesheets. The resource framework makes it possible to pack these resources into <filename>jar</filename> Java archive files along with the code for any custom components. + </para> + </listitem> + <listitem> + <para> + Generate binary resources on the fly. The resource framework can generate images, sounds, Microsoft <application>Excel</application> spreadsheets, and more during run-time. + </para> + </listitem> + <listitem> + <para> + Create a modern rich user-interface with skinning technology. RichFaces provides a skinning feature that allows you to define and manage different color schemes and other parameters of the look and feel. It is possible to access the skin parameters from JSP code and Java code during run-time. RichFaces comes packaged with a number of skins to get you started, but you can also easily create your own customized skins too. + </para> + </listitem> + </itemizedlist> + </para> </chapter> Modified: root/docs/trunk/Developer_Guide/pom.xml =================================================================== --- root/docs/trunk/Developer_Guide/pom.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Developer_Guide/pom.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -3,11 +3,17 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>org.jboss.project</groupId> + <groupId>org.jboss.richfaces</groupId> <artifactId>${docname}-${translation}</artifactId> <version>1.0</version> <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> + + <parent> + <groupId>org.jboss.richfaces</groupId> + <artifactId>docs</artifactId> + <version>1.0</version> + </parent> <properties> <translation>en-US</translation> @@ -185,7 +191,7 @@ <sourceDocumentName>${docname}.xml</sourceDocumentName> <sourceDirectory>.</sourceDirectory> <imageResource> - <directory>${translation}</directory> + <directory>${docname}/${translation}</directory> <includes> <include>images/*</include> </includes> Modified: root/docs/trunk/Migration_Guide/pom.xml =================================================================== --- root/docs/trunk/Migration_Guide/pom.xml 2010-01-20 01:09:03 UTC (rev 16335) +++ root/docs/trunk/Migration_Guide/pom.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -3,11 +3,17 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>org.jboss.project</groupId> + <groupId>org.jboss.richfaces</groupId> <artifactId>${docname}-${translation}</artifactId> <version>1.0</version> <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> + + <parent> + <groupId>org.jboss.richfaces</groupId> + <artifactId>docs</artifactId> + <version>1.0</version> + </parent> <properties> <translation>en-US</translation> @@ -185,7 +191,7 @@ <sourceDocumentName>${docname}.xml</sourceDocumentName> <sourceDirectory>.</sourceDirectory> <imageResource> - <directory>${translation}</directory> + <directory>${docname}/${translation}</directory> <includes> <include>images/*</include> </includes> Added: root/docs/trunk/pom.xml =================================================================== --- root/docs/trunk/pom.xml (rev 0) +++ root/docs/trunk/pom.xml 2010-01-20 05:11:39 UTC (rev 16336) @@ -0,0 +1,17 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 + http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>org.jboss.richfaces</groupId> + <version>1.0</version> + <artifactId>docs</artifactId> + <packaging>pom</packaging> + <modules> + <module>Component_Development_Kit_Guide</module> + <module>Component_Reference</module> + <module>Developer_Guide</module> + <module>Migration_Guide</module> + </modules> +</project> +