Author: smukhina Date: 2009-11-03 12:00:49 -0500 (Tue, 03 Nov 2009) New Revision: 18399 Modified: trunk/seam/docs/reference/en/modules/creating_new_seam.xml Log: https://jira.jboss.org/jira/browse/JBDS-906 Demos update. Update corresponding guides: Seam Reference Guide updated the same way as the seam new project demo Modified: trunk/seam/docs/reference/en/modules/creating_new_seam.xml =================================================================== --- trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2009-11-03 17:00:05 UTC (rev 18398) +++ trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2009-11-03 17:00:49 UTC (rev 18399) @@ -10,13 +10,12 @@ </chapterinfo> <title>Creating a New Seam Project via the New Seam Project wizard</title> <para>In this chapter we provide you with the necessary steps to start working with Seam - Framework.</para> - + Framework.</para> <para>At first, we suggest setting the specific Seam perspective that combines a number of - different views and editors needed for work with resources concerned. For that select <emphasis> + different views and editors needed for work with resources concerned. 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>Seam Perspective Icon</title> <mediaobject> @@ -25,10 +24,9 @@ </imageobject> </mediaobject> </figure> - <para>Also the <emphasis> - <property>Open Web Browser</property></emphasis> action is directly available in the <property>Seam perspective</property>.</para> - + <property>Open Web Browser</property></emphasis> action is directly available in the + <property>Seam perspective</property>.</para> <figure> <title>Embedded Web Browser Button</title> <mediaobject> @@ -37,7 +35,6 @@ </imageobject> </mediaobject> </figure> - <section id="standaloneSeam" role="updated"> <title>Create standalone Seam Web Project</title> <para>The best way to get started with Seam is to organise a simple Seam Project and @@ -50,9 +47,8 @@ <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>Let&apos;s get through the wizard step-by-step. First, you should enter a name and - a location directory for your new project.</para> - + <para>Let&apos;s get through the wizard step-by-step. First, you should enter a name and a + location directory for your new project.</para> <figure id="figure_create_seam1"> <title>New Seam Project Wizard</title> <mediaobject> @@ -61,9 +57,7 @@ </imageobject> </mediaobject> </figure> - <para>On the figure above you can see the runtime and the server already created.</para> - <para>If you need to create a new runtime, click on the <emphasis> <property>New...</property> </emphasis> button in the <property>Target Runtime</property> section. It brings up the @@ -72,7 +66,6 @@ Runtime. Hence, after choosing it click on <emphasis> <property>Next</property> </emphasis> button.</para> - <figure> <title>Specifying Target Runtime</title> <mediaobject> @@ -81,13 +74,11 @@ </imageobject> </mediaobject> </figure> - <para>All what you need here is to name runtime, type the path to its install directory or locate it by using <emphasis> <property>Browse</property> </emphasis> button, select a Java Runtime Environment, and select which configuration you want.</para> - <figure> <title>Specifying Target Runtime Configurations</title> <mediaobject> @@ -96,24 +87,19 @@ </imageobject> </mediaobject> </figure> - <para> Clicking on <emphasis> <property>Finish</property> </emphasis> returns you to the <link linkend="figure_create_seam1">New Seam Project - wizard page</link>.</para> - - <para>The next step is to define a Server that you can do by clicking - on <emphasis> + wizard page</link>.</para> + <para>The next step is to define a Server that you can do by clicking on <emphasis> <property>New...</property> </emphasis> button in the <property>Target Server</property> section. In appeared <property>New Server dialog</property> the last server which matches the runtime will be selected.</para> - <para>All declared runtimes are listed in the combo box under the servers view. Here, you can indicate a server runtime that you need. Click <emphasis> <property>Add</property> </emphasis> if you want to add a new Server Runtime.</para> - <figure> <title>Specifying Target Server</title> <mediaobject> @@ -122,12 +108,10 @@ </imageobject> </mediaobject> </figure> - <para>Next page allows you to verify the information for chosen server. Leave everything as it is and click on <emphasis> <property>Next</property> </emphasis>.</para> - <figure> <title>JBoss Runtime Summary</title> <mediaobject> @@ -136,10 +120,8 @@ </imageobject> </mediaobject> </figure> - <para>On the last wizard step you can modify your projects to configure them on the Server.</para> - <figure> <title>Project Modification for Configuring on the Server</title> <mediaobject> @@ -148,19 +130,15 @@ </imageobject> </mediaobject> </figure> - - <para>Once you have the Target Server defined click on <emphasis> <property>Finish</property> </emphasis> button to return to the first page of the <property>New Seam Project wizard</property>.</para> - <tip> <title>Tip:</title> <para>We suggest that you look through our <ulink url="&aslink;">AS manager guide</ulink> to find out more about runtimes and servers.</para> </tip> - <figure> <title>Completion of Runtime and Server Configuration</title> <mediaobject> @@ -169,7 +147,6 @@ </imageobject> </mediaobject> </figure> - <para>The last section on this wizard step is <property>Configuration</property>. Here, you can select one of the pre-defined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by @@ -177,21 +154,16 @@ <property>Modify...</property> </emphasis> button. It will open the dialog which allows to configure your own set of facets for adding extra functionality to your project.</para> - <para>Pass to the next section to find out more details on this dialog.</para> - </section> <section id="projectFacets"> <title>Select the Project Facets</title> - <para>The <property>Project Facets wizard</property> allows you to enable or disable specific facets which define necessary characteristics for the project. In time you switch to this wizard form, all critical facets are already checked for the chosen Configuration.</para> - <para>Notice that this page of the wizard also allows you to set the necessary version for any facet. </para> - <figure> <title>Project Facets Selection</title> <mediaobject> @@ -200,12 +172,10 @@ </imageobject> </mediaobject> </figure> - <para>Moreover, here you can specify your own preset of selected facets by checking needed ones in project facets window and clicking on <emphasis> <property>Save</property> </emphasis> button.</para> - <figure> <title>Specifying Custom Facet Preset</title> <mediaobject> @@ -214,15 +184,13 @@ </imageobject> </mediaobject> </figure> - <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the left. You can create a new one using the <emphasis> <property>New</property> </emphasis> button. If more than one runtimes are checked here, the <emphasis> <property>Make Primary</property> - </emphasis> button won&apos;t be dimmed yet. So you can make use of it to mark - primary runtime.</para> - + </emphasis> button won&apos;t be dimmed yet. So you can make use of it to mark primary + runtime.</para> <figure> <title>Runtime Manipulations</title> <mediaobject> @@ -231,22 +199,32 @@ </imageobject> </mediaobject> </figure> - <para><emphasis> <property>Ok</property> </emphasis> button will bring you to the <property>Web Module</property> wizard form again.</para> </section> - + <section id="configureJava"> + <title>Java application building configuration</title> + <para>With this wizard you can define Java source directories, which will be generated on + build path. Also you can specify default output folder. If you are agree with default + values, press <property>Next</property></para> + <figure> + <title>Java application building Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> + </imageobject> + </mediaobject> + </figure> + </section> <section id="configureWebModule"> <title>How to Configure Web Module Settings</title> - <para> As we deal with a Dynamic Web Application we should first specify the top level directory of our application for deploying it to a server afterwards. You know, this - kind of application contains both Web and Java code resources. Thus, it's also important - to indicate the content directory as well as Java source directory. The wizard will put - all those values itself. So you can leave everything as it is.</para> - + kind of application contains Web resources. Thus, it's important to indicate the content + directory. The wizard will put all those values itself. So you can leave everything as + it is.</para> <figure> <title>Web Module Settings</title> <mediaobject> @@ -259,17 +237,14 @@ <property>Next</property> </emphasis> to switch to the next wizard form.</para> </section> - <section id="addJSFCapab"> <title>Adding JSF Capabilities</title> - <para>This wizard helps you to add JSF capabilities into your project for representing appropriate behaviours associated with JSF. </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>Choose <emphasis> + <property>Library provided by Target Runtime</property> + </emphasis> from Library Type list if you want have a default JSF implementation + given by the present runtime.</para> <figure> <title>Adding JSF Capabilities to Web Project</title> <mediaobject> @@ -278,47 +253,66 @@ </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>Here, it's necessary to type a <property>Library Name</property>, select a - <property>Version Supported</property> and add proper <property>Library - jars</property>. Then click on <emphasis> - <property>Finish</property> - </emphasis> to complete the choice.</para> + <para>In case when you prefer to use your custom JSF implementation choose <property>User + Library</property> Item from Library Type list. In User Library list you can check + required library.</para> <figure> - <title>Create JSF Implementation Library</title> + <title>Using Custom JSF implementation Library </title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_seam/create_seam_17.png"/> </imageobject> </mediaobject> </figure> - - <para>In the Component Libraries section of the wizard you can also add <property>Component - Libraries</property> (e.g. <ulink url="http://www.jboss.org/jbossrichfaces" - >Richfaces</ulink>). Just click on <emphasis> - <property>New</property> - </emphasis> button. Appeared dialog will ask you to type the Library name, supported - version and add necessary jar's. Press <emphasis> - <property>Finish</property> - </emphasis> to complete the choice.</para> - + <para> If you want to add new library click <property>Manage libraries...</property> ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> + </imageobject> + </inlinemediaobject>) button. Then you should click <property + >New</property>.</para> <figure> - <title>Create JSF Implementation Component Library</title> + <title>Using Custom JSF implementation Library </title> <mediaobject> <imageobject> <imagedata fileref="images/create_new_seam/create_seam_18.png"/> </imageobject> </mediaobject> </figure> - + <para> Here, it's necessary to type a <property>Library Name</property>. </para> + <figure> + <title>Entering New User Library Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To add proper <property>Library JARs</property> click <property>Add JARs...</property> + button and select the JARs on your hard drive. </para> + <figure> + <title>Selection Library JARs</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_25.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Also you can download necessary JSF implementation libraries provided by Sun and Apache Foundation. For this you need click <property>Download...</property> (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> + </imageobject> + </inlinemediaobject>) button and choose one of proposed libraries.</para> + <figure> + <title>Download JSF Implementation Library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_24.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 <property>URL Mapping Patterns</property>.</para> - <figure> <title>JSF Capabilities Wizard</title> <mediaobject> @@ -327,14 +321,11 @@ </imageobject> </mediaobject> </figure> - <para>Finally, as we are arranging the Seam Web project, the last step we should do is to adjust project configurations associated with the Seam.</para> </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> @@ -345,7 +336,6 @@ </imageobject> </mediaobject> </figure> - <itemizedlist> <listitem> <para>Create Seam runtime and define Seam home folder.</para> @@ -357,7 +347,6 @@ 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> @@ -366,7 +355,6 @@ </imageobject> </mediaobject> </figure> - <itemizedlist> <listitem> <para>Select EAR or WAR deployment by checking a necessary radio button.</para> @@ -377,7 +365,6 @@ </emphasis></para> </listitem> </itemizedlist> - <figure> <title>Database Type Selecting</title> <mediaobject> @@ -386,16 +373,13 @@ </imageobject> </mediaobject> </figure> - <itemizedlist> <listitem> <para>and then specify a <emphasis> <property>Connection profile</property> </emphasis> appropriate for your database.</para> - </listitem> </itemizedlist> - <figure> <title>Connection Profile Options</title> <mediaobject> @@ -404,7 +388,6 @@ </imageobject> </mediaobject> </figure> - <para>You can edit chosen profile by using <emphasis> <property>Edit</property> </emphasis> button or organise a new one by clicking on <emphasis> @@ -418,13 +401,11 @@ </imageobject> </mediaobject> </figure> - - <para>On the other dialog you&apos;ll be asked to enter its name and description. And - then you should select a proper driver and adjust connection details. Press <emphasis> + <para>On the other dialog you&apos;ll be asked to enter its name and description. And then + you should select a proper driver and adjust connection details. Press <emphasis> <property>Next</property> </emphasis> to preview all the adjusted settings and complete the creation of the new profile.</para> - <figure> <title>Connection Details</title> <mediaobject> @@ -433,14 +414,12 @@ </imageobject> </mediaobject> </figure> - <para>The next block of settings in the Seam Facet wizard are describing a Database and a connection to it.</para> <para>In the <property>Code Generation</property> section the wizard have already put the names for your <property>Session Bean</property>, <property>Entity Bean</property> and <property>Test</property> packages. Of course, you can change them into the others which you like.</para> - <figure> <title>Code Generation Section</title> <mediaobject> @@ -449,11 +428,9 @@ </imageobject> </mediaobject> </figure> - <para>Click on <emphasis> <property>Finish</property> </emphasis> to generate a project.</para> - <para/> </section> </chapter>