[richfaces-svn-commits] JBoss Rich Faces SVN: r18485 - in branches/development/docs/Component_Reference: src/main/docbook/en-US and 1 other directory.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Wed Aug 4 23:56:31 EDT 2010 

Author: SeanRogers
Date: 2010-08-04 23:56:31 -0400 (Wed, 04 Aug 2010)
New Revision: 18485

Added:
   branches/development/docs/Component_Reference/Component_Reference_chapters.txt
Modified:
   branches/development/docs/Component_Reference/src/main/docbook/en-US/Component_Reference.xml
   branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml
   branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml
   branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml
   branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
Log:
Updating components that are present for M2

Added: branches/development/docs/Component_Reference/Component_Reference_chapters.txt
===================================================================
--- branches/development/docs/Component_Reference/Component_Reference_chapters.txt	                        (rev 0)
+++ branches/development/docs/Component_Reference/Component_Reference_chapters.txt	2010-08-05 03:56:31 UTC (rev 18485)
@@ -0,0 +1,137 @@
+a4j tag library
+
+- chap-Component_Reference-Actions
+-- a4j:actionParam
+x- a4j:ajaxListener
+-- a4j:commandButton
+-- a4j:commandLink
+-- rich:componentControl
+xx a4j:hashParam
+x- a4j:htmlCommandLink
+-- a4j:jsFunction
+-- a4j:poll
+-- a4j:push
+-- a4j:ajax
+
+- chap-Component_Reference-Resources
+x- a4j:loadBundle
+x- a4j:loadScript
+x- a4j:loadStyle
+-- a4j:keepAlive
+x- a4j:mediaOutput
+
+- chap-Component_Reference-Containers
+x- a4j:form
+-- a4j:include
+-- a4j:outputPanel
+x- a4j:page
+-- a4j:region
+
+- chap-Component_Reference-Validation
+-- rich:ajaxValidator
+-- rich:ajaxValidator
+-- rich:beanValidator
+
+- chap-Component_Reference-Processing_management
+-- a4j:queue
+-- a4j:log
+-- a4j:status
+
+
+rich tag library
+
+- chap-Component_Reference-Rich_inputs
+x- rich:calendar
+x- rich:colorPicker
+x- rich:comboBox
+xx rich:editor
+x- rich:fileUpload
+-- rich:inplaceInput
+-- rich:inplaceSelect
+-- rich:inputNumberSlider
+x- rich:inputNumberSpinner
+x- rich:suggestionBox
+
+- chap-Component_Reference-Panels_and_containers
+x- rich:modalPanel
+xx rich:panel
+xx rich:panelBar
+xx rich:panelBarItem
+x- rich:simpleTogglePanel
+-- rich:tabPanel
+x- rich:tab
+-- rich:togglePanel
+x- rich:toggleControl
+
+- chap-Component_Reference-Tables_and_grids
+-- a4j:repeat
+-- rich:column
+-- rich:columnGroup
+-- rich:columns
+x- rich:dataDefinitionList
+x- rich:dataFilterSlider
+-- rich:dataGrid
+x- rich:dataList
+x- rich:dataOrderedList
+xx rich:dataScroller
+-- rich:dataTable
+-- rich:extendedDataTable
+xx rich:subTable
+-x Table filtering
+-x Table sorting
+
+x chap-Component_Reference-Trees
+xx rich:changeExpandListener
+xx rich:nodeSelectListener
+xx rich:recursiveTreeNodesAdapter
+xx rich:tree
+xx rich:treeNode
+xx rich:treeNodesAdapter
+
+x chap-Component_Reference-Menus_and_toolbars
+xx rich:contextMenu
+xx rich:dropDownMenu
+xx rich:menuGroup
+xx rich:menuItem
+xx rich:menuSeparator
+x- rich:panelMenu
+x- rich:panelMenuGroup
+x- rich:panelMenuItem
+xx rich:toolBar
+xx rich:toolBarGroup
+
+x chap-Component_Reference-Output_and_messages
+x- rich:message
+x- rich:messages
+xx rich:paint2D
+xx rich:progressBar
+xx rich:toolTip
+
+x chap-Component_Reference-Drag_and_drop
+xx rich:dragIndicator
+xx rich:dragSupport
+xx rich:dropSupport
+xx rich:dragListener
+xx rich:dropListener
+xx rich:dndParam
+
+x chap-Component_Reference-Layout_and_appearance
+xx rich:effect
+xx rich:jQuery
+xx rich:separator
+xx rich:spacer
+xx rich:page
+xx rich:layout
+xx rich:layoutPanel
+
+- chap-Component_Reference-Functions
+-- rich:clientId
+-- rich:component
+-- rich:element
+-- rich:findComponent
+-- rich:isUserInRole
+
+x chap-Component_Reference-Functionality_extension
+xx rich:gmap
+xx rich:hotkey
+xx rich:virtualEarth

Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/Component_Reference.xml
===================================================================
--- branches/development/docs/Component_Reference/src/main/docbook/en-US/Component_Reference.xml	2010-08-04 21:10:26 UTC (rev 18484)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/Component_Reference.xml	2010-08-05 03:56:31 UTC (rev 18485)
@@ -5,7 +5,8 @@
 	<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 	<!--                    
 	<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
