Author: ochikvina
Date: 2008-01-11 11:03:27 -0500 (Fri, 11 Jan 2008)
New Revision: 5629
Modified:
trunk/seam/docs/reference/en/modules/creating_new_seam.xml
trunk/seam/docs/reference/en/modules/intro.xml
Log:
http://jira.jboss.com/jira/browse/JBDS-234 - making changes in the chapters according to
the Svetlana remarks
Modified: trunk/seam/docs/reference/en/modules/creating_new_seam.xml
===================================================================
--- trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2008-01-11 16:00:56 UTC
(rev 5628)
+++ trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2008-01-11 16:03:27 UTC
(rev 5629)
@@ -6,262 +6,338 @@
<keyword>JBoss Tools</keyword>
<keyword>Seam</keyword>
<keyword>JBDS</keyword>
- </keywordset>
+ </keywordset>
</chapterinfo>
<title>Creating a New Seam Project via the New Seam Project
wizard</title>
- <para>To start working with Seam, select a Seam perspective via
<emphasis><property>Window > Open Perspective > Other >
Seam</property></emphasis>.
- Select <emphasis><property>File > New > Seam Web
Project</property></emphasis> to run the <property>New Seam
Project</property> wizard.</para>
-
- <section id="standaloneSeam">
- <title>Create standalone Seam Web Project</title>
- <para>It's necessary to enter a name and a location directory for your
new project. The next wizard forms allow you to create runtime and server instances in
order to get started creating, running, and debugging J2EE applications.</para>
- <para>Seam Web Project wizard has an option for selecting the actual Server
(not just WTP runtime) that will be used for the project. This allows the wizard to
identify correctly where the required datasource and driver libraries need to
go.</para>
-
+ <para>In this chapter we provide you with the necessary steps to start working
with Seam
+ Framework.</para>
+ <para>At first, we suggest browsing the specific Seam
perspective.</para>
+ <para>For that select <emphasis>
+ <property>Window > Open Perspective > Other >
Seam</property>
+ </emphasis> or you can also access it through the button in the right top
corner.</para>
+
<figure>
- <title>New Seam Project Wizard</title>
- <mediaobject>
+ <title>Seam Perspective</title>
+ <mediaobject>
<imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam1.png"/>
+ <imagedata
fileref="images/create_new_seam/create_seam0.png"/>
</imageobject>
</mediaobject>
</figure>
-
-
- <para>Click on
<emphasis><property>New...</property></emphasis> button in the
Target Runtime section.</para>
- <para>From this dialog you can choose what type of runtime you want to
create. Let's create a JBoss 4.2 Runtime. Click on
<emphasis><property>Next</property></emphasis>.</para>
-
- <figure>
- <title>New Server Runtime Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>All what you need here is to name runtime, browse to its install
directory, select a Java Runtime Environment, and select which configuration you want.
Click on
<emphasis><property>Finish</property></emphasis>.</para>
-
- <figure>
- <title>New Server Runtime Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now you should define an installed server by clicking on
<emphasis><property>New...</property></emphasis> button in the
Target section.
- It's possible to select a server version and a server runtime. Use
<emphasis><property>Installed Runtimes</property></emphasis>
button to see or edit what runtimes are installed. Click on Next</para>
-
- <figure>
- <title>New Server Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
+
+ <section id="standaloneSeam">
+ <title>Create standalone Seam Web Project</title>
+ <para>The best way to get started with Seam is to organise a simple Seam
Project and
+ experiment with it by creating variations.</para>
+ <para>Thus, you should select <emphasis>
+ <property>File > New > Seam Web Project</property>
+ </emphasis> to run the <property>New Seam
Project</property> wizard.</para>
+ <para>It's necessary to enter a name and a location directory for your
new project. The next
+ wizard forms allow you to create runtime and server instances in order to get
started
+ creating, running, and debugging J2EE applications.</para>
+ <para>Seam Web Project wizard has an option for selecting the actual Server
(not just WTP
+ runtime) that will be used for the project. This allows the wizard to
identify correctly
+ where the required datasource and driver libraries need to go.</para>
+
+ <figure>
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>Clicking on <emphasis>
+ <property>New...</property>
+ </emphasis> button in the Target Runtime section brings us to another
dialog. Here, you can
+ specify a new installed Runtime environment or the other type of runtime
appropriate for
+ configuring your project. Let's create a JBoss 4.2 Runtime. For that
after choosing it click on <emphasis>
+ <property>Next</property>
+ </emphasis> button.</para>
+
+ <figure>
+ <title>New Server Runtime Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>All what you need here is to name runtime, type or locate using
<emphasis>
+ <property>Browse</property></emphasis> button the path to
its install directory, select a
+ Java Runtime Environment, and select which configuration you want. Clicking
on <emphasis>
+ <property>Finish</property>
+ </emphasis> returns you to the previous dialog. The next step is to
define an installed server. You can do it by clicking on <emphasis>
+ <property>New...</property>
+ </emphasis> button in the Target section. </para>
+
+ <figure>
+ <title>New Server Runtime Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It's possible to select a server version and a
+ server runtime. Use <emphasis>
+ <property>Installed Runtimes</property>
+ </emphasis> button to see or edit what runtimes are installed. Click on
Next</para>
+
+ <figure>
+ <title>New Server Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<para>Leave everything as is and click on next.</para>
-
- <figure>
- <title>New Server Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
+
+ <figure>
+ <title>New Server Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<para>On the last wizard step you can modify your project to configure it
on server.</para>
-
+
<figure>
- <title>New Server Dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>After clicking on Finish button you should have the following wizard
view:</para>
-
- <figure>
- <title>New Seam Project Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The last section on this wizard step is
<property>Configurations</property>. You can select one of the pre-defined
project configuration or create your own. Click on
<emphasis><property>Next</property>.</emphasis></para>
-
- </section>
+ <title>New Server Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>After clicking on Finish button you should have the following wizard
view:</para>
+
+ <figure>
+ <title>New Seam Project Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The last section on this wizard step is
<property>Configurations</property>. You can
+ select one of the pre-defined project configuration or create your own. Click
on
+
<emphasis><property>Next</property>.</emphasis></para>
+
+ </section>
<section id="projectFacets">
<title>Select the Project Facets</title>
-
- <para>This page of the wizard allows you to enable or disable specific
facets. You can save or delete your preset of selected facets clicking on
<emphasis><property>Save</property></emphasis>
button.</para>
-
+
+ <para>This page of the wizard allows you to enable or disable specific
facets. You can save
+ or delete your preset of selected facets clicking on <emphasis>
+ <property>Save</property>
+ </emphasis> button.</para>
+
<figure>
- <title>Project Facets Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/create_new_seam/create_seam8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can also see all available runtimes after clicking on
<emphasis><property>Show Runtimes</property></emphasis> or create
new ones using the <emphasis><property>New</property></emphasis>
button.</para>
-
+ <title>Project Facets Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/create_new_seam/create_seam8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also see all available runtimes after clicking on
<emphasis>
+ <property>Show Runtimes</property>
+ </emphasis> or create new ones using the <emphasis>
+ <property>New</property>
+ </emphasis> button.</para>
+
<figure>
<title>Project Facets Selection</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam8_1.png"/>
</imageobject>
</mediaobject>
</figure>
-
+
</section>
-
+
<section id="configureWebModule">
<title>How to Configure Web Module Settings</title>
-
- <para>A dynamic web application contains both web pages and Java code. The
wizard will ask you where you want to put those files. You can just leave the default
values.</para>
-
+
+ <para>A dynamic web application contains both web pages and Java code. The
wizard will ask
+ you where you want to put those files. You can just leave the default
values.</para>
+
<figure>
<title>Web Module Settings</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam9.png"/>
</imageobject>
</mediaobject>
</figure>
-
+
</section>
<section id="addJSFCapab">
<title>Adding JSF Capabilities</title>
-
+
<para>This wizard helps you to add JSF capabilities into your project.
</para>
- <para>Checking <emphasis><property>Server Supplied JSF
Implementation</property></emphasis>
- means that you will have a default JSF implementation given by
server.</para>
-
+ <para>Checking <emphasis>
+ <property>Server Supplied JSF Implementation</property>
+ </emphasis> means that you will have a default JSF implementation given
by server.</para>
+
<figure>
<title>Adding JSF Capabilities to Web Project</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam10.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <para>In case when you want to use your custom JSF implementation check a
lower radio button. You are able to create a library of jars by clicking on
- <emphasis><property>New</property></emphasis>
button.</para>
- <para>Type a <property>Library Name</property>, select a
<property>Version Supported</property> and add <property>Library
jars</property>. Click on
<emphasis><property>Finish</property>.</emphasis></para>
+
+ <para>In case when you want to use your custom JSF implementation check a
lower radio
+ button. You are able to create a library of jars by clicking on
<emphasis>
+ <property>New</property>
+ </emphasis> button.</para>
+ <para>Type a <property>Library Name</property>, select a
<property>Version
+ Supported</property> and add <property>Library
jars</property>. Click on
+
<emphasis><property>Finish</property>.</emphasis></para>
<figure>
<title>Create JSF Implementation Library</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam10_1.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <para>You can also add a <property>Component
Libraries</property> (e.g. Richfaces) clicking on
<emphasis><property>New</property></emphasis> button in the
Component Libraries section.</para>
-
+
+ <para>You can also add a <property>Component
Libraries</property> (e.g. Richfaces) clicking
+ on <emphasis>
+ <property>New</property>
+ </emphasis> button in the Component Libraries section.</para>
+
<figure>
<title>Create JSF Implementation Library</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam10_2.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <para>The last wizard options allows to edit a path for <property>JSF
Configuration File</property>, a name for <property>JSF
Servlet</property>, <property>JSF Servlet Classname</property>
- and change an <property>URL Mapping Patterns</property>.</para>
-
+
+ <para>The last wizard options allows to edit a path for <property>JSF
Configuration
+ File</property>, a name for <property>JSF
Servlet</property>, <property>JSF Servlet
+ Classname</property> and change an <property>URL Mapping
Patterns</property>.</para>
+
<figure>
<title>JSF Capabilities Wizard</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam10_3.png"/>
</imageobject>
</mediaobject>
</figure>
-
+
</section>
-
- <section id="seamFacet">
- <title>Configure Seam Facet Settings</title>
-
- <para>The last wizard step is related to Seam facet and allows you to do the
following:</para>
- <figure>
+
+ <section id="seamFacet">
+ <title>Configure Seam Facet Settings</title>
+
+ <para>The last wizard step is related to Seam facet and allows you to do
the following:</para>
+ <figure>
<title>Seam Facet Settings</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam11.png"/>
</imageobject>
</mediaobject>
</figure>
-
+
<itemizedlist>
- <listitem><para>Create Seam runtime and define Seam home folder.
Click on <emphasis><property>Add</property></emphasis> button in
the <property>General</property> section.</para></listitem>
+ <listitem>
+ <para>Create Seam runtime and define Seam home folder. Click on
<emphasis>
+ <property>Add</property>
+ </emphasis> button in the
<property>General</property> section.</para>
+ </listitem>
</itemizedlist>
- <para>Notice that in this wizard presented below you can create a Seam
runtime only for that version which was selected in the <link
linkend="projectFacets">Project Facets</link> wizard (version 1.2 in
our case).</para>
-
+ <para>Notice that in this wizard presented below you can create a Seam
runtime only for that
+ version which was selected in the <link
linkend="projectFacets">Project Facets</link>
+ wizard (version 1.2 in our case).</para>
+
<figure>
<title>Seam Runtime Creation</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam12.png"/>
</imageobject>
</mediaobject>
</figure>
-
+
<itemizedlist>
- <listitem><para>Select EAR or WAR deployment by checking a
necessary radio button.</para></listitem>
- <listitem><para>Select a <emphasis><property>Database
Type</property></emphasis></para></listitem>
+ <listitem>
+ <para>Select EAR or WAR deployment by checking a necessary radio
button.</para>
+ </listitem>
+ <listitem>
+ <para>Select a <emphasis>
+ <property>Database Type</property>
+ </emphasis></para>
+ </listitem>
</itemizedlist>
-
+
<figure>
<title>Seam Runtime Creation</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam13_0.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <itemizedlist>
- <listitem><para>and create a
<emphasis><property>Connection profile</property></emphasis>
clicking on <emphasis><property>New</property></emphasis> button
and selecting the necessary connection profile.</para></listitem>
- </itemizedlist>
-
+
+ <itemizedlist>
+ <listitem>
+ <para>and create a <emphasis>
+ <property>Connection profile</property>
+ </emphasis> clicking on <emphasis>
+ <property>New</property>
+ </emphasis> button and selecting the necessary connection
profile.</para>
+ </listitem>
+ </itemizedlist>
+
<figure>
<title>Connection Profile Selecting</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam13.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <para>Other Database fields are describing a Database and a connection to
it.</para>
- <para>In the <property>Code Generation</property> section you
can edit a package name for <property>Session Bean</property>,
<property>Entity Bean</property> and
<property>Test</property>.</para>
-
-
+
+ <para>Other Database fields are describing a Database and a connection to
it.</para>
+ <para>In the <property>Code Generation</property> section you
can edit a package name for
+ <property>Session Bean</property>, <property>Entity
Bean</property> and
+ <property>Test</property>.</para>
+
+
<figure>
<title>Code Generation Section</title>
- <mediaobject>
+ <mediaobject>
<imageobject>
<imagedata
fileref="images/create_new_seam/create_seam14.png"/>
</imageobject>
</mediaobject>
</figure>
-
- <para>Click on
<emphasis><property>Finish</property></emphasis> to generate a
project.</para>
-
-</section>
- </chapter>
+
+ <para>Click on <emphasis>
+ <property>Finish</property>
+ </emphasis> to generate a project.</para>
+
+ </section>
+</chapter>
Modified: trunk/seam/docs/reference/en/modules/intro.xml
===================================================================
--- trunk/seam/docs/reference/en/modules/intro.xml 2008-01-11 16:00:56 UTC (rev 5628)
+++ trunk/seam/docs/reference/en/modules/intro.xml 2008-01-11 16:03:27 UTC (rev 5629)
@@ -24,7 +24,7 @@
<section>
<title>Other relevant resources on the topic</title>
- <para><ulink
url="http://www.jboss.com/products/seam">Seam
Framework</ulink></para>
+ <para>On JBoss you can find a number of benefits and other extra
information on the <ulink
url="http://www.jboss.com/products/seam">Seam
Framework</ulink>.</para>
</section>
</chapter>