[jbosstools-commits] JBoss Tools SVN: r6318 - trunk/as/docs/reference/en/modules.

Author: ochikvina Date: 2008-02-14 12:06:42 -0500 (Thu, 14 Feb 2008) New Revision: 6318 Modified: trunk/as/docs/reference/en/modules/perspective.xml trunk/as/docs/reference/en/modules/quick_start.xml trunk/as/docs/reference/en/modules/runtimes_servers.xml Log: http://jira.jboss.com/jira/browse/JBDS-199 - making changes according to remarks oF Svetlana Mukhina Modified: trunk/as/docs/reference/en/modules/perspective.xml =================================================================== --- trunk/as/docs/reference/en/modules/perspective.xml 2008-02-14 17:05:04 UTC (rev 6317) +++ trunk/as/docs/reference/en/modules/perspective.xml 2008-02-14 17:06:42 UTC (rev 6318) @@ -44,9 +44,9 @@ </figure> - <para>The view's toolbar shown below provides quick access to starting a server (in debug - mode, run mode, or profile mode), restarting a server, stopping a server, or publishing - to a server.</para> + <para>The view's toolbar provides quick access to starting a server (in debug mode, run + mode, or profile mode), restarting a server, stopping a server, or publishing to a + server.</para> <figure> <title>The JBoss Server View Toolbar</title> <mediaobject> @@ -132,14 +132,14 @@ </tgroup> </table> - <para>By double-clicking on any server an editor window will appear allowing you to edit - parts of that server. The editor will also link you to modify that server's launch - configuration, set command line arguments, and other things that are relevant to - launching the server.</para> + <para>By double-clicking on any server, an editor window will appear allowing you to + edit parts of that server. The editor will also link you to modify that server's + launch configuration, set command line arguments, and other things that are relevant + to launching the server.</para> - <para>On the figure below you can see that a username/password is available in the UI - when configuring the server. If you get an SecurityException when trying to launch - the server, it is most likely because your server is protected and hence you need to + <para>On the figure you can see that a username/password is available in the UI when + configuring the server. If you get an SecurityException when trying to launch the + server, it is most likely because your server is protected and hence you need to fill the username/password fields with appropriate values.</para> <figure> @@ -151,9 +151,8 @@ </mediaobject> </figure> - <para>As the JBoss servers have few properties to edit in the editor, a shortcut to the - launch configuration has been provided in the context menu when right-clicking on a - server.</para> + <para>As the JBoss servers have few properties to edit here, a shortcut to the launch + configuration has been provided in the context menu when right-clicking on a server.</para> <figure> <title>Launch Configuration</title> @@ -189,7 +188,7 @@ <para>New Server</para> </entry> <entry> - <para>The option allows to define a new server.</para> + <para>The option allows to define a new server</para> </entry> </row> @@ -198,8 +197,7 @@ <para>Delete</para> </entry> <entry> - <para>Standard option that allows to delete the chosen - server.</para> + <para>Standard option that allows to delete the chosen server</para> </entry> </row> @@ -208,7 +206,7 @@ <para>Start</para> </entry> <entry> - <para>The action for stating a server in a run mode.</para> + <para>The action for stating a server in a run mode</para> </entry> </row> @@ -217,7 +215,7 @@ <para>Debug</para> </entry> <entry> - <para>The action for stating a server in a debug mode.</para> + <para>The action for stating a server in a debug mode</para> </entry> </row> @@ -226,7 +224,7 @@ <para>Stop</para> </entry> <entry> - <para>The action for stopping a declared server.</para> + <para>The action for stopping a declared server</para> </entry> </row> @@ -236,7 +234,7 @@ </entry> <entry> <para>The action for synching the publish information between the - server and workspace.</para> + server and workspace</para> </entry> </row> @@ -245,7 +243,7 @@ <para>Clean</para> </entry> <entry> - <para>The option for complete redeploying the resources.</para> + <para>The option for complete redeploying the resources</para> </entry> </row> @@ -255,7 +253,7 @@ </entry> <entry> <para>The option provides a dialog for running Twiddle commands - against the Twiddle Server.</para> + against the Twiddle Server</para> </entry> </row> @@ -265,7 +263,7 @@ </entry> <entry> <para>The option that provides an editor for editing launch - configuration properties of the proper server.</para> + configuration properties of the proper server</para> </entry> </row> @@ -275,7 +273,7 @@ </entry> <entry> <para>The option allows to publish a new project to the server (if - its type is supported).</para> + its type is supported)</para> </entry> </row> </tbody> @@ -284,6 +282,12 @@ <para>Mentioned above Twiddle is a JMX library that comes with JBoss, and you can use it to access any variables that exposed via the JBoss JMX interfaces.</para> + + <section> + <title>Relevant Resources Links</title> + <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + Documentation</ulink>.</para> + </section> </section> <section> @@ -372,11 +376,11 @@ <property>XML Configuration</property> </emphasis> category allows you to quickly browse to descriptor files in your server's deploy directory and check or change the values. Its use requires the - <property>Properties view</property>. Basically, <emphasis> + <property>Properties view</property>. Basically, <emphasis> <property>XML Configuration</property> </emphasis> includes XML XPaths where a xpath is a path used to access some specific part of an xml document. </para> - + <figure> <title>XML Configuration and Properties View</title> <mediaobject> @@ -386,8 +390,10 @@ </mediaobject> </figure> - <note><para>You are assumed to be familiar with XPath. If not, we highly suggested that you - look through an appropriate manual or tutorial on the topic.</para></note> + <note> + <para>You are assumed to be familiar with XPath. If not, we highly suggested that + you look through an appropriate manual or tutorial on the topic.</para> + </note> <para>The <emphasis> <property>XML Configuration</property> @@ -613,7 +619,8 @@ <title>Creating a FileSet</title> <para>To create a new fileset, you click on an available target location such as an archive, a nested archive, or a folder within an archive, and select <emphasis> - <property>New Fileset</property></emphasis>.</para> + <property>New Fileset</property> + </emphasis>.</para> <figure> <title>Adding a New FileSet</title> Modified: trunk/as/docs/reference/en/modules/quick_start.xml =================================================================== --- trunk/as/docs/reference/en/modules/quick_start.xml 2008-02-14 17:05:04 UTC (rev 6317) +++ trunk/as/docs/reference/en/modules/quick_start.xml 2008-02-14 17:06:42 UTC (rev 6318) @@ -1,50 +1,55 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="quick_start"> <title>Quick Start with JBoss Server</title> - - <para>This chapter covers the basics of working with the JBoss server. If you already have installed JBoss server and runtime you can quickly learn - how to configure, start, stop the server, to know deployment and archiving processes. How to install runtimes and servers read in the - <link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> chapter.</para> - - <para>To start working with JBoss AS, select a <property>JBoss AS Perspective</property> via - <emphasis><property>Window > Open Perspective > Other > JBoss AS</property>.</emphasis></para> - -<section id="starting"> - <title>Starting JBoss server</title> - - <para>Starting JBoss server is quite simple. You can control the server behaviour with the help of a special toolbar in the - <property>JBoss Server View</property> where you could <property>start</property> it in a regular or debug mode, - <property>stop</property> it or <property>restart</property> it, <property>publish</property> to the server.</para> - - <figure> - <title>JBoss Server Toolbar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>To launch the server click the green-with-white-arrow icon on the <property>JBoss Server View </property>or right click server name in this view and - select <emphasis><property>Start</property></emphasis>. If this view is not open, select <emphasis><property>Window &gt; Show View &gt; Other &gt; Server &gt; - JBoss Server View</property>.</emphasis></para> - - <figure> - <title>Start JBoss Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/quick_start/quick_start2.png"/> - </imageobject> - </mediaobject> - </figure> - -</section> - + + <para>This chapter covers the basics of working with the JBoss server. If you already have + installed JBoss server and runtime you can quickly learn how to configure, start, stop the + server, to know deployment and archiving processes. How to install runtimes and servers read in + the <link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> chapter.</para> + + <para>To start working with JBoss AS, select a <property>JBoss AS Perspective</property> via + <emphasis><property>Window > Open Perspective > Other > JBoss AS</property>.</emphasis></para> + + <section id="starting"> + <title>Starting JBoss server</title> + + <para>Starting JBoss server is quite simple. You can control the server behaviour with the help + of a special toolbar in the <property>JBoss Server View</property> where you could + <property>start</property> it in a regular or debug mode, <property>stop</property> it or + <property>restart</property> it, <property>publish</property> to the server.</para> + + <figure> + <title>JBoss Server Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To launch the server click the green-with-white-arrow icon on the <property>JBoss Server + View </property>or right click server name in this view and select <emphasis> + <property>Start</property> + </emphasis>. If this view is not open, select <emphasis><property>Window &gt; Show View + &gt; Other &gt; Server &gt; JBoss Server View</property>.</emphasis></para> + + <figure> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start2.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="stopping"> <title>Stopping JBoss Server</title> - - <para>To stop the server, click the <property>Stop</property> icon in JBoss Server View or right click the server name and press <property>Stop</property>.</para> - + + <para>To stop the server, click the <property>Stop</property> icon in JBoss Server View or right + click the server name and press <property>Stop</property>.</para> + <figure> <title>Stop JBoss Server</title> <mediaobject> @@ -53,19 +58,23 @@ </imageobject> </mediaobject> </figure> - - <para>When the server is stopped you will see <property>Stopped</property> next to its name in the State column.</para> + + <para>When the server is stopped you will see <property>Stopped</property> next to its name in + the State column.</para> <para>Learn more about the JBoss Server View <link linkend="JBossServerView">here</link>.</para> </section> - + <section id="archiving"> - + <title>Project Archiving</title> - - <para>JBoss Tools comes with our own archives tool. The Project Archives plugin consists primarily of a view to set up each packaging configuration - (<emphasis><property>Window > Show View > Other > JBoss Tools > Project archives</property></emphasis>).</para> - <para>Right clicking in the Project archives view you can create War, EJB War or EAR archive.</para> - + + <para>JBoss Tools comes with our own archives tool. The Project Archives plugin consists + primarily of a view to set up each packaging configuration (<emphasis> + <property>Window > Show View > Other > JBoss Tools > Project archives</property> + </emphasis>).</para> + <para>Right clicking in the <property>Project Archives View</property> you can create War, EJB + War or EAR archive.</para> + <figure> <title>Archive Creating</title> <mediaobject> @@ -74,10 +83,11 @@ </imageobject> </mediaobject> </figure> - - <para>Using the context menu on the item you can initiate a full <property>build</property> on archive, <property>edit</property>, - <property>delete</property> or <property>publish</property> it.</para> - + + <para>Using the context menu on the item you can initiate a full <property>build</property> on + archive, <property>edit</property>, <property>delete</property> or + <property>publish</property> it.</para> + <figure> <title>Context Menu on the Item</title> <mediaobject> @@ -86,22 +96,32 @@ </imageobject> </mediaobject> </figure> - - <para>Learn more about the <property>Project archives View</property> <link linkend="Project_archivesView">here</link>.</para> - + + <para>Learn more about the <property>Project Archives View</property> + <link linkend="Project_archivesView">here</link>.</para> + </section> <section id="deployment"> <title>Deploying an Application to a Server</title> - + <para>There are two times to deploy your application:</para> <itemizedlist> - <listitem><para>While creating it</para></listitem> - <listitem><para>After it already exists</para></listitem> + <listitem> + <para>While creating it</para> + </listitem> + <listitem> + <para>After it already exists</para> + </listitem> </itemizedlist> - - <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project wizards, the one of wizards steps - has a Target Runtime and Target Server sections. You can deploy the application through the appropriate selection in these sections.</para> - + + <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project + wizards, the one of wizards steps has a <emphasis> + <property>Target Runtime</property> + </emphasis> and <emphasis> + <property>Target Server</property> + </emphasis> sections. You can deploy the application through the appropriate selection in + these sections.</para> + <figure> <title>Runtime and Server Sections in the New Project Wizard</title> <mediaobject> @@ -110,10 +130,11 @@ </imageobject> </mediaobject> </figure> - - <para>You can deploy an existing application to a server by right-clicking the target defined server in the <property>JBoss Servers View</property> - and then selecting <property>Add and Remove Projects</property> from the context menu.</para> - + + <para>You can deploy an existing application to a server by right-clicking the target defined + server in the <property>JBoss Servers View</property> and then selecting <property>Add and + Remove Projects</property> from the context menu.</para> + <figure> <title>Add and Remove Projects From the Context Menu.</title> <mediaobject> @@ -122,10 +143,11 @@ </imageobject> </mediaobject> </figure> - - <para>If this application is not assigned to a server, it will be in the left-hand available projects list. Clicking on the <property>Add ></property> button will add it to - the right-hand configured projects list and deploy the application to this server.</para> - + + <para>If this application is not assigned to a server, it will be in the left-hand available + projects list. Clicking on the <property>Add ></property> button will add it to the right-hand + configured projects list and deploy the application to this server.</para> + <figure> <title>Modifying The Projects that are Configured on the Server</title> <mediaobject> @@ -134,8 +156,9 @@ </imageobject> </mediaobject> </figure> - - - </section> - -</chapter> + + + </section> + <para>Here, we have just performed the basic steps you should know to quick start with JBoss + server. In fact, there are more functionalities which you can make use of. Further we will talk about them in detail.</para> +</chapter> Modified: trunk/as/docs/reference/en/modules/runtimes_servers.xml =================================================================== --- trunk/as/docs/reference/en/modules/runtimes_servers.xml 2008-02-14 17:05:04 UTC (rev 6317) +++ trunk/as/docs/reference/en/modules/runtimes_servers.xml 2008-02-14 17:06:42 UTC (rev 6318) @@ -14,17 +14,16 @@ <para>In this chapter we will discuss how to install runtimes and servers.</para> - <para>The JBoss AS plugin makes use of WTP. This includes starting and stopping servers in run or + <para>First of all it&apos;s necessary to mention that the JBoss AS plugin makes use of WTP. This includes starting and stopping servers in run or debug mode. It also includes targeting WTP projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the proper jars from a specific server are added to the project&apos;s classpath properly.</para> - <para>In order to get started creating, running, and debugging J2EE applications, we must start - with creating our <property>runtime</property> and <property>server</property> instances.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we should create our <property>runtime</property> and <property>server</property> instances.</para> <section> <title>Runtimes</title> <para>In JBoss Tools, the main purpose of Server Runtimes is to point to a server installation - somewhere on disk. In our case, this will be a JBoss installation, and it can than be used for + somewhere on disk. In our case, this will be a JBoss installation, and it can then be used for two primary purposes:</para> <itemizedlist> <listitem> @@ -57,7 +56,7 @@ <para>To create a JBoss runtime click <emphasis> <property>Add</property> - </emphasis> button and choose necessary type of runtime from the appeared dialog. </para> + </emphasis> button and choose a necessary type of runtime from the appeared dialog. </para> <figure> <title>Adding a Runtime</title> @@ -68,7 +67,7 @@ </mediaobject> </figure> - <para>As seen above, <property>JBoss Tools</property> provides + <para>As shown on the above figure, <property>JBoss Tools</property> provides its own updated and supported adapters such as JBoss 3.2, 4.0, and 4.2. You&apos;ll also note a Deploy-Only Runtime type. This type provides no classpath for WTP projects. It is used solely by its server type for the purpose of setting up a deploy @@ -109,7 +108,7 @@ <para>Name</para> </entry> <entry> - <para>The name of a new Runtime for chosen server. We suggest that you + <para>The name of a new Runtime for a chosen server. We suggest that you don&apos;t leave a default value. It&apos;s better to give descriptive names that will help to distinguish one runtime from another.</para> </entry> @@ -132,7 +131,7 @@ <para>The proper Java Runtime Environment. Because of the open-source nature of JBoss, a user is likely to want to modify and repackage some of the configuration-specific jboss jars and create their own configuration. Thus, rather - than forcing the user to copy his entire JBoss installation, the structure of the + than forcing you to copy his entire JBoss installation, the structure of the wizard allows to create only a new configuration instead.</para> </entry> </row> @@ -142,7 +141,7 @@ <para>Configuration</para> </entry> <entry> - <para>The lists of configurations (all, default, minimal) that is updated as soon as you browse to a valid + <para>The list of configurations (all, default, minimal) that is updated as soon as you browse to a valid runtime installation folder. After the runtime is created the configuration becomes an unchanging property of that runtime. To compile against a different configuration's jars, you will need to create a new runtime from @@ -154,13 +153,6 @@ </tgroup> </table> - <!--para>Once the runtime is created, the configuration is an unchanging property of that - runtime. This is because many of the jars necessary to provide for classpaths, such as the - ejb3 jar locations or the servlet jar locations, are located in deploy directories of each - configurations (depending on which version of JBoss is being used). Because of this, to - compile against a different configuration's jars, you will need to create a new runtime from - that configuration.</para--> - <para>As a result of having each runtime represent a specific configuration rather than the server installation as a whole, it is very likely you&apos;ll create several different runtimes to test each of your configurations. It becomes important to ensure your runtimes, and later @@ -222,8 +214,8 @@ linkend="add_runtime_figure">the previous section</link> will ask you to create the associated runtime.</para> <para>Either way, after targeting your server to a runtime, the final screen in this wizard is - largely confirmational, giving the user a chance to verify that he's selected the - appropriate runtime. It also allows the user to name the server appropriately. </para> + largely confirmational, giving you a chance to verify that you&apos;ve selected the + appropriate runtime. It also allows to name the server appropriately. </para> <figure> <title>Installed Server Runtime Environments</title>