From richfaces-svn-commits at lists.jboss.org Tue Dec 22 00:18:46 2009
Content-Type: multipart/mixed; boundary="===============3555829005539253893=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r16185 -
 root/docs/trunk/Component_Reference/en-US.
Date: Tue, 22 Dec 2009 00:18:46 -0500
Message-ID: <200912220518.nBM5Ik2r015280@svn01.web.mwc.hst.phx2.redhat.com>

--===============3555829005539253893==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: SeanRogers
Date: 2009-12-22 00:18:46 -0500 (Tue, 22 Dec 2009)
New Revision: 16185

Modified:
   root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Conta=
iners.xml
Log:
Finished Containers

Modified: root/docs/trunk/Component_Reference/en-US/chap-Component_Referenc=
e-Containers.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Cont=
ainers.xml	2009-12-22 01:35:19 UTC (rev 16184)
+++ root/docs/trunk/Component_Reference/en-US/chap-Component_Reference-Cont=
ainers.xml	2009-12-22 05:18:46 UTC (rev 16185)
@@ -33,9 +33,55 @@
 	=

 	<section id=3D"sect-Component_Reference-Containers-a4jinclude">
 		<title>a4j:include</title>
+		<itemizedlist>
+			<listitem>
+				<para>
+					component-type: <classname>org.ajax4jsf.Include</classname>
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					component-family: <classname>javax.faces.Output</classname>
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					component-class: <classname>org.ajax4jsf.component.html.Include</clas=
sname>
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					renderer-type: <classname>org.ajax4jsf.components.AjaxIncludeRenderer=
</classname>
+				</para>
+			</listitem>
+		</itemizedlist>
 		<para>
-			Incomplete
+			The <sgmltag>&lt;a4j:include&gt;</sgmltag> component allows one view to=
 be included as part of another page. This is useful for applications where=
 multiple views might appear on the one page, with navigation between the v=
iews. Views can use partial page navigation in Ajax mode, or standard <acro=
nym>JSF</acronym> navigation for navigation between views.
 		</para>
+		<para>
+			The <varname>viewId</varname> attribute is required to reference the re=
source that will be included as a view on the page. It uses a full context-=
relative path to point to the resource, similar to the paths used for the <=
sgmltag>&lt;from-view-id&gt;</sgmltag> and <sgmltag>&lt;to-view-id&gt;</sgm=
ltag> tags in the <filename>faces-config.xml</filename> <acronym>JSF</acron=
ym> navigation rules.
+		</para>
+		<example id=3D"exam-Component_Reference-a4jinclude-A_wizard_using_a4jinc=
lude">
+			<title>A wizard using <sgmltag>&lt;a4j:include&gt;</sgmltag></title>
+			<para>
+				The page uses <sgmltag>&lt;a4j:include&gt;</sgmltag> to include the fi=
rst step of the wizard:
+			</para>
+<programlisting language=3D"XML" role=3D"XML">
+<xi:include parse=3D"text" href=3D"extras/exam-Component_Reference-a4jincl=
ude-A_wizard_using_a4jinclude-0.xml_sample" xmlns:xi=3D"http://www.w3.org/2=
001/XInclude" />
+</programlisting>
+			<para>
+				The first step is fully contained in a separate file, <filename>wstep1=
.xhtml</filename>. Subsequent steps are set up similarly with additional <g=
uibutton>Previous</guibutton> buttons.
+			</para>
+<programlisting language=3D"XML" role=3D"XML">
+<xi:include parse=3D"text" href=3D"extras/exam-Component_Reference-a4jincl=
ude-A_wizard_using_a4jinclude-1.xml_sample" xmlns:xi=3D"http://www.w3.org/2=
001/XInclude" />
+</programlisting>
+			<para>
+				The navigation is defined in the <filename>faces-config.xml</filename>=
 configuration file:
+			</para>
+<programlisting language=3D"XML" role=3D"XML">
+<xi:include parse=3D"text" href=3D"extras/exam-Component_Reference-a4jincl=
ude-A_wizard_using_a4jinclude-2.xml_sample" xmlns:xi=3D"http://www.w3.org/2=
001/XInclude" />
+</programlisting>
+		</example>
 	</section>
 	=

 	<section id=3D"sect-Component_Reference-Containers-a4joutputPanel">


--===============3555829005539253893==--