Documentation

As an open source project we do our best to provide documentation for our project and to make it as rich and usefull as RichFaces itself.  Please let us know if there are issues, or incomplete items in the documentation via our user forum, or project jira.

Here are the list of current documentation packs availalble:

RichFaces Reference Guides

RichFaces 4.3.1.Final Development Guide

• Single HTML version
• Linked multiple HTML files
• As a PDF

RichFaces 4.3.1.Final Component Reference

• Single HTML version
• Linked multiple HTML files
• As a PDF

RichFaces 3.3.3.Final

• Single HTML version
• Linked multiple HTML files
• As a PDF

Generated Documentation

RichFaces 4.3.1.Final

• VDL documentation
• JavaDoc's:
  • Framework API
  • Framework Impl
  • Components API
  • Components Impl

Note:

JavaScript documentation still available only in Final release distribution. But we will work to get it live as soon as possible!

RichFaces 3.3.3.Final

• TLD Docs
• Components API Docs
• Framework API Docs

 

RichFaces CDK References

RichFaces CDK 4.3 Wiki documentation

• Richfaces 4.3 Components Development Kit

RichFaces CDK 4.3 generated documentation.

• CDK tags documentation

Note:

We are going to be providing updated comprehensive CDK documentation as soon as possible.

RichFaces 4.3 CDK External Resources

A CDK guide started by Bernard Labno is available in draft form here as a Google document.  We plan to integrate this information into the community wiki, and docs.  Many thanks to Bernard for his great efforts!

RichFaces CDK 3.3.3.Final

• Single HTML version
• Linked multiple HTML files
• As a PDF

Migration Guides

RichFaces 4.x

• Wiki based "RichFaces Migration Guide. 3.3.x - 4.x Migration"

RichFaces 3.x

• Single HTML version
• Linked multiple HTML files
• As a PDF

 

Photo Album Application Guide (3.3.2 SR1)

• Single HTML version
• As linked multiple HTML files
• As a PDF

Wiki documentation

• Wiki FAQ
• Knowledgebase
• RichFaces & JSF Presentations page