[richfaces-svn-commits] JBoss Rich Faces SVN: r18610 - branches/development/docs/Component_Reference/src/main/docbook/en-US.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Fri Aug 13 02:16:59 EDT 2010 

Author: SeanRogers
Date: 2010-08-13 02:16:59 -0400 (Fri, 13 Aug 2010)
New Revision: 18610

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-Panels_and_containers.xml
Log:
Reorganised Panels chapter

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-13 04:40:21 UTC (rev 18609)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/Component_Reference.xml	2010-08-13 06:16:59 UTC (rev 18610)
@@ -27,8 +27,9 @@
 		<xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
         <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		<xi:include href="chap-Component_Reference-Drag_and_drop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+		-->
 		<xi:include href="chap-Component_Reference-Layout_and_appearance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-		 --><xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+		<xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		<!--  
 		<xi:include href="chap-Component_Reference-Functionality_extension.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 		 -->

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-13 04:40:21 UTC (rev 18609)
+++ branches/development/docs/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml	2010-08-13 06:16:59 UTC (rev 18610)
@@ -119,33 +119,6 @@
 	
 	<section id="sect-Component_Reference-Panels_and_containers-richtabPanel">
 		<title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag></title>
-		<itemizedlist>
-			<listitem>
-				<para>
-					<parameter>component-type</parameter>: <classname>org.richfaces.tabPanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmltabPanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>component-family</parameter>: <classname>org.richfaces.tabPanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>renderer-type</parameter>: <classname>org.richfaces.tabPanelRenderer</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabPanelTag</classname>
-				</para>
-			</listitem>
-		</itemizedlist>
 		<para>
 			The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component provides a set of tabbed panels for displaying one panel of content at a time. The tabs can be highly customized and themed.
 		</para>
@@ -155,32 +128,70 @@
 				All <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components should be wrapped in a form element so that content is correctly submitted.
 			</para>
 		</note>
-		<para>
-			The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values:
-		</para>
-		<itemizedlist>
-			<listitem>
-				<para>
-					<literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side.
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<literal>ajax</literal>, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side.
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<literal>client</literal>, which causes <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute.
-				</para>
-			</listitem>
-		</itemizedlist>
-		<para>
-			The <code>selectedTab</code> attribute holds the active tab name.
-		</para>
-		<para>
-			The tabs themselves can be aligned using the <code>headerAlignment</code> attribute. The attribute can be set to <code>left</code>, <code>center</code>, or <code>right</code>, aligning the header tabs to the left, center, or right of the top edge of the panel respectively. If no alignment is specified, left-alignment is the default behavior.
-		</para>
+		<section id="sect-Component_Reference-richtabPanel-Basic_usage">
+			<title>Basic usage</title>
+			<para>
+				The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values:
+			</para>
+			<itemizedlist>
+				<listitem>
+					<para>
+						<literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side.
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<literal>ajax</literal>, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side.
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<literal>client</literal>, which causes <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute.
+					</para>
+				</listitem>
+			</itemizedlist>
+			<para>
+				The <code>selectedTab</code> attribute holds the active tab name.
+			</para>
+		</section>
+		
+		<section id="sect-Component_Reference-richtabPanel-Tab_alignment">
+			<title>Tab alignment</title>
+			<para>
+				The tabs themselves can be aligned using the <code>headerAlignment</code> attribute. The attribute can be set to <code>left</code>, <code>center</code>, or <code>right</code>, aligning the header tabs to the left, center, or right of the top edge of the panel respectively. If no alignment is specified, left-alignment is the default behavior.
+			</para>
+		</section>
+		
+		<section id="sect-Component_Reference-richtabPanel-Reference_data">
+			<title>Reference data</title>
+			<itemizedlist>
+				<listitem>
+					<para>
+						<parameter>component-type</parameter>: <classname>org.richfaces.tabPanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmltabPanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-family</parameter>: <classname>org.richfaces.tabPanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>renderer-type</parameter>: <classname>org.richfaces.tabPanelRenderer</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabPanelTag</classname>
+					</para>
+				</listitem>
+			</itemizedlist>
+		</section>
 	</section>
 	
 	<!-- TODO not in M2 -->
