RichFaces 4.0 Docs Content Specifications

Version 10

    RichFaces Documentation Plan


    Phase 2: Content Specifications

    Migrating to RichFaces 4.0

    References:

    Product Description

    The Migration Guide describes how to take an existing RichFaces project and upgrade it to use RichFaces 4.0. It details changes in component usage and behaviours, and any other changes to the framework that may affect an existing RichFaces project.

    Usability Goals

    Developers who are familiar with previous versions of RichFaces need to easily discover what has changed and what they are required to do to get their projects working with the new RichFaces library. New-comers to RichFaces will have little or no use for this book.

    Audience Profile

    The audience will have used a previous version of RichFaces, so will most likely be familiar with basic concepts. They will primarily be concerned with how to switch their existing projects to using the new RichFaces framework.

    Objectives

    The book must accomplish the following:

    • explain how to upgrade
    • detail any changes so necessary adjustments can be made to accommodate the new version
    • describe any potential issues with migrating

    Content and Metrics

    ChapterSectionGraphicsPagesProgressNotes
    Introduction-1
    UpgradingBefore upgrading-1
    Installation-2Refers to Developer Guide
    Changes and new featuresDependencies-2Possibly have example application
    JSF 2.0 Integration-2
    Standardized naming-2
    Performance-2
    New features-2
    New components-2a4j:ajax
    Deprecated features-2
    Deprecated components-2a4j:support, a4j:page
    Other changes-2

    Developer Guide

    References:

    Product Description

    The Developer Guide gives a complete reference for getting started and working with RichFaces. This includes details of the architecture and framework, use in different environments and applications, and skinning implementation.

    Usability Goals

    Using the Developer Guide, the reader must be able to confidently work with all the RichFaces components and features. They should be able to use the book to go from being a novice to using advanced elements of the framework, and they must have a comprehensive understanding of how RichFaces works and how it can be useful for their projects.

    Audience Profile

    Developers are the typical audience for the book. Novice RichFaces developers will make up the bulk of this, since most of the information the veteran developers require is in the migration guide, but the more advanced sections of the book will be relevant to all levels of experience.

    Objectives

    A developer must be able to go from installation through to publishing a project from scratch using the book.

    Content and Metrics

    ChapterSectionGraphicsPagesProgressNotes
    Introduction-1
    Getting started with RichFacesTechnical requirements-1
    Installing RichFaces-1
    Configuration-2includes settings for different environments
    Creating a project-2
    RichFaces overviewArchitecture32
    Technologies-2Ajax, JSP, EL, compatibility matrix
    Differences between JSF and RichFaces mechanisms1
    Restrictions-1
    Using RichFaces with Maven-1Including Maven dependency plug-in
    Using RichFaces in existing JSF projects-2
    Basic conceptsSending an Ajax request-2
    Receiving events and updates-2
    Ajax attributes-2
    Ajax containers-2
    Component overview-1refers to Component Guide
    Advanced featuresAdditions to JSF2-2
    Performance optimization-2bypassUpdates
    Traffic control and queues-2
    Validation-3
    Filters-2
    Scripts and styles-2
    Error handling-2
    Managing states-2
    User roles-2
    Skinning and themingWhat are skins and themes?-1
    Using skins-2includes standard control skinning
    Customizing skins-2includes plug-n-skin
    Changing skins at runtime-1
    Extended skinnability-2includes client-side script and XCSS
    Appendix AResources-1

    Component Guide

    References:

    Product Description

    The Component Guide lists each component and object in the RichFaces library, including details on methods, properties, and relationships to other objects and classes.

    Usability Goals

    The Component Guide needs to be an easier to read than the API Reference, and provides more of an practical explanation for each component in the framework. It will describe when it is best to use each component and how best to use them, as well as example code and screenshots to illustrate their use. It can also potentially be used as a 'catalogue' of components for designing user experiences.

    Audience Profile

    The audience for this book is similar to that for the Developer Guide: mostly novice developers learning their way through the framework. Experienced developers may also use it to become more familiar with the components. User experience designers looking for the most appropriate components will also find the book helpful.

    Objectives

    The Component Guide needs to provide a thorough description on the use of each component in the framework, providing a more reader-oriented reference than the API Reference pages.

    Content and Metrics

    ChapterSectionGraphicsPagesProgressNotes
    Introduction
    1
    Common Ajax attributesRendering
    1
    Queuing and traffic control
    1
    Data processing
    1
    Action and navigation
    1
    Events and JavaScript interactions
    1
    Common features3
    a4j actions
    Actionsa4j:actionparam11
    a4j:ajax (a4j:support)11
    a4j:ajaxListener11
    a4j:commandButton11
    a4j:commandLink11
    a4j:htmlCommandLink11
    a4j:jsFunction11
    a4j:poll11
    a4j:push11
    Resourcesa4j:loadBundle11
    a4j:loadStyle11
    a4j:loadScript11
    a4j:keepAlive11
    a4j:mediaOutput11
    Containersa4j:form11
    a4j:include11
    a4j:outputpanel11
    a4j:region11
    Validationrich:ajaxValidator11


    rich:graphValidator11
    rich:beanValidator11
    Processing managementa4j:queue11
    a4j:log11
    a4j:status11
    a4j:portlet11
    rich tag library
    Rich inputsrich:calendar11
    rich:colorPicker11
    rich:comboBox11
    rich:editor11
    rich:fileUpload11
    rich:inplaceInput11
    rich:inplaceSelect11
    rich:inputNumberSlider11
    rich:inputNumberSpinner11
    rich:suggestionBox11
    Panels and containersrich:modalPanel11
    rich:panel11
    rich:panelBar11
    rich:panelBarItem11
    rich:simpleTogglePanel11
    rich:tabPanel11
    rich:tab11
    rich:togglePanel11
    rich:toggleControl11
    Tables, grids, and listsrich:column11
    rich:columnGroup11
    rich:columns11
    rich:dataDefinitionList11
    rich:dataFilterSlider11
    rich:dataGrid11
    rich:dataList11
    rich:dataOrderingList11
    rich:dataScroller11
    rich:dataTable11
    rich:extendedDataTable11
    rich:repeat11
    rich:subTable11
    table filtering11
    table sorting11
    Selection and orderingrich:listShuttle11
    rich:orderingList11
    rich:pickList11
    Treesrich:changeExpandListener11
    rich:nodeSelectListener11
    rich:recursiveTreeNodesAdapter11
    rich:tree11
    rich:treeNode11
    rich:treeNodesAdapter11
    Menus and toolbarsrich:contextMenu11
    rich:dropDownMenu11
    rich:menuGroup11
    rich:menuItem11
    rich:menuSeparator11
    rich:panelMenu11
    rich:panelMenuGroup-1
    rich:panelMenuItem-1
    rich:toolBar11
    rich:toolBarGroup11
    Output and messagesrich:message11
    rich:messages-1
    rich:paint2D11
    rich:progressBar11
    rich:toolTip11
    Drag and droprich:dragIndicator11
    rich:dragSupport11
    rich:dropSupport11
    rich:dragListener-1
    rich:dropListener-1
    rich:dndParam-1
    Layout and appearancerich:effect11
    rich:jQuery11
    rich:separator11
    rich:spacer11
    rich:page-1
    rich:layout11
    rich:layoutPanel-1
    Functionsrich:clientID11
    rich:component11
    rich:element11
    rich:findComponent11
    rich:isUserInRole11
    Functionality expansionrich:componentControl11

    rich:gmap11
    rich:hotKey-1
    rich:virtualEarth11
    Totals99108

    Component Development Kit Guide

    References:

    Product Description

    The Component Development Kit Guide details how to use the Component Development Kit to create custom components for use with the RichFaces library.

    Usability Goals

    Readers must be able to use the Component Development Kit Guide to create custom components suited to their purposes. Examples and illustrations will be needed to guide the reader through the process.

    Audience Profile

    The audience is those developers who wish to expand on the library of existing RichFaces components by creating custom components and features.

    Objectives

    The reader must be able to build a customized component from scratch and include it in their RichFaces projects.

    Content and Metrics

    ChapterSectionGraphicsPagesProgressNotes
    Introduction-1
    Configuration-1
    Creating a new componentCreating a project-1
    Building a component skeleton-1
    Creating the UI22
    Registering resources-1
    Extending the UIInput class-1
    Configuring the component-1
    Tags and descriptors-1
    Using components in projects-1
    Developer sample-1
    Unit testing-1
    Creating components in other IDEs41
    Appendix ANaming conventions-1
    Appendix BTemplate tags reference-1

     

    Revised Project Plan

    Revisions have been made to the original RichFaces 4.0 Docs Information Plan.