Author: mcaspers Date: 2011-01-17 18:57:59 -0500 (Mon, 17 Jan 2011) New Revision: 28328 Modified: trunk/documentation/guides/GettingStartedGuide/en-US/first_seam.xml trunk/documentation/guides/GettingStartedGuide/en-US/manage.xml Log: General Updates Modified: trunk/documentation/guides/GettingStartedGuide/en-US/first_seam.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en-US/first_seam.xml 2011-01-17 23:53:20 UTC (rev 28327) +++ trunk/documentation/guides/GettingStartedGuide/en-US/first_seam.xml 2011-01-17 23:57:59 UTC (rev 28328) @@ -9,19 +9,18 @@ </keywordset> </chapterinfo> <title>Write Your First Project with JBoss Developer Studio</title> - <para>This chapter is a set of hands-on labs. You get step-by-step information about how the JBoss + <para>This chapter is a set of hands-on labs. You get step-by-step information about how JBoss Developer Studio can be used during the development process.</para> <section id="create_seam_application"> <title>Create a Seam Application</title> - <para>In this section you get to know how to create a Seam project in JBDS, how to start the - server and what a structure your project has after creating.</para> + <para>In this section you will learn how to create a Seam project in JBDS, how to start the + server and what structure your project has after it is created.</para> <section id="start_dev_db"> <title>Start Development Database</title> - <para>Before opening the JBoss Developer studio you need to download and start <ulink + <para>Before opening the JBoss Developer studio you need to download and start the <ulink url="http://docs.jboss.org/tools/resources/GSG_database.zip">... Database</ulink> .</para> - <para>To start the database just run <property>./runDBServer.sh</property> or <property - >runDBServer.bat</property> from the database directory.</para> + <para>To start the database just run <filename>./runDBServer.sh</filename> or <filename>runDBServer.bat</filename> from the database directory.</para> <para>The end result should be a console window that looks like:</para> <figure> <title>Starting DataBase</title> @@ -33,15 +32,15 @@ </figure> <note> <title>Tip</title> - <para>You may need to set the runDBServer.sh executable flag with the following command:</para> + <para>You may need to set the <filename>runDBServer.sh</filename> executable flag with the following command:</para> <screen>chmod +x runDBServer.sh</screen> </note> </section> <section id="create_deploy_seam"> <title>Create and deploy Seam Web Project</title> - <para>Minimize the terminal window and run the <property>JBoss Developer Studio</property> + <para>Minimize the terminal window and run <property>JBoss Developer Studio</property> from Applications Menu or from the desktop icon.</para> - <para>First of all you get the Workspace Launcher. Change the default workspace location if + <para>First you will see the Workspace Launcher. Change the default workspace location if it's needed. Click the <guibutton>OK</guibutton> button. </para> <figure> <title>Workspace Launcher Dialog</title> @@ -52,14 +51,14 @@ </mediaobject> </figure> <para>After startup, you see the welcome page. You could read how to work with welcome pages - in <link linkend="Welcome">previous</link> chapter. Now select <property>Create - New...</property> icon and then press on <property>Create Seam Project</property> + in <link linkend="Welcome">previous</link> chapter. Now select <guibutton>Create + New...</guibutton> icon and then press on <guibutton>Create Seam Project</guibutton> link.</para> <para>The <property>New Seam Project wizard</property> is started. You need to enter a name - (e.g., &quot;workshop&quot;) and a location directory for your new project. The wizard has + (e.g., &quot;workshop&quot;) and a location for your new project. The wizard has an option for selecting the actual Server (and not just WTP runtime) that will be used for - the project. This allows the wizard to correctly identify where the needed datasource and - driver libraries need to go.</para> + the project. This allows the wizard to correctly identify where the desitination folder for the required datasource and + driver libraries.</para> <figure> <title>New Seam Project Wizard</title> <mediaobject> @@ -69,9 +68,7 @@ </mediaobject> </figure> <para>All settings are already specified here, you can just modify the Configuration. Click on - the <emphasis> - <property>Modify...</property> - </emphasis> button to configure your custom facets pattern:</para> + the <guibutton>Modify...</guibutton> button to configure your custom facet options:</para> <figure id="ProjectFacetsSpecifyingScreen"> <title>Project Facets Specifying</title> <mediaobject> @@ -81,7 +78,7 @@ </mediaobject> </figure> <para>On the whole the dialog allows to select the "features" you want to use in your project. - Doing this <property>JBoss Developer Studio</property> setups the appropriate tooling for + <property>JBoss Developer Studio</property> will then setup the appropriate tooling for your project. Since JBoss Seam integrates all popular Java EE frameworks, you can select any combination of technologies from the list. Here, for the default configuration, Dynamic Web Module, Java, JavaServer Faces (JSF), and Seam Facet are already selected for a typical @@ -97,7 +94,7 @@ </imageobject> </mediaobject> </figure> - <para>Click the <guibutton>OK</guibutton> and then the <guibutton>Next</guibutton> button to proceed further.</para> + <para>Click the <guibutton>OK</guibutton> and then the <guibutton>Next</guibutton> button to proceed to the next step.</para> <para>A dynamic web application contains both web pages and <property>Java</property> code. The next wizard will ask you where you want to store Java files.</para> <figure> @@ -153,11 +150,11 @@ </imageobject> </mediaobject> </figure> - <para>Next <property>Database</property> section is a little tricky. The <property>Connection + <para>The <property>Database</property> section is a little tricky. The <property>Connection Profile</property> needs to be edited so that the new project works properly with the external HSQLDB server. By default the project wizard tries to use the JBoss embedded HSQLDB, but the tutorial uses an external database to replicate a more real world - development scenario. Click on <property>Edit</property> to modify the Connection + development scenario. Click on the <guibutton>Edit</guibutton> button to modify the Connection Profile.</para> <figure> <title>DataBase Setting</title> @@ -179,8 +176,8 @@ </imageobject> </mediaobject> </figure> - <para>Try click on <property>Test Connection</property> button. It probably won’t work. This - happens if the hsql jdbc driver is not exactly the same. This can be worked around by + <para>Click the <guibutton>Test Connection</guibutton> button. At this point it probably won’t work. This + happens if the HSQL JDBC driver is not exactly the same. This can be solved by modifying the HSQLDB database driver settings. To modify the settings, click the <guibutton>Edit Driver Definition Driver</guibutton> button. </para> <figure> @@ -192,7 +189,7 @@ </mediaobject> </figure> <para>The proper Driver JAR File should be listed under <property>Jar List</property>. Select - the hsqldb.jar file found in the <filename>jbdevstudio/jboss-eap/jboss-as/common/lib/</filename> directory and + the <filename>hsqldb.jar</filename> file found in the <filename>jbdevstudio/jboss-eap/jboss-as/common/lib/</filename> directory and click the <guibutton>OK</guibutton> button.</para> <figure> <title>Driver Details</title> Modified: trunk/documentation/guides/GettingStartedGuide/en-US/manage.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en-US/manage.xml 2011-01-17 23:53:20 UTC (rev 28327) +++ trunk/documentation/guides/GettingStartedGuide/en-US/manage.xml 2011-01-17 23:57:59 UTC (rev 28328) @@ -16,11 +16,10 @@ <para>In this chapter we&apos;ll focus more on how to operate the <property>JBoss AS</property> from <property>JBoss Developer Studio</property>.</para> <para> - <property>JBoss Developer Studio 4.0.0.GA</property> is shipped with <property>JBoss EAP 5.1</property>. When you followed the default installation of <property>JBoss - Developer Studio</property>, you should already have a JBoss EAP 5.1 Server installed and defined. To run JBoss AS you need you will need to have JDK 6 installed.</para> + <property>JBoss Developer Studio 4.0.0.GA</property> ships with <property>JBoss EAP 5.1</property>. When you followed the default installation of <property>JBoss Developer Studio</property>, you should already have a JBoss EAP 5.1 Server installed and defined. To run JBoss AS you need you will need to have JDK 6 installed.</para> <note> <title>Note:</title> - <para>You can leave <property>JDK 1.5</property> configuration for <property>JBDS</property> and set <property>JDK 6</property> as <property>JRE</property> only for <property>JBoss EAP Server</property>. For this you need to select <menuchoice><guimenuitem>Windows</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice>, and then click <menuchoice><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice>. On the opened preference page you should select <property>JBoss EAP Runtime</property> and click <property>Edit</property>. In <property>Edit Server Runtime Environment</property> dialog you can configure <property>Jave Runtime Environment</property> by clicking <property>JRE</property> button. </para> + <para>You can leave <property>JDK 1.5</property> configuration for <property>JBDS</property> and set <property>JDK 6</property> as <property>JRE</property> only for <property>JBoss EAP Server</property>. For this you need to select <menuchoice><guimenuitem>Windows</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice>, and then click <menuchoice><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice>. On the opened preference page you should select <property>JBoss EAP Runtime</property> and clicking the <guibutton>Edit</guibutton> button. In <property>Edit Server Runtime Environment</property> dialog you can configure <property>Jave Runtime Environment</property> by clicking the <guibutton>JRE</guibutton> button. </para> </note> <section id="JBossbundled"> @@ -50,9 +49,7 @@ <itemizedlist> <listitem> - <para>To launch the server click the green-with-white-arrow icon on the - <property>Servers</property> or right click server name in - this view and click the <guibutton>Start</guibutton> button. If this view is not open, select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice> + <para>To launch the server click the green-with-white-arrow icon in the <property>Servers</property> view or right click server name in this view and click the <guibutton>Start</guibutton> button. If this view is not open, select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice> </para> </listitem> </itemizedlist> @@ -76,9 +73,7 @@ </imageobject> </mediaobject> </figure> - <para>When the server is started you should see <emphasis> - <property>Started</property> - </emphasis> in the square brackets right next its name in <property>Servers</property>.</para> + <para>When the server is started you should see <emphasis><property>Started</property></emphasis> in the square brackets right next its name in the <property>Servers</property> view.</para> <figure> <title>Server is Started</title> @@ -103,11 +98,7 @@ <section id="StoppingJBoss"> <?dbhtml filename="StoppingJBoss.html"?> <title>Stopping JBoss Server</title> - <para>To stop the server, click the <emphasis> - <property>Stop</property> - </emphasis> icon in <property>Servers</property> or right click the server - name and press <emphasis> - <property>Stop</property>. </emphasis> + <para>To stop the server, click the the <guibutton>Stop</guibutton> button icon in <property>Servers</property> or right click the server name and press <guimenuitem>Stop</guimenuitem>. </para> <figure> @@ -139,7 +130,7 @@ </figure> <para>Here you can specify some common settings: host name, server name, runtime as well - as settings related to the publishing, timeouts and server ports.</para> + as settings related to publishing, timeouts and server ports.</para> </section> </section> @@ -169,7 +160,7 @@ <title>Note:</title> <para>The installation of JBoss server into a directory that has a name containing spaces provokes problems in some situations with Sun-based VMs. Try to avoid - using installation folders that have spaces in their names.</para> + using installation folders that contain spaces in their names.</para> </note> <para>There is no requirement for root access to run JBoss Server on UNIX/Linux systems @@ -178,11 +169,11 @@ <itemizedlist> <listitem> <para>After you have the binary archive you want to install, use the JDK jar - tool (or any other ZIP extraction tool) to extract the jboss-4.2.3.GA.zip - archive contents into a location of your choice. The jboss-4.2.3.GA.tgz + tool (or any other ZIP extraction tool) to extract the <filename>jboss-4.2.3.GA.zip</filename> + archive contents into a location of your choice. The <filename>jboss-4.2.3.GA.tgz</filename> archive is a gzipped tar file that requires a gnutar compatible tar which can handle the long pathnames in the archive. The extraction process will - create a jboss-4.2.3.GA directory. </para> + create a <filename>jboss-4.2.3.GA</filename> directory. </para> </listitem> </itemizedlist> </section> @@ -190,11 +181,10 @@ <section id="AddingJBossServer"> <?dbhtml filename="AddingJBossServer.html"?> <title>Adding and Configuring JBoss Server</title> - <para>Now we should add just installed server into server manager in <property>JBoss - Developer Studio</property>.</para> + <para>Now we should add the just installed server into server manager in <property>JBoss Developer Studio</property>.</para> <itemizedlist> <listitem> - <para>Select <property>Servers</property> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>. + <para>Select the <property>Servers</property> view by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>. </para> </listitem> <listitem> @@ -218,28 +208,19 @@ <note> <title>Note:</title> - <para>Now in the <property>New Server wizard</property> there is a separation - between the .org servers (the <emphasis> - <property>JBoss Community</property> - </emphasis> category) and product server that comes bundled with JBoss EAP (the - <emphasis> - <property>JBoss Enterprise Middleware</property> - </emphasis> category).</para> + <para>Now in the <property>New Server wizard</property> there is a separation between the .org servers (the <emphasis><property>JBoss Community</property></emphasis> category) and product server that comes bundled with JBoss EAP (the <emphasis><property>JBoss Enterprise Middleware</property></emphasis> category).</para> </note> <itemizedlist> <listitem> - <para>To create a new runtime, which Jboss AS 4.2 matches to, click <emphasis> - <property>Next</property> - </emphasis> + <para>To create a new runtime, which Jboss AS 4.2 matches to, click the <guibutton>Next</guibutton> button </para> </listitem> </itemizedlist> <itemizedlist> <listitem> - <para>In the next step make <property>JBoss Developer Studio</property> to know - where you have installed the Server and define JRE.</para> + <para>In the next step you need to specify the location of the Server and define JRE to be used.</para> </listitem> </itemizedlist> <figure>