Author: juankprada Date: 2011-03-09 08:56:43 -0500 (Wed, 09 Mar 2011) New Revision: 22104 Modified: trunk/archetypes/richfaces-archetype-simpleapp/readme.txt trunk/archetypes/richfaces-archetype-simpleapp/src/main/resources/archetype-resources/readme.txt trunk/dist/readme-examples.txt trunk/dist/readme-ui.txt Log: RF-10583 Updates readme files for distribution package as well as readme files used in the archetype description and in a maven generated project. Modified: trunk/archetypes/richfaces-archetype-simpleapp/readme.txt =================================================================== --- trunk/archetypes/richfaces-archetype-simpleapp/readme.txt 2011-03-09 13:51:52 UTC (rev 22103) +++ trunk/archetypes/richfaces-archetype-simpleapp/readme.txt 2011-03-09 13:56:43 UTC (rev 22104) @@ -1,9 +1,69 @@ -RichFaces 4 Archetype +======================================================================== + RichFaces - Ajax enabled JSF 2.0 component library -This archetype creates a simple RichFaces 4 application. To generate a project from the archetype, run + RichFaces 4.0.CR1 EXAMPLES + http://richfaces.org + March 2011 + This software is distributed under the terms of the + FSF Lesser Gnu Public License (see lgpl.txt) - mvn archetype:generate -DarchetypeGroupId=org.richfaces.archetypes -DarchetypeArtifactId=richfaces-archetype-simpleapp - -DarchetypeVersion=<version> -DgroupId=<yourGroupId> -DartifactId=<yourArtifactId> -Dversion=1.0-SNAPSHOT +======================================================================== +RichFaces 4 is a component library for JSF2 and an advanced framework for +easily integrating AJAX capabilities into business applications. +This file explains how to generate a RichFaces application as a Maven 2 +project. If you find any issue with the project, please report +the issue on the RichFaces user forum (http://community.jboss.org/en/richfaces) +or jira (https://issues.jboss.org/browse/RF). + + +USING THE ARCHETYPE: +-------------------- + + +1. Install Maven 2 (see http://maven.apache.org for details) + +2. Generate the project from the archetype + +After installing Maven 2, open a terminal inside the directory you +want your project to be created and execute the command below: + + mvn archetype:generate -DarchetypeGroupId=org.richfaces.archetypes + -DarchetypeArtifactId=richfaces-archetype-simpleapp + -DarchetypeVersion=<version> + -DgroupId=<yourGroupId> + -DartifactId=<yourArtifactId> + -Dversion=1.0-SNAPSHOT + +After executing the command, Maven will generate your project structure. +Make sure you replace the parameters values enclosed by < > according +to your needs. + + + +MORE INFORMATION AND RESOURCES +------------------------------ + +For more information on RichFaces 4 features, how to migrate from +previous versions, and answers to the most frequently asked questions (FAQ), +please visit RichFaces website at: + +http://www.jboss.org/richfaces. + +Or the Wiki at: + + - http://community.jboss.org/wiki/richfaceswikihomepage + +To report or check the status of issues related to RichFaces use the +project's Jira at: + + - https://issues.jboss.org/browse/RF + +Community support and help can be obtained from the RichFaces forums at: + + - http://community.jboss.org/en/richfaces?view=discussions + + +### Modified: trunk/archetypes/richfaces-archetype-simpleapp/src/main/resources/archetype-resources/readme.txt =================================================================== --- trunk/archetypes/richfaces-archetype-simpleapp/src/main/resources/archetype-resources/readme.txt 2011-03-09 13:51:52 UTC (rev 22103) +++ trunk/archetypes/richfaces-archetype-simpleapp/src/main/resources/archetype-resources/readme.txt 2011-03-09 13:56:43 UTC (rev 22104) @@ -1,9 +1,85 @@ -Project generated with richfaces-archetype-simpleapp +======================================================================== -To build this project for Tomcat 6 run + RichFaces - Ajax enabled JSF 2.0 component library - mvn clean package + RichFaces 4.0.CR1 + http://richfaces.org + March 2011 + This software is distributed under the terms of the + FSF Lesser Gnu Public License (see lgpl.txt) -If you wan to create a binaries for both Tomcat 6 and JBoss 6 run +======================================================================== - mvn clean package -P release \ No newline at end of file +This project is an application generated with richfaces-achttype-simpleapp. +This file explains how to build and set up the project using Maven. If you +find any issue related to RichFaces framework, please report the issue on +the RichFaces user forum (http://community.jboss.org/en/richfaces) or +jira (https://issues.jboss.org/browse/RF). + + +SETTING UP THE APPLICATION +-------------------------- + +1. Requirements + +In order to build the Examples applications you will need: + - Maven 2.1.0 or later + - Servers: Apache Tomcat 6.0 or any JEE6 application server + (e.g. Jboss AS 6) + - JDK 1.6 + +Also optional Additional Software would make it easy for you to work +with the sources of the application: + + - Eclipse IDE + JBoss Tools (to explore and run the application + in IDE). You're obviously free to use any other IDE you wish, but + JBoss Tools is recommended. + +2. Build/Deploy + + - Deploying on Tomcat + + To build the project for Tomcat you need to navigate to the + /examples/richfaces-showcase and run: + + mvn clean package + + When you see the BUILD SUCCESSFUL message you can deploy the + application on the server. To deploy it on Tomcat, copy the .war + file from 'target' folder to TOMCAT_HOME/webapps folder. Then, + launch the startup.sh or startup.bat script from TOMCAT_HOME/bin/ + directory to start the server. + + - Deploying on JEE6 server (JBoss AS 6) + + To build the project for a JEE6 server you need to navigate to the + /examples/richfaces-showcase and run + + mvn clean package -Pjee6 + + When you see the BUILD SUCCESSFUL message you can deploy the + application on the server. To deploy it on the application server + copy the .war file from 'target' folder to the JBOSS_HOME/server/default/deploy + folder (or change "default/" to used profile folder). Then, launch + the run.sh or run.bat script from JBOSS_HOME/bin/ directory to start + the server. + + + - If you wan to create a binaries for both Tomcat 6 and JBoss 6 run + + mvn clean package -P release + + +After deploying the examples to your server open a browser and type +http://localhost:8080/projectName to execute the application. + + +MORE INFORMATION AND RESOURCES +------------------------------ + +For more information on this project please contact the developer. + +For more information on RichFaces 4, please visit RichFaces +website at: + + - http://www.jboss.org/richfaces. Modified: trunk/dist/readme-examples.txt =================================================================== --- trunk/dist/readme-examples.txt 2011-03-09 13:51:52 UTC (rev 22103) +++ trunk/dist/readme-examples.txt 2011-03-09 13:56:43 UTC (rev 22104) @@ -1,39 +1,134 @@ -RichFaces 4.0 Examples -========================================================= -Version 4.0.0.M3 +======================================================================== -This software is distributed under the terms of the FSF Lesser Gnu Public License (see lgpl.txt). + RichFaces - Ajax enabled JSF 2.0 component library -Getting up and running quickly -------------------------------- -The core-demo and richfaces-showcase demo applications should be built using Maven 2.1.0 + RichFaces 4.0.CR1 EXAMPLES + http://richfaces.org + March 2011 + This software is distributed under the terms of the + FSF Lesser Gnu Public License (see lgpl.txt) -tomcat6/jetty targeted build: +======================================================================== -1) execute "mvn clean package" in root application folder(examples/richfaces-showcase or examples/core-demo) -2) Deploy to tomcat 6.x (built .war file is located in the 'target' folder) or just run using maven on jetty using "mvn clean jetty:run-war" +RichFaces 4 is a component library for JSF2 and an advanced framework for +easily integrating AJAX capabilities into business applications. -JEE6 (GlassFish 3, JBoss AS 6) server targeted build: -1) execute "mvn clean package -Pjee6" in root application folder(examples/richfaces-showcase or examples/core-demo) -2) Deploy built application (built .war file is located in the 'target' folder) to application server +This file explains how to set up the RichFaces examples bundled with the +distribution package. If you find any issue with the project, please report +the issue on the RichFaces user forum (http://community.jboss.org/en/richfaces) +or jira (https://issues.jboss.org/browse/RF). -Type http://localhost:8080/richfaces-showcase http://localhost:8080/core-demo in your browser address bar after starting server. -More additional information about build profiles for concrete applications and working with them - inside readme's for application itself. +SETTING UP THE EXAMPLES +----------------------- -NOTE: richfaces-showcase contains readme.txt which shows how to publish the application to Google Application Engine. + 1. Requirements + + In order to build the Examples applications you will need: + - Maven 2.1.0 or later + - Servers: Apache Tomcat 6.0 or any JEE6 application server + (e.g. Jboss AS 6) + - JDK 1.6 -Using IDE to work with examples -------------------------------- - *You could use JBoss Tools with m2eclipse plugin and just import the examples as maven-based projects. - - *Or if you have not using m2eclipse - execute: - mvn eclipse:ecllipse - in root example folder and import to ecplise just as existent project after build complete. + Also optional Additional Software would make it easy for you to work + with the sources of the application: + - Eclipse IDE + JBoss Tools (to explore and run the application + in IDE). You're free to use any other IDE also but we haven't + tested the application in other environments. + 2. Build/Deploy -Learn more ----------- -RichFaces Project - http://www.jboss.org/richfaces -RichFaces 4.0 Wiki - http://www.jboss.org/community/wiki/RichFaces40Planning \ No newline at end of file + - Deploy on Tomcat/Jetty + + To build the project for Tomcat you need to navigate to the + /examples/richfaces-showcase or /examples/core-demo directories + and run: + + mvn clean package + + When you see the BUILD SUCCESSFUL message you can deploy the + application on the server. To deploy it on Tomcat, copy the .war + file from 'target' folder to TOMCAT_HOME/webapps folder. Then, + launch the startup.sh or startup.bat script from TOMCAT_HOME/bin/ + directory to start the server. + + - Deploy on JEE6 server (JBoss AS 6) + + To build the project for a JEE6 server you need to navigate to the + /examples/richfaces-showcase or /examples/core-demo directory + and run: + + mvn clean package -Pjee6 + + When you see the BUILD SUCCESSFUL message you can deploy the + application on the server. To deoploy it on the application server + copy the .war file from 'target' folder to the JBOSS_HOME/server/default/deploy + folder (or change "default/" to used profile folder). Then, launch + the run.sh or run.bat script from JBOSS_HOME/bin/ directory to start + the server. + +After deploying the examples to your server open a browser and type +http://localhost:8080/richfaces-showcase or http://localhost:8080/core-demo +to view the examples. + +Additional information about build profiles for these applications +and working with them can be found inside the readme files for application +itself. + +NOTE: richfaces-showcase contains readme.txt which shows how to +publish the application to Google Application Engine. + + +USING AN IDE TO WORK WITH EXAMPLES +---------------------------------- + +In order to explore, run and deploy the examples using Eclipse IDE you can use +one of the following options: + + - You could use JBoss Tools with m2eclipse plugin and just import + the examples as maven-based projects. + * Open Eclipse and go to File > Import + * Expand the project type named Maven and select Import Maven + Project + * Browse the directory in which you placed the examples, select + it and press OK. + * Press next on the import wizard to finish importing the + examples. + + - Or if you are not using m2eclipse execute use Maven to convert the + project to an Eclipse project: + * Open a terminal inside the RichFaces examples directory + * execute mvn eclipse:ecllipse + * Open Eclipse and select File > Import + * Select Import as existing project into workspace after build + is complete. + * Follow the instructions on the import wizard. + +You are now able to work with the examples within Eclipse. + + +MORE INFORMATION AND RESOURCES +------------------------------ + +For more information on RichFaces 4, please visit RichFaces +website at: + + - http://www.jboss.org/richfaces. + +Or check the Wiki for more information on build instructions for the examples at: + + - http://community.jboss.org/wiki/HowtoworkwithRichFaces4xexamplessources + +To report or check the status of issues related to RichFaces Examples +use the project's Jira at: + + - https://issues.jboss.org/browse/RF + +Community support and help can be obtained from the RichFaces forums at: + + - http://community.jboss.org/en/richfaces?view=discussions + + + +### Modified: trunk/dist/readme-ui.txt =================================================================== --- trunk/dist/readme-ui.txt 2011-03-09 13:51:52 UTC (rev 22103) +++ trunk/dist/readme-ui.txt 2011-03-09 13:56:43 UTC (rev 22104) @@ -1,47 +1,185 @@ -RichFaces - Ajax enabled JSF 2.0 component library -========================================================= -Version 4.0.0.CR1 +======================================================================== -This software is distributed under the terms of the FSF Lesser Gnu Public License (see lgpl.txt). + RichFaces - Ajax enabled JSF 2.0 component library -Getting up and running quickly -------------------------------- + RichFaces 4.0.CR1 + http://www.jboss.org/richfaces + March 2011 + This software is distributed under the terms of the + FSF Lesser Gnu Public License (see lgpl.txt) -1) Put RichFaces libraries and its dependencies in your application libraries folder: - 1.1) richfaces-core-api.jar - 1.2) richfaces-core-impl.jar - 1.3) richfaces-components-api.jar - 1.4) richfaces-components-ui.jar - 1.5) sac-1.3, cssparser-0.9.5 - required for components CSS work - 1.6) google-guava-r08 - core runtime dependency. - 1.7) annotations.jar from org.richfaces.cdk - - It's optional and only needs to be added if RichFaces components will be - created/accessed dynamically in your apps actions/listeners. - 1.8) validation-api.jar and any implementation like hibernate-validators.jar - - It's optional and should be added if you using Client or Graph Validation. Should be added only if it's not provided by server(Java EE 6 servers) +======================================================================== -For optimal performance it's recommended to add one of these caching frameworks to application classpath: EhCache, JBoss Cache, OsCache. +RichFaces 4 is a component library for JSF2 and an advanced framework for +easily integrating AJAX capabilities into business applications. -2) As opposed to the previous 3.x.y versions of RichFaces, no special configuration steps are necessary. -You don't need to modify web.xml or faces-config.xml (except a4j:push component that requires additional configuration in web.xml; -please refer to the documentation) +This file explains how to obtain and install the RichFaces component +library. If you find any issue with the project, please report the issue +on the RichFaces user forum (http://community.jboss.org/en/richfaces) +or jira (https://issues.jboss.org/browse/RF). -3) Add RichFaces namespaces/taglibs declaration to your VDL/XHTML pages which will use RichFaces components - Use xmlns:a4j="http://richfaces.org/a4j" namespace for core components - Use xmlns:rich="http://richfaces.org/rich" namespace for rich components -4) Add one of the available RichFaces components to your page and try it! -4.1) Take a look at the RichFaces examples for assistance with usage. +FEATURES +-------- -For more information on getting started with, or without maven, take a look at wiki's Getting Started Guide. - - http://community.jboss.org/wiki/GettingstartedwithRichFaces4x + - 100+ AJAX enabled components in two libraries. + * a4j page centric AJAX controls. + * rich self contained, ready to use components. + - Whole set of JSF2 benefits while working with AJAX. + - Skinnability mechanism. + - Component Development Kit (CDK). + - Dynamic resource handling. + - Testing facilities for components, actions, listeners and pages + - Broad cross-browser support. + - Large and active community -Available Components/Behaviors/Tags/Functions ---------------------------------- +OBTAINING RICHFACES 4.X +----------------------- + + 1. Obtaining the latest stable distribution package + + You can download the distribution package directly from the RichFaces + project website at http://www.jboss.org/richfaces. Source code is also + available to download from the same site. + + +SETTING UP YOUR PROJECT +----------------------- + + 1. Manually + + After downloading the distribution package, extract its content in a + folder of your choice. + + Search for the 'artifacts' directory in the extracted files. There you + will find 'framework' and 'ui' directories, each of them having the + jars needed to use RichFaces inside your project. + + - From 'ui' directory: Copy richfaces-components-api-4.x.jar and + richfaces-components-ui-4.x.jar to your application libraries + folder. + + - From 'framerok' directory: Copy richfaces-core-api-4.x.jar and + richfaces-core-impl-4.x.jar to your application libraries folder. + + In addition to the RichFaces jars, a number of dependencies are + required in order to properly configure the framework. + + + a. sac-1.3, cssparser-0.9.5 - required for components CSS work. + + b. google-guava-r08 - core runtime dependency. + + c. annotations.jar - from org.richfaces.cdk. + + - It's optional and only needs to be added if RichFaces components + will be created/accessed dynamically in your apps actions/listeners. + + d. validation-api.jar and any implementation like hibernate-validators.jar + + - It's optional and should be added if you using Client or Graph + Validation. Should be added only if it's not provided by a + server (Java EE 6 servers). + + + 2. Using Maven + + To setup your project using Maven, follow the instruction on the wiki at + http://community.jboss.org/wiki/HowtoaddRichFaces4xtomavenbasedproject + + +For optimal performance it's recommended to add one of these caching frameworks +to application classpath: EhCache, JBoss Cache, OsCache. + + +GETTING STARTED +--------------- + +1. After setting up the project to use RichFaces component library, no + special configuration steps are necessary. You don't need to modify + web.xml or faces-config.xml as with previous versions of RichFaces, + except for a4j:push component that requires additional configuration + in web.xml + +2. Add RichFaces namespaces/taglibs declarations to your VDL/XHTML pages + which will use RichFaces components. + + - Use xmlns:a4j="http://richfaces.org/a4j" namespace for core components + - Use xmlns:rich="http://richfaces.org/rich" namespace for rich components + +3. Add on of the available RichFaces components to your page and try it! + Take a look at the RichFaces examples for assistance with usage. + +4. For more information on getting started with RichFaces, visit the wiki's + Getting Started Guide at http://community.jboss.org/wiki/GettingStartedWithRichFaces4x + + + +MORE INFORMATION AND RESOURCES +------------------------------ + +For more information on RichFaces 4 features, how to migrate from +previous versions, and answers to the most frequently asked questions (FAQ), +please visit RichFaces website at: + +http://www.jboss.org/richfaces. + +Or the Wiki at: + + - http://community.jboss.org/wiki/richfaceswikihomepage + +To report or check the status of issues related to RichFaces use the +project's Jira at: + + - https://issues.jboss.org/browse/RF + +Community support and help can be obtained from the RichFaces forums at: + + - http://community.jboss.org/en/richfaces?view=discussions + +Also you can follow us on Twitter at: + + - http://twitter.com/richfaces + + +FUTURE RELEASES +--------------- + +For information on future releases and new features that are planned for next +version please visit project's wiki at: +http://www.jboss.org/community/wiki/RichFaces40Planning + + +GET INVOLVED +------------ + +RichFaces is an Open Source project built by people across the globe. +If you want to help create the next version of RichFaces take a look at +this sites + + - RichFaces source code: + http://www.jboss.org/richfaces/sourcecode + + - How to build RichFaces 4.0: + http://community.jboss.org/docs/DOC-15747?uniqueTitle=false + + - RichFaces 4.0 Directory structure: + http://community.jboss.org/wiki/RichFaces40BuildDirectoryStructure + + - RichFaces developer forums + http://community.jboss.org/en/richfaces/dev?view=discussions + + - RichFaces Planning (Jira): + https://issues.jboss.org/browse/RFPL + +We hope to see your contributions! + + +AVAILABLE COMPONENTS/BEHAVIORS/TAGS/FUNCTIONS +--------------------------------------------- Core: ---------------------------------- - +--------------------------------------------- a4j:ajax a4j:commandLink a4j:commandButton @@ -153,7 +291,52 @@ rich:validator rich:graphValidator -Learn more ----------- -RichFaces Project - http://www.jboss.org/richfaces -RichFaces 4.0 Wiki - http://www.jboss.org/community/wiki/RichFaces40Planning + +New in Version 4.0.CR1 +---------------------- + + - Finally completed with Taglib's corrections for better IDE support + https://issues.jboss.org/browse/RF-9936 + - Stabilized CSV feature with messages, localization and customization + improvements https://issues.jboss.org/browse/RF-10556 + https://issues.jboss.org/browse/RF-10434 https://issues.jboss.org/browse/RF-10611 + - Stabilized messages components https://issues.jboss.org/browse/RF-10293 + https://issues.jboss.org/browse/RF-10370 + - A lots of stabilization issues resolved for Switchable Panels and + Panel Menu + - Important push problems solved https://issues.jboss.org/browse/RF-10457 + https://issues.jboss.org/browse/RF-10473 https://issues.jboss.org/browse/RF-10487 + and more customization options added https://issues.jboss.org/browse/RF-10454 + - A lot of stabilization issues for MyFaces support got resolved + - Environment updates: JQuery 1.5, MyFaces 2.0.4, Mojara 2.0.4, Atmosphere 0.6.4 + - RichFaces showcase has been updated with new design (https://issues.jboss.org/browse/RF-9636) + and now runs under myFaces stable! + + +New in Version 4.0.M6 +--------------------- + + - Client Side Validation feature is ready!! All the standard JSF + and most of the JSR-303 validators are available on the client by using + just <rich:validator> behavior! We will post detailed blog with examples + in a few days. + - ObjectValidation feature also was finalized and allows you to validate + complete objects and dependent fields by just using JSR-303 validators + and the <rich:graphValidator> component. This will also be covered in an + up coming blog. + - The Ajax framework is improved and now provides ignoreDupResponce core + feature! Together with queue it adds great optimization to your Ajax'ififed + pages. + - All the richfaces components client side API are reviewed and stabilized. + API Tables will be documented soon in the component reference. + - Further review and corrections in components for improving IDE's support. + - richfaces-showcase demo application is updated with new showcases for + validation components and new examples for previously released components. + - Further improvements in Component Development Kit. + - Stabilization works for migrated code. Automation tests with quint, junit. + Review of attributes and facets for consistency and stability are done + and most issues get fixed. + + + +###