Author: mcaspers Date: 2011-01-12 00:13:59 -0500 (Wed, 12 Jan 2011) New Revision: 28113 Modified: trunk/documentation/guides/Beginners_Guide/en-US/The_interface.xml Log: General editing Modified: trunk/documentation/guides/Beginners_Guide/en-US/The_interface.xml =================================================================== --- trunk/documentation/guides/Beginners_Guide/en-US/The_interface.xml 2011-01-12 03:54:24 UTC (rev 28112) +++ trunk/documentation/guides/Beginners_Guide/en-US/The_interface.xml 2011-01-12 05:13:59 UTC (rev 28113) @@ -3,18 +3,18 @@ <chapter id="chap-Beginners_Guide-The_interface"> <title>The interface</title> <para> - The interfaces that the <application>JBoss Developer Studio</application> IDE is built for are discussed. + This chapter discusses the interface to the <application>JBoss Developer Studio</application> IDE. </para> <section id="sect-Beginners_Guide-The_interface-Eclipse"> <title>Eclipse</title> <para> - Eclipse is the container for all development work in the <application>JBoss Developer Studio</application>. It allows for control over the running of the application server, the applications on it and provides an interface for developing your own applications. + Eclipse provides a container for all development work <application>JBoss Developer Studio</application>. It provides control over the application server, the applications on it and provides an interface through which you can develop your own applications. </para> <para> - Eclipse is started by double-clicking on the <filename>eclipse</filename> executeable in your installation directory. + Eclipse is started by double-clicking on the <filename>jbdevstudio</filename> executable in your installation directory. </para> <para> - Following this you will be asked to specify a workspace. A workspace is the location on your computer where your files will be stored relating to the multiple sessions. If you wish to change your workspace location after this step you can do so by following the menu items <guimenuitem>File</guimenuitem>, <guimenuitem>Switch Workspace</guimenuitem>, <guimenuitem>Other...</guimenuitem>. + Following this you will be asked to specify a workspace. A workspace is the location on your computer where your files relating to the multiple sessions will be stored. If you wish to change your workspace location after this step you can do so by selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Switch Workspace</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice>. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_Workspace_launcher"> <title>Eclipse Workspace launcher</title> @@ -25,7 +25,7 @@ </mediaobject> </figure> <para> - After selecting a workspace location, you will be greeted with the <guilabel>Welcome</guilabel> screen. This screen provides a few pathway options, including a <guilabel>Getting Started</guilabel> link to a selection of documentation, an option to create a new project with the <guilabel>Create New...</guilabel> option and an option to skip straight to your <guilabel>Workbench</guilabel>. + After selecting the location of the workspace, you will be greeted with the <guilabel>Welcome</guilabel> screen. This screen provides a few pathway options, including the <guilabel>Getting Started</guilabel> link to a selection of documentation, an option to create a new project with the <guilabel>Create New...</guilabel> option and an option to skip straight to your <guilabel>Workbench</guilabel>. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_welcome_screen"> <title>Eclipse welcome screen</title> @@ -36,7 +36,7 @@ </mediaobject> </figure> <para> - Skipping straight to your workbench, you will see a screen with a few sections and the JBoss Application Server listed in the bottom area of the interface. + Skipping straight to your workbench, you will see a screen with a number of default views and the JBoss Application Server listed in the bottom area of the interface. </para> <figure id="figu-Beginners_Guide-Eclipse-Eclipse_Workbench"> <title>Eclipse Workbench</title> @@ -47,7 +47,7 @@ </mediaobject> </figure> <para> - In the bottom left hand corner of the screen is a picture of a white column with a blue bar and a yellow plus sign beside it. Clicking on this button will open a menu of different views and windows. + In the bottom left hand corner of the screen is a button with an icon displaying a white column with a blue bar and a yellow plus sign beside it. Clicking on this button will open a menu of different views and windows. </para> <figure id="figu-Beginners_Guide-Eclipse-Views_button"> <title>Views button</title> @@ -58,7 +58,7 @@ </mediaobject> </figure> <para> - The window that may be of most use to you can be found by following: <menuchoice><guimenuitem>Other...</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>JBoss Tools Palette</guimenuitem></menuchoice>. This window opens an interface to the tools included with the <application>JBoss Developer Studio</application>. + The window that may be of most use to you can be found by following: <menuchoice><guimenuitem>Other...</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>JBoss Tools Palette</guimenuitem></menuchoice>. This option opens a perspective that includes the tools provided by <application>JBoss Developer Studio</application>. </para> <para> Refer to the <citetitle pubwork="section">Welcome to JBoss Developer Studio</citetitle> section of the <citetitle pubwork="book">Getting Started with JBoss Developer Studio</citetitle> guide for further details. @@ -68,12 +68,12 @@ <section id="sect-Beginners_Guide-The_interface-JBoss_Application_Server"> <title>JBoss Application Server</title> <para> - The JBoss Application Server provides the full range of Java EE 5 features as well as extended enterprise services including clustering, caching, and persistence. + The JBoss Application Server Server provides the full range of Java EE 5 features as well as extended enterprise services including clustering, caching, and persistence. </para> <section id="sect-Beginners_Guide-JBoss_Application_Server-Using_the_application_server_shipped_with_the_JBoss_Developer_Studio"> - <title>Using the application server shipped with the JBoss Developer Studio</title> + <title>Using the Application Server shipped with the JBoss Developer Studio</title> <para> - This section discusses the JBoss Application Server with regards to its use through Eclipse. Once you have started the Eclipse interface for the <application>JBoss Developer Studio</application>, the JBoss Application Server can be started by clicking on its name in the lower part of the window and then clicking the green arrow to the right. + This section discusses the use of the JBoss Application Server through Eclipse. Once you have started the Eclipse interface for the <application>JBoss Developer Studio</application>, the JBoss Application Server can be started by selecting it in the Servers view, which can be found in the lower part of the window, and then clicking the green arrow to the right. </para> <figure id="figu-Beginners_Guide-Use_of_the_application_server_shipped_with_JBoss_Tools_or_JBoss_Developer_Studio-Starting_and_stopping_the_server"> <title>Starting and stopping the server</title> @@ -85,11 +85,11 @@ </figure> <note> <para> - If the <guimenu>Servers</guimenu> view is not displayed at the bottom of your Workbench, you can activate it through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice> and then click the <guibutton>OK</guibutton> button. + If the <guimenu>Servers</guimenu> view is not displayed at the bottom of your Workbench, you can activate it through <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice> and then clicking the <guibutton>OK</guibutton> button. </para> </note> <para> - After the server has been successfully started the status next to the server name will change from displaying <emphasis>Stopped</emphasis> to displaying <emphasis>Started, Synchronized</emphasis>. + After the server has been successfully started the status field next to the server name will change from <emphasis>Stopped</emphasis> to <emphasis>Started, Synchronized</emphasis>. </para> <figure id="figu-Beginners_Guide-Use_of_the_application_server_shipped_with_JBoss_Tools_or_JBoss_Developer_Studio-Server_started_successfully"> <title>Server started successfully</title> @@ -111,25 +111,25 @@ </mediaobject> </figure> <para> - From this <guilabel>Overview</guilabel> section there are six subsections consisting of: <guilabel>General Information</guilabel>, <guilabel>Login Credentials</guilabel>, <guilabel>Publishing</guilabel>, <guilabel>Timeouts</guilabel>, <guilabel>Server Polling</guilabel> and <guilabel>Server Ports</guilabel>. + The <guilabel>Overview</guilabel> section contains six subsections: <guilabel>General Information</guilabel>, <guilabel>Login Credentials</guilabel>, <guilabel>Publishing</guilabel>, <guilabel>Timeouts</guilabel>, <guilabel>Server Polling</guilabel> and <guilabel>Server Ports</guilabel>. </para> <para> - The <guilabel>General Information</guilabel> subsection allows you to change the <guilabel>Server name</guilabel> and <guilabel>Host name</guilabel> to your own preferences. By clicking on the <guilabel>Runtime Environment</guilabel> label a dialog box with options to change the name of the server runtime, the home directory, the Java Runtime and which server configuration should be used when running the application server. The <guibutton>Open launch configuration</guibutton> button displays a dialog box for configuring the technical details of the application server instance. + The <guilabel>General Information</guilabel> subsection allows you to change the value for the <guilabel>Server name</guilabel> and <guilabel>Host name</guilabel>. By clicking on the <guilabel>Runtime Environment</guilabel> label a dialog box will be shown with options to change the name of the server runtime, the home directory, the Java Runtime and the server configuration that will be used when running the application server. The <guibutton>Open launch configuration</guibutton> button displays a dialog box that allows you to configure the technical details of the application server instance. </para> <para> - Below the <guilabel>General Information</guilabel> subsection is the <guilabel>Login Credentials</guilabel> subsection. Set the <guilabel>User Name</guilabel> and <guilabel>Password</guilabel> for secure access to your server. + Below the <guilabel>General Information</guilabel> subsection is the <guilabel>Login Credentials</guilabel> subsection. Here you can set the <guilabel>User Name</guilabel> and <guilabel>Password</guilabel> that will be used to provide secure access to your server. </para> <para> - The <guilabel>Publishing</guilabel> subsection at the top right of the <guilabel>Overview</guilabel> section allows you to set when applications will be published to the location specified (whether the applications will be made available through the application server depends on the server running and if it is configured to recognise dynamic changes). You can select to either never have an application be published automatically or for a check of new applications yet to be published to occur at a certain timed interval. + The <guilabel>Publishing</guilabel> subsection at the top right of the <guilabel>Overview</guilabel> section allows you to specify when applications will be published to the location specified (whether the applications will be made available through the application server depends on the server running and if it is configured to recognise dynamic changes). You can select to either never have an application be published automatically or for a check of new applications yet to be published to occur at a certain timed interval. </para> <para> - The <guilabel>Timeouts</guilabel> subsection below <guilabel>Publishing</guilabel> allows you to set the start and stop time (in seconds) for the server to complete all of its operations. This setting is made available in order to decrease the chance of the server freezing or hanging. + The <guilabel>Timeouts</guilabel> subsection below the <guilabel>Publishing</guilabel> subsections allows you to set the start and stop times (in seconds) in which the server should complete all of its operations. This setting is made available in order to decrease the chance of the server freezing or hanging. </para> <para> Below the <guilabel>Timeouts</guilabel> subsection is the <guilabel>Server Polling</guilabel> subsection. A server poller gathers information about the server at certain points in time, capturing information about processes and applications. This section allows you to select between either the <literal>JMX Poller</literal> or <literal>Timeout Poller</literal> for startup and the <literal>Process Terminated Poller</literal> or <literal>Timeout Poller</literal> for shutdown. </para> <para> - The final subsection is <guilabel>Server Ports</guilabel>, below <guilabel>Server Polling</guilabel>. This section allows you to alter the port numbers that the server pollers gather their information from. The two settings of <guilabel>JNDI Port</guilabel> and <guilabel>Web Port</guilabel> are set to be automatically detected by default; normally there should be no reason to manually select the port numbers. + The final subsection is called <guilabel>Server Ports</guilabel>, below the <guilabel>Server Polling</guilabel> subsection. This section allows you to alter the port numbers that the server pollers gather their information from. The two settings <guilabel>JNDI Port</guilabel> and <guilabel>Web Port</guilabel> are set to be automatically detected by default; normally there should be no reason to manually select the port numbers. </para> <note> <para> @@ -137,7 +137,7 @@ </para> </note> <para> - Default access to the server can be achieved by typing the address <ulink url="http://localhost:8080">http://localhost:8080</ulink> into your Internet browser address bar. + The default address of the server is <ulink url="http://localhost:8080">http://localhost:8080</ulink>, which you can type into your Internet browsers address bar. </para> <figure id="figu-Beginners_Guide-Use_of_the_application_server_shipped_with_JBoss_Tools_or_JBoss_Developer_Studio-Server_access"> <title>Server access</title> @@ -163,50 +163,51 @@ <orderedlist> <listitem> <para> - In the Eclipse interface click on <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice> + In the Eclipse interface click on <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Runtime Environments</guimenuitem></menuchoice>. </para> </listitem> <listitem> <para> - Click on the <guibutton>Add...</guibutton> button + Click on the <guibutton>Add...</guibutton> button. </para> </listitem> <listitem> <para> - Select the type of runtime environment your application server is from the list provided + Select the runtime environment type of your application server from the list provided. </para> </listitem> <listitem> <para> - Tick the box for <guilabel>Create a new local server</guilabel> + Tick the box for the <guilabel>Create a new local server</guilabel> option. </para> </listitem> <listitem> <para> - Click on the <guibutton>Next &gt;</guibutton> button + Click on the <guibutton>Next &gt;</guibutton> button. </para> </listitem> <listitem> <para> - Name your server runtime and then click on the <guibutton>Browse...</guibutton> button next to the <guilabel>Home Directory</guilabel> location space + Provide a name for your server runtime and then click on the <guibutton>Browse...</guibutton> button, next to the <guilabel>Home Directory</guilabel> location space. </para> </listitem> <listitem> <para> - Navigate to the directory where the server you wish to add is installed and click on the <guibutton>OK</guibutton> button + Navigate to the directory where the server you wish to add is installed and click on the <guibutton>OK</guibutton> button. </para> </listitem> <listitem> <para> - Select the Java Runtime Environment (JRE) you wish to use for this server from the drop-down menu. If the required JRE is not listed, click on the <guibutton>JRE</guibutton> button beside the list and then select the <guibutton>Add...</guibutton> button in the <guimenuitem>Installed JREs</guimenuitem> <guilabel>Preferences</guilabel> dialog box and follow the prompts to install the correct JRE + Select the Java Runtime Environment (JRE) you wish to use for this server from the drop-down menu. If the required JRE is not listed, click on the <guibutton>JRE</guibutton> button beside the list, click the <guibutton>Add...</guibutton> button in the <guimenuitem>Installed JREs</guimenuitem> + <guilabel>Preferences</guilabel> dialog box, and follow the prompts to install the correct JRE. </para> </listitem> <listitem> <para> - The <guilabel>Configuration</guilabel> section should automatically list the available profiles available for your server. Select the server configuration you wish to use by clicking on its name in the list + The <guilabel>Configuration</guilabel> section should automatically list the profiles available for your server. Select the server configuration you wish to use by clicking on its name in the list. </para> <para> - If the profile you wish to use is not listed click on the <guibutton>Browse...</guibutton> button, navigate to the profile location and click the <guibutton>OK</guibutton> button + If the profile you wish to use is not listed click on the <guibutton>Browse...</guibutton> button, navigate to the profile location and click the <guibutton>OK</guibutton> button. </para> </listitem> <listitem> @@ -219,10 +220,10 @@ </listitem> </orderedlist> <para> - Once the new sever has been added, you can select it for use by clicking on its name in the <guilabel>Server Runtime Environment</guilabel> list and then clicking the <guibutton>OK</guibutton> button that will then take you back to the main Eclipse interface. + Once the new sever has been added, you can select it for use by clicking on its name in the <guilabel>Server Runtime Environment</guilabel> list and then clicking the <guibutton>OK</guibutton> button, which will then take you back to the main Eclipse interface. </para> <para> - To start your new server, select it from those available through the <guimenu>Servers</guimenu> view and click the white arrow in a green circle. + To start your new server, select it from those available in the <guimenu>Servers</guimenu> view and click the button displaying a white arrow in a green circle. </para> <note> <para> @@ -230,7 +231,7 @@ </para> </note> </section> - + </section> </chapter>