@@ -207,60 +218,65 @@
 	
 	<section id="sect-Component_Reference-Panels_and_containers-richtogglePanel">
 		<title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag></title>
-		<itemizedlist>
-			<listitem>
-				<para>
-					<parameter>component-type</parameter>: <classname>org.richfaces.TogglePanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTogglePanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>component-family</parameter>: <classname>org.richfaces.TogglePanel</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>renderer-type</parameter>: <classname>org.richfaces.TogglePanelRenderer</classname>
-				</para>
-			</listitem>
-			<listitem>
-				<para>
-					<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.TogglePanelTag</classname>
-				</para>
-			</listitem>
-		</itemizedlist>
 		<para>
 			The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component is a wrapper component with named facets. Each facet is displayed after activating a corresponding <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component.
 		</para>
-		<para>
-			The initial state of the component can be configured using the <code>initialState</code> attribute, which points to a facet name to display. Alternatively, setting <code>initialState="empty"</code>, the initial state will be blank until the user selects an option.
-		</para>
-		<para>
-			The order in which the facets are shown can be defined using the <code>statusOrder</code> attribute, listing the facet names separated by commas, as shown in <xref linkend="exam-Component_Reference-richtogglePanel-State_order_example" />.
-		</para>
-		<example id="exam-Component_Reference-richtogglePanel-State_order_example">
-			<title>State order example</title>
-			
-<programlisting language="XML" role="XML">
-&lt;rich:togglePanel id="panel" initialState="panelB" switchType="client" stateOrder="panelA,panelB,panelC"&gt;
-  &lt;f:facet name="panelA"&gt;
-    ...
-  &lt;/f:facet&gt;
-  &lt;f:facet name="panelB"&gt;
-    ...
-  &lt;/f:facet&gt;
-  &lt;f:facet name="panelC"&gt;
-    ...
-  &lt;/f:facet&gt;
-&lt;/rich:togglePanel&gt; 
-&lt;rich:toggleControl for="panel" value="Switch"/&gt;
-</programlisting>
-		</example>
+		
+		<section id="sect-Component_Reference-richtogglePanel-Basic_usage">
+			<title>Basic usage</title>
+			<para>
+				The initial state of the component can be configured using the <code>initialState</code> attribute, which points to a facet name to display. Alternatively, setting <code>initialState="empty"</code>, the initial state will be blank until the user selects an option.
+			</para>
+			<para>
+				The order in which the facets are shown can be defined using the <code>statusOrder</code> attribute, listing the facet names separated by commas, as shown in <xref linkend="exam-Component_Reference-richtogglePanel-State_order_example" />.
+			</para>
+			<example id="exam-Component_Reference-richtogglePanel-State_order_example">
+				<title>State order example</title>
+				<programlisting language="XML" role="XML">&lt;rich:togglePanel id="panel" initialState="panelB" switchType="client" stateOrder="panelA,panelB,panelC"&gt;
+	  &lt;f:facet name="panelA"&gt;
+		...
+	  &lt;/f:facet&gt;
+	  &lt;f:facet name="panelB"&gt;
+		...
+	  &lt;/f:facet&gt;
+	  &lt;f:facet name="panelC"&gt;
+		...
+	  &lt;/f:facet&gt;
+	&lt;/rich:togglePanel&gt; 
+	&lt;rich:toggleControl for="panel" value="Switch"/&gt;</programlisting>
+			</example>
+		</section>
+		
+		<section id="sect-Component_Reference-richtogglePanel-Reference_data">
+			<title>Reference data</title>
+			<itemizedlist>
+				<listitem>
+					<para>
+						<parameter>component-type</parameter>: <classname>org.richfaces.TogglePanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTogglePanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>component-family</parameter>: <classname>org.richfaces.TogglePanel</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>renderer-type</parameter>: <classname>org.richfaces.TogglePanelRenderer</classname>
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						<parameter>tag-class</parameter>: <classname>org.richfaces.taglib.TogglePanelTag</classname>
+					</para>
+				</listitem>
+			</itemizedlist>
+		</section>
 	</section>
 	
 	<!-- TODO not in M2 -->

More information about the richfaces-svn-commits mailing list