Author: mcaspers Date: 2011-03-16 23:21:58 -0400 (Wed, 16 Mar 2011) New Revision: 29854 Modified: trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml trunk/seam/docs/reference/en-US/creating_new_seam.xml trunk/seam/docs/reference/en-US/intro.xml trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml Log: "Fixed spelling errors" Modified: trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml =================================================================== --- trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,181 +1,201 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="mavenized_seam"> - <?dbhtml filename="create_mavenized_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Maven Integration for Seam Projects</title> - <para>Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven - Integration plug-in which for now allows to create mavenized Seam projects and enable Seam - tools support for imported Maven projects.</para> - <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" - >m2eclipse</ulink> to be installed.</para> - <note> - <title>Note:</title> - <para>For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse - <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the - <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351"... - integration build</ulink> that M2 was developed against. If you want to use the - latest development release of m2eclipse you need to use the <ulink - url="http://download.jboss.org/jbosstools/updates/nightly/trunk/&quo... - builds</ulink> of <property>JBoss Tools</property>.</para> - </note> - <section id="create_mavenized_project"> - <title>Creating Maven ready Seam project</title> - <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to - let Maven get the libraries instead of using the Seam runtime.</para> - <para>To create a mavenized Seam project you should perform the following steps:</para> - <itemizedlist> - <listitem> - <para>Navigate to <emphasis> - <property>File &gt; New Seam Project</property>.</emphasis> Give the project - a meaningful name, specify a target runtime and server and select the proper - configuration for your Seam project:</para> - <figure> - <title>Starting the Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click the <emphasis> - <property>Modify</property></emphasis> button to enable the <emphasis> - <property>Jboss Maven Integration</property></emphasis> facet:</para> - <figure> - <title>Enabling the Jboss Maven Integration Facet</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>JBoss M2 capabilities</property> page you&apos;ll be prompted - to add the following maven properties: groupId, artifactId, version, packaging, - name and description. Here it&apos;s possible to set a maven version of Seam and - also decide whether to remove WTP classpath containers (where the path starts - with org.eclipse.jst). </para> - <figure> - <title>Adjusting JBoss M2 Capabilities</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para> On the <property>JSF Capabilities</property> page you can choose Maven as - libraries provider. This is possible when you use Maven JSF 1.2 Libraries as - type of JSF Implementing Library. Also it gives you capability to edit - Dependencies and Exclusions for the mavenized Seam project directly from the - wizard. </para> - <figure> - <title>Using JSF Implementation libraries provided by Maven</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>Seam Facet</property> page configure the Seam Facet settings - and click <emphasis> - <property>Finish</property>:</emphasis></para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>The organized Seam project contains five projects with the Maven nature, builder, - Maven classpath and the <emphasis> - <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, - projectname-ejb, projectname-parent and projectname-test.</para> - <figure> - <title>Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" - /> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="import_maven_project"> - <title>Existing Maven Projects Import</title> - <para>Maven Integration includes the Seam Maven configurator which is called when importing - a project, changing <emphasis> - <property>pom.xml</property></emphasis> and/or calling <emphasis> - <property>Maven &gt; Update Project Configuration</property>.</emphasis> When - importing a Maven Seam project, the Seam Maven configurator picks up the settings set up - in <emphasis> - <property>pom.xml</property></emphasis> and adds to the project the - following:</para> - <itemizedlist> - <listitem> - <para>Seam nature</para> - </listitem> - <listitem> - <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para> - </listitem> - <listitem> - <para>JBoss Maven Integration facet if the Maven project contains a dependency with - the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para> - </listitem> - <listitem> - <para>other required facets (Web Module, Java, JSF, etc.)</para> - </listitem> - </itemizedlist> - <para>If the Seam version from <emphasis> - <property>pom.xml</property></emphasis> matches a version of a Seam runtime - configured in the workspace, Seam configurator will set that runtime, otherwise no Seam - runtime will be set and you&apos;ll have to set it manually under <xref - linkend="project_pref"/>.</para> - <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder - is a web content folder from the WAR project, the source folder is the first Eclipse - source folder. If there is a folder containing &quot;hot&quot; in the name, it will be - chosen as the action source folder. Package is the first package that has children or - doesn&apos;t have any subpackage. </para> - <para>Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam - artifacts and some facets could be suspended in the JBoss Maven Integration preferences - (<emphasis> - <property>Window &gt; Preferences &gt; JBoss Tools &gt; JBoss Maven - Integration</property></emphasis>).</para> - <figure> - <title>JBoss Maven Integration Preferences</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/configure_maven_integration.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Relevant Resources Links</title> - <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using - Maven with JBoss Tools</ulink> article written by Max Andersen you&apos;ll find - references to the screencasts on how to use the examples of mavenized Seam projects - provided by <property>JBoss Tools</property>.</para> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="mavenized_seam"> +<?dbhtml filename="create_mavenized_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Maven Integration for Seam Projects</title> + <para> + Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven Integration plug-in which for now allows to create mavenized Seam projects and enable Seam tools support for imported Maven projects. + </para> + + <para> + The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" + >m2eclipse</ulink> to be installed. + </para> + + <note> + <title>Note:</title> + <para> + For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351"... integration build</ulink> that M2 was developed against. If you want to use the latest development release of m2eclipse you need to use the <ulink + url="http://download.jboss.org/jbosstools/updates/nightly/trunk/&quo... builds</ulink> of <property>JBoss Tools</property>. + </para> + </note> + + <section id="create_mavenized_project"> + <title>Creating Maven ready Seam project</title> + <para> + Maven Integration makes the Seam Wizard capable of creating Maven ready projects to let Maven get the libraries instead of using the Seam runtime. + </para> + + <para> + To create a mavenized Seam project you should perform the following steps: + </para> + + <itemizedlist> + <listitem> + <para> + Navigate to <emphasis> <property>File &gt; New Seam Project</property>.</emphasis> Give the project a meaningful name, specify a target runtime and server and select the proper configuration for your Seam project: + </para> + + <figure> + <title>Starting the Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + Click the <emphasis> <property>Modify</property></emphasis> button to enable the <emphasis> <property>Jboss Maven Integration</property></emphasis> facet: + </para> + + <figure> + <title>Enabling the Jboss Maven Integration Facet</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JBoss M2 capabilities</property> page you&apos;ll be prompted to add the following maven properties: groupId, artifactId, version, packaging, name and description. Here it&apos;s possible to set a maven version of Seam and also decide whether to remove WTP classpath containers (where the path starts with org.eclipse.jst). + </para> + + <figure> + <title>Adjusting JBoss M2 Capabilities</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JSF Capabilities</property> page you can choose Maven as libraries provider. This is possible when you use Maven JSF 1.2 Libraries as type of JSF Implementing Library. Also it gives you capability to edit Dependencies and Exclusions for the mavenized Seam project directly from the wizard. + </para> + + <figure> + <title>Using JSF Implementation libraries provided by Maven</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>Seam Facet</property> page configure the Seam Facet settings and click <emphasis> <property>Finish</property>:</emphasis> + </para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + The organized Seam project contains five projects with the Maven nature, builder, Maven classpath and the <emphasis> <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, projectname-ejb, projectname-parent and projectname-test. + </para> + + <figure> + <title>Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="import_maven_project"> + <title>Existing Maven Projects Import</title> + <para> + Maven Integration includes the Seam Maven configurator which is called when importing a project, changing <emphasis> <property>pom.xml</property></emphasis> and/or calling <menuchoice><guimenuitem>Maven</guimenuitem><guimenuitem>Update Project Configuration.</guimenuitem></menuchoice> When importing a Maven Seam project, the Seam Maven configurator picks up the settings set up in <emphasis> <property>pom.xml</property></emphasis> and adds to the project the following: + </para> + + <itemizedlist> + <listitem> + <para> + Seam nature + </para> + </listitem> + + <listitem> + <para> + Seam facet and dependent facets to the EJB, EAR and WAR projects + </para> + </listitem> + + <listitem> + <para> + JBoss Maven Integration facet if the Maven project contains a dependency with the org.jboss.seam groupId and an artifactId starting with 'jboss-seam' + </para> + </listitem> + + <listitem> + <para> + other required facets (Web Module, Java, JSF, etc.) + </para> + </listitem> + </itemizedlist> + + <para> + If the Seam version from <emphasis> <property>pom.xml</property></emphasis> matches a version of a Seam runtime configured in the workspace, Seam configurator will set that runtime, otherwise no Seam runtime will be set and you&apos;ll have to set it manually under <xref + linkend="project_pref"/>. + </para> + + <para> + Seam configurator recognizes the Seam artifacts in the following way: the view folder is a web content folder from the WAR project, the source folder is the first Eclipse source folder. If there is a folder containing &quot;hot&quot; in the name, it will be chosen as the action source folder. Package is the first package that has children or doesn&apos;t have any subpackage. + </para> + + <para> + Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam artifacts and some facets could be suspended in the JBoss Maven Integration preferences (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Maven Integration</guimenuitem></menuchoice>). + </para> + + <figure> + <title>JBoss Maven Integration Preferences</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/configure_maven_integration.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para> + In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using Maven with JBoss Tools</ulink> article written by Max Andersen you&apos;ll find references to the screencasts on how to use the examples of mavenized Seam projects provided by <property>JBoss Tools</property>. + </para> + </section> +</chapter> Modified: trunk/seam/docs/reference/en-US/creating_new_seam.xml =================================================================== --- trunk/seam/docs/reference/en-US/creating_new_seam.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/creating_new_seam.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,477 +1,556 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="create_seam" role="updated"> - <?dbhtml filename="create_new_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </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> - <para>At first, we suggest to set the specific Seam perspective that combines a number of - 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> +<?dbhtml filename="create_new_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </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> + + <para> + At first, we suggest to set the specific Seam perspective that combines a number of 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Also the <emphasis> <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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_01.png"/> + </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 create a simple Seam Project and experiment with it. + </para> + + <para> + Thus, you should select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice> to run the <property>New Seam Project</property> wizard. The wizard form allows you to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) 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> + 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_1.png"/> + </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 wizard where you can specify a new JBoss Server Runtime environment or the other type of runtime appropriate for your project configuration. Let's create one more JBoss 4.2 Runtime. Hence, after choosing it click on <emphasis> <property>Next</property> </emphasis> button. + </para> + <figure> - <title>Seam Perspective Icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_0.png"/> - </imageobject> - </mediaobject> + <title>Specifying Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_2.png"/> + </imageobject> + </mediaobject> </figure> - <para>Also the <emphasis> - <property>Open Web Browser</property></emphasis> action is directly available in the - <property>Seam perspective</property>.</para> + + <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>Embedded Web Browser Button</title> + <title>Specifying Target Runtime Configurations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking on <emphasis> <property>Finish</property> </emphasis> returns you to the <xref linkend="figure_create_seam1"/>. + </para> + + <para> + The next step is to define a Server 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 combobox 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Next page allows you to verify the information for a chosen server. Leave everything as it is and click on <emphasis> <property>Next</property> </emphasis>. + </para> + + <figure> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_5.png"/> + </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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_6.png"/> + </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> + + <note> + <title>Tip:</title> + <para> + We suggest that you look through the Application Server Manager Guide to find out more about runtimes and servers. + </para> + </note> + + <figure> + <title>Completion of Runtime and Server Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The last section on this wizard step is <property>Configuration</property>. Here, you can select one of the predefined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by pressing the <guibutton>Modify...</guibutton> 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>Selecting the Project Facets</title> + <para> + The <property>Project Facets wizard</property> allows you to enable or disable specific facets which define necessary features for the project. When 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_8.png"/> + </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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_15.png"/> + </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 runtime is checked here, the <emphasis> <property>Make Primary</property> </emphasis> button won&apos;t be dimmed yet. Thus, you can make use of it to mark primary runtime. + </para> + + <figure> + <title>Setting Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking the <guibutton>OT</guibutton> button will bring you to the <property>Web Module</property> wizard form again. + </para> + + <section id="seamWithJPA"> + <title>Seam project with JPA facets</title> + <para> + For creating Seam project with JPA support you need to select<property> Java Persistent</property> facet on <property>Project Facets</property> page and click <property>OK</property>. + </para> + + <para> + Then you should press <property>Next</property> and may leave the default value on <property>Java application building</property> page and <property>Web Module Settings</property> page. + </para> + + <para> + After that you will see <property>JPA facet</property> page. + </para> + + <figure> + <title>JPA Facet page</title> <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_01.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> + </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 create a simple Seam Project and - experiment with it.</para> - <para>Thus, you should select <emphasis> - <property>File > New > Seam Web Project</property> - </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form - allows you to create runtime and server instances in order to get started creating, - running, and debugging J2EE (only) 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>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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_1.png"/> - </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 - wizard where you can specify a new JBoss Server Runtime environment or the other type of - runtime appropriate for your project configuration. Let's create one more JBoss 4.2 - Runtime. Hence, after choosing it click on <emphasis> - <property>Next</property> - </emphasis> button.</para> - <figure> - <title>Specifying Target Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_2.png"/> - </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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_3.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Clicking on <emphasis> - <property>Finish</property> - </emphasis> returns you to the <xref linkend="figure_create_seam1"/>.</para> - <para>The next step is to define a Server 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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Next page allows you to verify the information for a chosen server. Leave everything - as it is and click on <emphasis> - <property>Next</property> - </emphasis>.</para> - <figure> - <title>JBoss Runtime Summary</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_5.png"/> - </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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_6.png"/> - </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> - <note> - <title>Tip:</title> - <para>We suggest that you look through the Application Server Manager Guide to - find out more about runtimes and servers.</para> - </note> - <figure> - <title>Completion of Runtime and Server Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_7.png"/> - </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 - pressing the <emphasis> - <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>Selecting the Project Facets</title> - <para>The <property>Project Facets wizard</property> allows you to enable or disable - specific facets which define necessary features for the project. When 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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_8.png"/> - </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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_15.png"/> - </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 runtime is checked here, the <emphasis> - <property>Make Primary</property> - </emphasis> button won&apos;t be dimmed yet. Thus, you can make use of it to mark - primary runtime.</para> - <figure> - <title>Setting Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para><emphasis> - <property>Ok</property> - </emphasis> button will bring you to the <property>Web Module</property> wizard form - again.</para> - <section id="seamWithJPA"> - <title>Seam project with JPA facets</title> - <para>For creating Seam project with JPA support you need to select<property> Java - Persistent</property> facet on <property>Project Facets</property> page and - click <property>OK</property>.</para> - <para>Then you should press <property>Next</property> and may leave the default value on - <property>Java application building</property> page and <property>Web Module - Settings</property> page.</para> - <para>After that you will see <property>JPA facet</property> page.</para> - <figure> - <title>JPA Facet page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On this page you can choose <property>Platform</property> (vendor-specific JPA - implementation) for your project, type of JPA Implementation, and configure the - <property>Connection</property> to database in the <property - >Connection</property> area.</para> - <para>More about <property>JPA facet</property> page you can read in <ulink + </figure> + + <para> + On this page you can choose <property>Platform</property> (vendor-specific JPA implementation) for your project, type of JPA Implementation, and configure the <property>Connection</property> to database in the <property + >Connection</property> area. + </para> + + <para> + More about <property>JPA facet</property> page you can read in <ulink url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jp... - >Eclipse documentation</ulink>. </para> - <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam - facet</property> pages, which are mostly the same as in general Seam - project.</para> - </section> + >Eclipse documentation</ulink>. + </para> + + <para> + On the next step you will see <property>JSF Capabilities</property> and <property>Seam facet</property> pages, which are mostly the same as in general Seam project. + </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 a 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 at first specify the top level - directory of our application for deploying it to a server afterwards. You know, this - 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 - is.</para> - <figure> - <title>Web Module Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_9.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Choose <emphasis> - <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 to your project. </para> - <para>Choose <emphasis> - <property>Library provided by Target Runtime</property> - </emphasis> from Library Type list if you'd like to use a default JSF implementation - given by the present runtime.</para> - <figure> - <title>Adding JSF Capabilities to Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In case if 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>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17.png"/> - </imageobject> - </mediaobject> - </figure> - <para> If a new library is required, 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>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>You can download necessary JSF implementation libraries provided by Sun and Apache - Foundation as well. 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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_19.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Since 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> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_11.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Create Seam runtime and define Seam home folder.</para> - </listitem> - </itemizedlist> - <para>For that click on <emphasis> - <property>Add</property> - </emphasis> button in the <property>General</property> section. Note, in the wizard - shown below you can create a Seam runtime only for the version that was selected in the - <xref linkend="projectFacets"/> wizard (version 1.2 in our - case).</para> - <figure> - <title>Seam Runtime Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_12.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Select EAR or WAR deployment by checking a necessary radio button.</para> - </listitem> - <listitem> - <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para> - </listitem> - </itemizedlist> - - <note> - <title>Tip:</title> - <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", - it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" - and "MyProject-test".</para> - </note> - - <itemizedlist> - <listitem> - <para>Select a <emphasis> - <property>Database Type</property> - </emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Database Type Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_20.png"/> - </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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_21.png"/> - </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> - <property>New</property> - </emphasis> button and selecting necessary for you type of connection profile.</para> - <figure> - <title>Connection Profile Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_13.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the 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> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_22.png"/> - </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 has already provided - the names for your <property>Session Bean</property>, <property>Entity Bean</property> - and <property>Test</property> packages generation (optional). Of course, you can change - them on others of your choice.</para> - <figure> - <title>Code Generation Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_14.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis> - <property>Finish</property> - </emphasis> to generate a project.</para> - <para/> - </section> -</chapter> \ No newline at end of file + </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 a 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 at first specify the top level directory of our application for deploying it to a server afterwards. You know, this 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 is. + </para> + + <figure> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Choose <emphasis> <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 to your project. + </para> + + <para> + Choose <emphasis> <property>Library provided by Target Runtime</property> </emphasis> from Library Type list if you'd like to use a default JSF implementation given by the present runtime. + </para> + + <figure> + <title>Adding JSF Capabilities to Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In case if 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>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If a new library is required, 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>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> + You can download necessary JSF implementation libraries provided by Sun and Apache Foundation as well. 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Since 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> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Create Seam runtime and define Seam home folder. + </para> + </listitem> + </itemizedlist> + + <para> + For that click on <emphasis> <property>Add</property> </emphasis> button in the <property>General</property> section. Note, in the wizard shown below you can create a Seam runtime only for the version that was selected in the <xref linkend="projectFacets"/> wizard (version 1.2 in our case). + </para> + + <figure> + <title>Seam Runtime Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Select EAR or WAR deployment by checking a necessary radio button. + </para> + </listitem> + + <listitem> + <para> + Enter EJB project name and EAR project name in case of EAR radio button is checked. + </para> + </listitem> + </itemizedlist> + + <note> + <title>Tip:</title> + <para> + If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" and "MyProject-test". + </para> + </note> + + <itemizedlist> + <listitem> + <para> + Select a <emphasis> <property>Database Type</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Database Type Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_20.png"/> + </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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can edit chosen profile by using <emphasis> <property>Edit</property> </emphasis> button or organize a new one by clicking on <emphasis> <property>New</property> </emphasis> button and selecting necessary for you type of connection profile. + </para> + + <figure> + <title>Connection Profile Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the 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> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_22.png"/> + </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 has already provided the names for your <property>Session Bean</property>, <property>Entity Bean</property> and <property>Test</property> packages generation (optional). Of course, you can change them on others of your choice. + </para> + + <figure> + <title>Code Generation Section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_14.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on <emphasis> <property>Finish</property> </emphasis> to generate a project. + </para> + + <para/> + </section> +</chapter> Modified: trunk/seam/docs/reference/en-US/intro.xml =================================================================== --- trunk/seam/docs/reference/en-US/intro.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/intro.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -64,7 +64,7 @@ <row> <entry><para>New Seam Project wizard</para></entry> - <entry><para>An easy step-by-step wizard to create a standalone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> + <entry><para>An easy step-by-step wizard to create a stand alone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> <entry> <xref linkend="create_seam"/> </entry> Modified: trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml =================================================================== --- trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,361 +1,363 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="menus_and_actions"> - <?dbhtml filename="seam_menus_and_actions.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - <keyword>menus</keyword> - <keyword>actions</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Menus and Actions</title> - - <para>In this chapter we provide a description of Seam actions that are available from</para> - <itemizedlist> - <listitem> - <para>Menu bar</para> - </listitem> - <listitem> - <para>Toolbar</para> - </listitem> - <listitem> - <para>Context menus in views</para> - </listitem> - </itemizedlist> - - - <section id="file_menu"> - - <title>File Menu Actions</title> - - <para>In a Seam perspective, by default there are the following actions in <emphasis> - <property>File > New</property> - </emphasis> submenu</para> - - <table> - <title>Seam Actions in the New Submenu</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Seam Web Project</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="standaloneSeam"/> wizard - for creating a new Seam project </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Action</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_action"/> wizard for - creating a new Seam action </para> - </entry> - - - </row> - - - - <row> - <entry> - <para> - <property>Seam Form</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_form"/> wizard for - creating a new Seam form </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Entity</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_entity"/> wizard for - creating a new Seam entity </para> - </entry> - - - </row> - - <row> - <entry> - <para> - <property>Seam Conversation</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation - </para> - </entry> - - - - </row> - - <row> - <entry> - <para> - <property>Seam Generate Entities</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="generate_entities"/> wizard</para> - </entry> - - - - </row> - - - </tbody> - </tgroup> - </table> - - - </section> - - <section id="navigate_menu"> - <title>Navigate Menu Actions</title> - - <para>In the next sections we are going to describe Seam actions which can help you to - easily navigate through the source code.</para> - - <section id="find_seam_ref_decl"> - - <title>Find Seam References/Declarations</title> - - <para>To find EL expressions both in <emphasis> - <property>.java</property> - </emphasis> and <emphasis> - <property>.xhtml</property> - </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <emphasis> - <property>Search > Find Seam References</property> - </emphasis> or <emphasis><property>Find Seam Declarations</property>.</emphasis> - </para> - - <para>Look at the description of the actions in the table below.</para> - - <table> - <title>Find Seam References/Declarations actions</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Find Seam References</property> - </para> - <para> - <property>Find Seam Declarations</property> - </para> - </entry> - - <entry> - <para>Find all references and declarations to the selected element. - It's available for EL expressions in both .java and .xhtml - files. Differs from normal Eclipse Find References/Declarations - by showing an EL or Seam references in the Search View. </para> - </entry> - - <entry> - <para>Ctrl+G</para> - <para>Ctrl+Shift+G</para> - <para>also Ctrl + 1 for .java files</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - - <para>On the screenshot example below you could see that the search results are listed - in the - <property>Search view</property>. - </para> - - <figure> - <title>Find Seam Declaration for &quot;Identity&quot;</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can also use Ctrl + 1 in .java files to activate the actions:</para> - - <figure> - <title>Find Seam References for &quot;Identity&quot;</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="open_seam_component"> - <title>Open Seam Component</title> - - <para>To open Seam Components click on <emphasis><property>Navigate > Open Seam - Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar - icon or with hot keys combination "Ctrl+Shift+Z ".</para> - - <figure> - <title>Open Seam Components icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" - /> - </imageobject> - </mediaobject> - </figure> - - <para>In the table below read a description about the dialog.</para> - - <table> - <title>Open Seam Components Dialog</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Open Seam Components</property> - </para> - - </entry> - - <entry> - <para>Brings up the Open Seam Component dialog to open a component - in the editor. The Open Seam Component selection dialog shows - all Seam components existing in the workspace. You can search - the components via their short, imported or full name.</para> - </entry> - - <entry> - <para>Ctrl+Shift+Z</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - <para>Enter a name in the text field and see the results as it shown on screenshot: </para> - - <figure> - <title>Open Seam Components Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using - <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ).</para> - </section> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="menus_and_actions"> +<?dbhtml filename="seam_menus_and_actions.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + + <keyword>menus</keyword> + + <keyword>actions</keyword> + </keywordset> + </chapterinfo> + <title>Seam Menus and Actions</title> + <para> + In this chapter we provide a description of Seam actions that are available from + </para> + + <itemizedlist> + <listitem> + <para> + Menu bar + </para> + </listitem> + + <listitem> + <para> + Toolbar + </para> + </listitem> + + <listitem> + <para> + Context menus in views + </para> + </listitem> + </itemizedlist> + + <section id="file_menu"> + <title>File Menu Actions</title> + <para> + In a Seam perspective, by default there are the following actions in <emphasis> <property>File > New</property> </emphasis> submenu + </para> + + <table> + <title>Seam Actions in the New Submenu</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Seam Web Project</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="standaloneSeam"/> wizard for creating a new Seam project + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Action</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_action"/> wizard for creating a new Seam action + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Form</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_form"/> wizard for creating a new Seam form + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Entity</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_entity"/> wizard for creating a new Seam entity + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Conversation</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Generate Entities</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="generate_entities"/> wizard + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="navigate_menu"> + <title>Navigate Menu Actions</title> + <para> + In the next sections we are going to describe Seam actions which can help you to easily navigate through the source code. + </para> + + <section id="find_seam_ref_decl"> + <title>Find Seam References/Declarations</title> + <para> + To find EL expressions both in <emphasis> <property>.java</property> </emphasis> and <emphasis> <property>.xhtml</property> </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <menuchoice><guimenuitem>Search</guimenuitem><guimenuitem>Find Seam References</guimenuitem></menuchoice> or <emphasis><property>Find Seam Declarations</property>.</emphasis> + </para> + + <para> + Look at the description of the actions in the table below. + </para> + + <table> + <title>Find Seam References/Declarations actions</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Find Seam References</property> + </para> + + <para> + <property>Find Seam Declarations</property> + </para> + </entry> + + <entry> + <para> + Find all references and declarations to the selected element. It's available for EL expressions in both .java and .xhtml files. Differs from normal Eclipse Find References/Declarations by showing an EL or Seam references in the Search View. + </para> + </entry> + + <entry> + <para> + Ctrl+G + </para> + + <para> + Ctrl+Shift+G + </para> + + <para> + also Ctrl + 1 for .java files + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + On the screenshot example below you could see that the search results are listed in the <property>Search view</property>. + </para> + + <figure> + <title>Find Seam Declaration for &quot;Identity&quot;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also use Ctrl + 1 in .java files to activate the actions: + </para> + + <figure> + <title>Find Seam References for &quot;Identity&quot;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="open_seam_component"> + <title>Open Seam Component</title> + <para> + To open Seam Components click on <emphasis><property>Navigate > Open Seam Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar icon or with hot keys combination "Ctrl+Shift+Z ". + </para> + + <figure> + <title>Open Seam Components icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + In the table below read a description about the dialog. + </para> + + <table> + <title>Open Seam Components Dialog</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Open Seam Components</property> + </para> + </entry> + + <entry> + <para> + Brings up the Open Seam Component dialog to open a component in the editor. The Open Seam Component selection dialog shows all Seam components existing in the workspace. You can search the components via their short, imported or full name. + </para> + </entry> + + <entry> + <para> + Ctrl+Shift+Z + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Enter a name in the text field and see the results as it shown on screenshot: + </para> + + <figure> + <title>Open Seam Components Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ). + </para> + </section> + </section> +</chapter>