-	                    --><xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+	-->
+	<xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 	<xi:include href="chap-Component_Reference-Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 	<xi:include href="chap-Component_Reference-Common_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 	<part id="part-Component_Reference-a4j_tag_library">
@@ -18,10 +19,9 @@
 	</part>
 	<part id="part-Component_Reference-rich_tag_library">
 		<title>rich tag library</title>
-		<!--  
 		<xi:include href="chap-Component_Reference-Rich_inputs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		<xi:include href="chap-Component_Reference-Panels_and_containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-		 --><xi:include href="chap-Component_Reference-Tables_and_grids.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+		<xi:include href="chap-Component_Reference-Tables_and_grids.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		<!-- 
 		<xi:include href="chap-Component_Reference-Trees.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		<xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml
===================================================================
--- branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml	2010-08-04 21:10:26 UTC (rev 18484)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml	2010-08-05 03:56:31 UTC (rev 18485)
@@ -6,7 +6,8 @@
 	<para>
 		This chapter details those components in the <classname>a4j</classname> tag library which define an area used as a container or wrapper for other components.
 	</para>
-	<!--  FIXME NOT IN M2  -->
+	
+	<!-- TODO not in M2 -->
 	<!--
 	<section id="sect-Component_Reference-Containers-a4jform">
 		<title><sgmltag>&lt;a4j:form&gt;</sgmltag></title>
@@ -164,7 +165,7 @@
 		</para>
 	</section>
 	
-	<!--  FIXME not in M2  -->
+	<!-- TODO not in M2 -->
 	<!--
 	<section id="sect-Component_Reference-Containers-a4jpage">
 		<title><sgmltag>&lt;a4j:page&gt;</sgmltag></title>

Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml
===================================================================
--- branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml	2010-08-04 21:10:26 UTC (rev 18484)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml	2010-08-05 03:56:31 UTC (rev 18485)
@@ -3,9 +3,19 @@
 ]>
 <chapter id="chap-Component_Reference-Panels_and_containers">
 	<title>Panels and containers</title>
+	<!--  In development notification  -->
+	<important>
+		<title>Documentation in development</title>
+		<para>
+			Some concepts covered in this chapter may refer to the previous version of <productname>Richfaces</productname>, version 3.3.3. This chapter is scheduled for review to ensure all information is up to date.
+		</para>
+	</important>
 	<para>
 		This chapter details those components which act as panels and containers to hold groups of other components.
 	</para>
+	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richmodalPanel">
 		<title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title>
 		<para>
@@ -36,7 +46,10 @@
 </programlisting>
 		</example>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richpanel">
 		<title><sgmltag>&lt;rich:panel&gt;</sgmltag></title>
 		<para>
@@ -46,14 +59,20 @@
 			No attributes need to be listed for basic usage. To add a header to the panel, use the <code>header</code> attribute to specify the text to appear in the header. Alternatively the header can be constructed using a header facet.
 		</para>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richpanelBar">
 		<title><sgmltag>&lt;rich:panelBar&gt;</sgmltag></title>
 		<para>
 			The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Another name for the component is "accordion". Each panel in contained in a <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is a <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component.
 		</para>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem">
 		<title><sgmltag>&lt;rich:panelBarItem&gt;</sgmltag></title>
 		<para>
@@ -96,6 +115,7 @@
 			The <code>openMarker</code> and <code>closeMarker</code> attributes can be used to define custom icons for the expanding header.
 		</para>
 	</section>
+	-->
 	
 	<section id="sect-Component_Reference-Panels_and_containers-richtabPanel">
 		<title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag></title>
@@ -136,6 +156,8 @@
 		</para>
 	</section>
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richtab">
 		<title><sgmltag>&lt;rich:tab&gt;</sgmltag></title>
 		<para>
@@ -154,6 +176,7 @@
 			There are two event handlers that are unique to the <sgmltag>&lt;rich:tab&gt;</sgmltag> component. The <code>ontabenter</code> attribute points to the function to perform when the mouse enters the tab, while the <code>ontableave</code> attribute points to the function to perform when the mouse leaves the tab.
 		</para>
 	</section>
