[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Gavin King
gavin.king at jboss.com
Tue Dec 5 15:28:27 EST 2006
User: gavin
Date: 06/12/05 15:28:27
Modified: doc/reference/en/modules configuration.xml tutorial.xml
Log:
update
Revision Changes Path
1.32 +98 -41 jboss-seam/doc/reference/en/modules/configuration.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: configuration.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/configuration.xml,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -b -r1.31 -r1.32
--- configuration.xml 29 Nov 2006 10:28:03 -0000 1.31
+++ configuration.xml 5 Dec 2006 20:28:27 -0000 1.32
@@ -33,31 +33,6 @@
</para>
<para>
- If you are using Seam in Apache MyFaces (and possibly some other JSF implementations),
- you <emphasis>must</emphasis> use client-side state saving. So you'll also need this
- in <literal>web.xml</literal>:
- </para>
-
-<programlisting><![CDATA[<context-param>
- <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
- <param-value>client</param-value>
-</context-param>]]></programlisting>
-
- <!-- No longer required:
-
- <para>
- To force JSF to delegate variable resolution to Seam, we need to register
- a <literal>VariableResolver</literal> in the
- <literal>faces-config.xml</literal> file:
- </para>
-
- <programlisting><![CDATA[<application>
- <variable-resolver>org.jboss.seam.jsf.SeamVariableResolver</variable-resolver>
-</application>]]></programlisting>
-
- -->
-
- <para>
To integrate with the JSF request lifecycle, we also need a JSF
<literal>PhaseListener</literal> registered in in the
<literal>faces-config.xml</literal> file:
@@ -86,6 +61,18 @@
around a minor bug in the RI.)
</para>
+ <para>
+ Some JSF implementations have a broken implementation of server-side state
+ saving that interferes with Seam's conversation propagation. If you have problems
+ with conversation propagation during form submissions, try switching to client-side
+ state saving. You'll need this in <literal>web.xml</literal>:
+ </para>
+
+<programlisting><![CDATA[<context-param>
+ <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
+ <param-value>client</param-value>
+</context-param>]]></programlisting>
+
</sect2>
<sect2>
@@ -182,6 +169,29 @@
</sect2>
+ <sect2>
+ <title>Using facelets</title>
+
+ <para>
+ If you want follow our advice and use facelets instead of JSP,
+ add the following lines to <literal>faces-config.xml</literal>:
+ </para>
+
+ <programlisting><![CDATA[<application>
+ <view-handler>com.sun.facelets.FaceletViewHandler</view-handler>
+</application>]]></programlisting>
+
+ <para>
+ And the following lines to <literal>web.xml</literal>:
+ </para>
+
+ <programlisting><![CDATA[<context-param>
+ <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
+ <param-value>.xhtml</param-value>
+</context-param>]]></programlisting>
+
+ </sect2>
+
</sect1>
<sect1>
@@ -199,11 +209,12 @@
<para>
If you're running in a Java EE 5 environment, this is all the configuration
required to start using Seam! But there is one final item you need to know about.
- You must place a <literal>seam.properties</literal> file in the root of any
- archive in which your Seam components are deployed (even an empty properties file
- will do). At startup, Seam will scan any archives with
+ You must place a <literal>seam.properties</literal>,
+ <literal>META-INF/seam.properties</literal> or <literal>META-INF/components.xml</literal>
+ file in any archive in which your Seam components are deployed (even an empty
+ properties file will do). At startup, Seam will scan any archives with
<literal>seam.properties</literal> files for seam components. If that doesn't
- work for you, you can also add components by installing them explicitly in
+ work for you, you can also add components by installing them explicitly via
<literal>components.xml</literal>. (We don't recommend this alternative approach.)
</para>
@@ -217,6 +228,8 @@
<programlisting><![CDATA[my-application.ear/
jboss-seam.jar
+ el-api.jar
+ el-ri.jar
META-INF/
MANIFEST.MF
application.xml
@@ -227,6 +240,9 @@
web.xml
components.xml
faces-config.xml
+ lib/
+ jsf-facelets.jar
+ jboss-seam-ui.jar
login.jsp
register.jsp
...
@@ -246,8 +262,32 @@
...]]></programlisting>
<para>
- Make sure you reference <literal>jboss-seam.jar</literal> from manifests of the
- EJB-JAR and WAR.
+ You must include <literal>jboss-seam.jar</literal>, <literal>el-api.jar</literal> and
+ <literal>el-ri.jar</literal> in the EAR classpath. Make sure you reference all of these
+ jars from <literal>application.xml</literal>.
+ </para>
+
+ <para>
+ If you want to use jBPM or Drools, you must include the needed jars in the EAR classpath.
+ Make sure you reference all of the jars from <literal>application.xml</literal>.
+ </para>
+
+ <para>
+ If you want to use facelets (our recommendation), you must include
+ <literal>jsf-facelets.jar</literal> in the <literal>WEB-INF/lib</literal> directory
+ of the WAR.
+ </para>
+
+ <para>
+ If you want to use the Seam tag library (most Seam applications do), you must include
+ <literal>jboss-seam-ui.jar</literal> in the <literal>WEB-INF/lib</literal> directory
+ of the WAR.
+ </para>
+
+ <para>
+ If you want to use the Seam debug page (only works for applications using facelets), you
+ must include <literal>jboss-seam-debug.jar</literal> in the <literal>WEB-INF/lib</literal>
+ directory of the WAR.
</para>
<para>
@@ -386,6 +426,10 @@
faces-config.xml
lib/
jboss-seam.jar
+ jboss-seam-ui.jar
+ el-api.jar
+ el-ri.jar
+ jsf-facelets.jar
myfaces-api.jar
myfaces-impl.jar
jboss-ejb3.jar
@@ -663,6 +707,10 @@
faces-config.xml
lib/
jboss-seam.jar
+ jboss-seam-ui.jar
+ el-api.jar
+ el-ri.jar
+ jsf-facelets.jar
hibernate3.jar
...
my-application.jar/
@@ -803,6 +851,10 @@
faces-config.xml
lib/
jboss-seam.jar
+ jboss-seam-ui.jar
+ el-api.jar
+ el-ri.jar
+ jsf-facelets.jar
hibernate3.jar
...
jboss-microcontainer.jar
@@ -898,6 +950,8 @@
<programlisting><![CDATA[my-application.ear/
jboss-seam.jar
+ el-api.jar
+ el-ri.jar
jbpm-3.1.jar
META-INF/
MANIFEST.MF
@@ -909,6 +963,9 @@
web.xml
components.xml
faces-config.xml
+ lib/
+ jsf-facelets.jar
+ jboss-seam-ui.jar
login.jsp
register.jsp
...
1.75 +18 -3 jboss-seam/doc/reference/en/modules/tutorial.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: tutorial.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/tutorial.xml,v
retrieving revision 1.74
retrieving revision 1.75
diff -u -b -r1.74 -r1.75
--- tutorial.xml 29 Nov 2006 10:28:03 -0000 1.74
+++ tutorial.xml 5 Dec 2006 20:28:27 -0000 1.75
@@ -674,7 +674,11 @@
enables automatic schema export at startup time.
</para>
- <programlisting><![CDATA[<persistence>
+ <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<persistence xmlns="http://java.sun.com/xml/ns/persistence"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
+ version="1.0">
<persistence-unit name="userDatabase">
<provider>org.hibernate.ejb.HibernatePersistence</provider>
<jta-data-source>java:/DefaultDS</jta-data-source>
@@ -770,8 +774,13 @@
</para>
<example id="registration-application-xml">
- <programlisting><![CDATA[<application>
- <display-name>Seam</display-name>
+ <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<application xmlns="http://java.sun.com/xml/ns/javaee"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_5.xsd"
+ version="5">
+
+ <display-name>Seam Registration</display-name>
<module>
<web>
@@ -785,6 +794,12 @@
<module>
<java>jboss-seam.jar</java>
</module>
+ <module>
+ <java>el-api.jar</java>
+ </module>
+ <module>
+ <java>el-ri.jar</java>
+ </module>
</application>]]></programlisting>
</example>
More information about the jboss-cvs-commits
mailing list