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.5.x.Final Development Guide

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

RichFaces 4.5.x.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.5.x.Final

• VDL documentation
• JavaDoc
• JsDoc (incomplete)
• RichFaces Resources Maven Plugin

RichFaces 3.3.3.Final

• TLD Docs
• Components API Docs
• Framework API Docs

RichFaces CDK References

RichFaces CDK 4.5 Wiki documentation

• Richfaces 4.5 Components Development Kit

RichFaces CDK 4.5 generated documentation.

• CDK tags documentation

RichFaces 4.5 CDK External Resources

• A CDK guide by Bernard Labno is available. 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

• RichFaces 4.3 to 4.5 Migration Guide
• 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