+	-->
 	
 	<section id="sect-Component_Reference-Panels_and_containers-richtogglePanel">
 		<title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag></title>
@@ -186,6 +209,8 @@
 		</example>
 	</section>
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Panels_and_containers-richtoggleControl">
 		<title><sgmltag>&lt;rich:toggleControl&gt;</sgmltag></title>
 		<para>
@@ -226,6 +251,7 @@
 </programlisting>
 		</example>
 	</section>
+	-->
 
 </chapter>
 

Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml
===================================================================
--- branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml	2010-08-04 21:10:26 UTC (rev 18484)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml	2010-08-05 03:56:31 UTC (rev 18485)
@@ -7,7 +7,7 @@
 		This chapter covers those components used to handle and manage resources and beans.
 	</para>
 	
-	<!-- FIXME not in M2  -->
+	<!-- TODO not in M2 -->
 	<!--
 	<section id="sect-Component_Reference-Resources-a4jloadBundle">
 		<title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag></title>
@@ -106,7 +106,10 @@
 			</para>
 		</example>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Resources-a4jloadScript">
 		<title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag></title>
 		<itemizedlist>
@@ -145,7 +148,10 @@
 </programlisting>
 		</example>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Resources-a4jloadStyle">
 		<title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag></title>
 		<itemizedlist>
@@ -223,6 +229,8 @@
 		</example>
 	</section>
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Resources-a4jmediaOutput">
 		<title><sgmltag>&lt;a4j:mediaOutput&gt;</sgmltag></title>
 		<itemizedlist>
@@ -337,6 +345,7 @@
 			</para>
 		</note>
 	</section>
+	-->
 
 </chapter>
 

Modified: branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
===================================================================
--- branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml	2010-08-04 21:10:26 UTC (rev 18484)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml	2010-08-05 03:56:31 UTC (rev 18485)
@@ -3,11 +3,24 @@
 ]>
 <chapter id="chap-Component_Reference-Rich_inputs">
 	<title>Rich inputs</title>
+	<!--  In development notification  -->
+	<important>
+		<title>Documentation in development</title>
+		<para>
+			Some concepts covered in this chapter may refer to the previous version of <productname>Richfaces</productname>, version 3.3.3. This chapter is scheduled for review to ensure all information is up to date.
+		</para>
+	</important>
 	<para>
+		This chapter details those components which act as panels and containers to hold groups of other components.
+	</para>
+	
+	<!-- TODO not in M2 -->
+	<!--
+	<para>
 		This chapter details rich components for user input and interaction.
 	</para>
-	<section id="sect-Component_Reference-Rich_inputs-richCalendar">
-		<title><sgmltag>&lt;rich:Calendar&gt;</sgmltag></title>
+	<section id="sect-Component_Reference-Rich_inputs-richcalendar">
+		<title><sgmltag>&lt;rich:calendar&gt;</sgmltag></title>
 		<para>
 			The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component allows the user to enter a date and time through an in-line or pop-up calendar. The pop-up calendar can navigate through months and years, and its look and feel can be highly customized.
 		</para>
@@ -82,7 +95,10 @@
 			The entire calendar can be set as read-only with <code>readonly="true"</code>. This allows months and years to be browsed through with the arrow controls, but dates and times cannot be selected.
 		</para>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Rich_inputs-richcolorPicker">
 		<title><sgmltag>&lt;rich:colorPicker&gt;</sgmltag></title>
 		<para>
@@ -158,7 +174,10 @@
 			</listitem>
 		</itemizedlist>
 	</section>
+	-->
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Rich_inputs-richeditor">
 		<title><sgmltag>&lt;rich:editor&gt;</sgmltag></title>
 		<para>
@@ -247,6 +266,7 @@
 			</listitem>
 		</itemizedlist>
 	</section>
+	-->
 	
 	<section id="sect-Component_Reference-Rich_inputs-richinplaceInput">
 		<title><sgmltag>&lt;rich:inplaceInput&gt;</sgmltag></title>
@@ -362,6 +382,8 @@
 		</para>
 	</section>
 	
+	<!-- TODO not in M2 -->
+	<!--
 	<section id="sect-Component_Reference-Rich_inputs-richinputNumberSpinner">
 		<title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title>
 		<para>
@@ -399,6 +421,7 @@
 			Instead of returning just one value from an object, the entire object can be returned to the client and handled appropriately. This is done by specifying <code>usingSuggestObjects="true"</code> and setting the <varname>onobjectchange</varname> attribute to a JavaScript method to handle the object, passing the <literal>suggestion</literal> object as a parameter.
 		</para>
 	</section>
+	-->
 
 </chapter>

More information about the richfaces-svn-commits mailing list