Author: ochikvina Date: 2008-02-15 13:06:19 -0500 (Fri, 15 Feb 2008) New Revision: 6353 Modified: trunk/as/docs/reference/en/modules/modules.xml trunk/as/docs/reference/en/modules/perspective.xml trunk/as/docs/reference/en/modules/runtimes_servers.xml trunk/as/docs/reference/en/modules/webtools.xml Log: http://jira.jboss.com/jira/browse/JBDS-199 - making changes in the chapters according to SVetlana remarks Modified: trunk/as/docs/reference/en/modules/modules.xml =================================================================== --- trunk/as/docs/reference/en/modules/modules.xml 2008-02-15 18:05:14 UTC (rev 6352) +++ trunk/as/docs/reference/en/modules/modules.xml 2008-02-15 18:06:19 UTC (rev 6353) @@ -6,69 +6,75 @@ <para> First of all it is necessary to say that deploying to a server is mostly painless. There are several ways to do it provided by WTP, and some additional methods provided by JBoss Tools. These methods are described further in this chapter.</para> - + <section> <title>Deploying on the Package Explorer</title> - <section> - <title>Deploying with Run On Server wizard</title> - <para> The first WTP method is to right-click on a project, such as a Dynamic Web project, - EJB project, or EAR project and then select <emphasis> - <property>Run As &gt; Run on Server</property> - </emphasis>. The resulting dialog allows you to select which supporting server the - project can be published to.</para> - <figure> - <title>Define a New Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click <emphasis> - <property>Next</property> - </emphasis> button to see add or remove projects page where you can choose projects to - configure them on server.</para> - <figure> - <title>Add or Remove Projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/modules/modules_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para> For the JBoss AS Server Adapters, publishing using this method will force a default, - best-guess, packaging configuration for your project. This best-guess does not publish - incrementally, but instead repackages your entire project into a <emphasis> - <property>.war</property></emphasis>, <emphasis> - <property>.jar</property></emphasis>, or <emphasis> - <property>.ear</property></emphasis> as - appropriate, and then copies that file into the proper deploy directory. For quicker - smarter deployment, you will need to create archives using the <link - linkend="Project_archivesView">Project Archives view</link> and customize packaging - yourself.</para> - </section> - + <section id="run_on_server_wizard"> + <title>Deploying with Run On Server Wizard</title> + <para> The first WTP method is to right-click on a project, such as a Dynamic Web + project, EJB project, or EAR project and then select <emphasis> + <property>Run As &gt; Run on Server</property> + </emphasis>. The resulting dialog allows you to select which supporting server the + project can be published to.</para> + <figure> + <title>Define a New Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property>Next</property> + </emphasis> button to see add or remove projects page where you can choose projects + to configure them on server.</para> + <figure> + <title>Add or Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>This page of the wizard also allows to undeploy modules from the server. For that + choose proper module(s) from the right and click <emphasis> + <property> &lt; Remove</property> + </emphasis>. The modules will be completely undeployed after restarting your server or republishing.</para> + <para>Generally, for the JBoss AS Server Adapters, publishing using this method will force a + default, best-guess, packaging configuration for your project. This best-guess does + not publish incrementally, but instead repackages your entire project into a <emphasis> + <property>.war</property> + </emphasis>, <emphasis> + <property>.jar</property> + </emphasis>, or <emphasis> + <property>.ear</property> + </emphasis> as appropriate, and then copies that file into the proper deploy + directory. For quicker smarter deployment, you will need to create archives using + the <link linkend="Project_archivesView">Project Archives view</link> and customize + packaging yourself.</para> + </section> + <section id="single_file_deployment"> <?dbhtml filename="DeployToServer.html"?> <title>Deploying single files</title> - <para>In the context menu of files there is a <property>Deploy To Server</property> option - that allows a single file deployment. To deploy these non-WTP files/projects right click - on the file (-ds.xml, .ear, .jar etc.) and select <emphasis> - <property>Deploy To server</property> - </emphasis> and it will be automatically deployed.</para> + <para>In the context menu of files there is a <property>Deploy To Server</property> + option that allows a single file deployment. To deploy these non-WTP files/projects + right click on the file (-ds.xml, .ear, .jar etc.) and select <emphasis> + <property>Deploy To server</property> + </emphasis> and it will be automatically deployed.</para> <figure> - <title>Deploy to Sever</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/perspective/perspective_16.png"/> - </imageobject> - </mediaobject> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"/> + </imageobject> + </mediaobject> </figure> - <para>The deployed files are listed side-by-side with other modules that are deployed to the - server.</para> - - </section> + <para>The deployed files are listed side-by-side with other modules that are deployed to + the server.</para> + </section> + </section> <section> <title>Deploying with JBoss Server View</title> @@ -79,8 +85,8 @@ we suggest two more ways to deploy resources onto the server.</para> <section> <title>Top part of JBoss Server View</title> - <para>In the top part of the <property>JBoss Servers View</property> like in the Servers View you should - right click on a server and select the <emphasis> + <para>In the top part of the <property>JBoss Servers View</property> like in the Servers + View you should right click on a server and select the <emphasis> <property>Add and Remove Projects</property> </emphasis> menu item. This will bring up a dialog allowing you to either publish projects or modules to a server, or remove them from the server.</para> @@ -120,20 +126,20 @@ </imageobject> </mediaobject> </figure> - + <para>Here, <emphasis> - <property>Incremental Publish</property> - </emphasis> is meant to enable publishing of only those parts where changes have been made.</para> + <property>Incremental Publish</property> + </emphasis> is meant to enable publishing of only those parts where changes have + been made.</para> </section> </section> <section> <title>Deploying with Project Archives View</title> - <para>In the <property>Project Archives View</property> you can right-click on any declared archive and select - the <emphasis> + <para>In the <property>Project Archives View</property> you can right-click on any declared + archive and select the <emphasis> <property>Publish To Server</property> - </emphasis> element. For more on this subject, see <link - linkend="PublishToServer">Publishing to Server</link> in the Project Archives - View section.</para> + </emphasis> element. For more on this subject, see <link linkend="PublishToServer" + >Publishing to Server</link> in the Project Archives View section.</para> <figure> <title>Publish to Server</title> <mediaobject> Modified: trunk/as/docs/reference/en/modules/perspective.xml =================================================================== --- trunk/as/docs/reference/en/modules/perspective.xml 2008-02-15 18:05:14 UTC (rev 6352) +++ trunk/as/docs/reference/en/modules/perspective.xml 2008-02-15 18:06:19 UTC (rev 6353) @@ -282,12 +282,6 @@ <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> @@ -310,7 +304,7 @@ </mediaobject> </figure> - <para>In order to access the view's preferences, you should access <emphasis> + <para>In order to access the view&apos;s preferences, you should access <emphasis> <property>Window &gt; Preferences &gt; JBoss Tools &gt; JBoss Servers &gt; View</property> </emphasis>. This preference page allows you to select which view extensions you @@ -407,8 +401,12 @@ what its current value is.</para> <para> By right-clicking on <emphasis> - <property>XML Configuration</property> - </emphasis>, you can create a new category. </para> + <property>XML Configuration</property>, + </emphasis> you can create a new category. Besides, context menu for <emphasis> + <property>XML Configuration</property> + </emphasis> category makes possible to disable it. You can disable any category in the bottom part of the <emphasis> + <property>JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property>Inactive Categories</property></emphasis> afterwards to re-enable.</para> <figure> <title>Adding New Category</title> @@ -479,8 +477,10 @@ </mediaobject> </figure> - <para>Notice, when you type the fields autocomplete to help you locate exactly what - xpath you&apos;re looking for. </para> + <note> + <title>Tip:</title> + <para>Notice, when you type the fields autocomplete to help you locate exactly what + xpath you&apos;re looking for.</para></note> <para>Then, on the other hand, if your desired field is the text of an element <emphasis>&lt;description&gt;</emphasis>, your <emphasis> @@ -513,8 +513,14 @@ </mediaobject> </figure> + <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> <para/> + </section> <section id="Project_archivesView"> @@ -587,8 +593,8 @@ <property>WAR</property> archive, the archive will be created with a few filesets relevant to the known structure of the project.</para> - <para>Because the first page of all new archive wizards are the same, and it is also the - only page in the <property>New Jar Wizard</property>, that page is shown below.</para> + <para>Here is the first page of all New archive wizards. It is the same for any archive type and the + only page in the <property>New Jar Wizard</property>.</para> <figure> <title>New JAR Wizard</title> <mediaobject> @@ -607,7 +613,7 @@ respective buttons. To select a destination inside some other archive, you'll need to press the <emphasis> <property>Workspace...</property> - </emphasis> button. At the bottom of the list, you'll see archives that have been + </emphasis> button. At the bottom of the list, you&apos;ll see archives that have been declared in the workspace.</para> <section id="CreatingaFolder"> <title>Creating a Folder</title> @@ -751,7 +757,13 @@ server, it might be easier to have the archive's destination folder be the deploy folder of the server.</para> </section> + <section> + <title>Relevant Resources Links</title> + <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> to find more on how to build your applications with help of Ant.</para> + </section> </section> + <!--para>Now you are guessed to be familiar with <emphasis> + <property>JBoss AS Perspective</property></emphasis>. </para--> </chapter> Modified: trunk/as/docs/reference/en/modules/runtimes_servers.xml =================================================================== --- trunk/as/docs/reference/en/modules/runtimes_servers.xml 2008-02-15 18:05:14 UTC (rev 6352) +++ trunk/as/docs/reference/en/modules/runtimes_servers.xml 2008-02-15 18:06:19 UTC (rev 6353) @@ -170,7 +170,7 @@ <para>WTP servers are eclipse-representations of a backing server installation. They are used to start or stop servers, deploy to servers, or debug code that will run on the server. They keep track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy - those modules. </para> + those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server Wizard</link> section). </para> <para>Servers can be started or stopped with different command-line arguments. They are often backed by a runtime object representing that server's location.</para> <section> @@ -226,6 +226,8 @@ </mediaobject> </figure> + <para>Press <emphasis> + <property>Finish</property></emphasis> to complete the process of the server creation.</para> <para>Now that we&apos;ve created our runtimes and servers, we can dwell on all services and tools that JBoss Server Manager provides.</para> </section> Modified: trunk/as/docs/reference/en/modules/webtools.xml =================================================================== --- trunk/as/docs/reference/en/modules/webtools.xml 2008-02-15 18:05:14 UTC (rev 6352) +++ trunk/as/docs/reference/en/modules/webtools.xml 2008-02-15 18:06:19 UTC (rev 6353) @@ -8,7 +8,7 @@ type of project.</para> <section> - <title>Description</title> + <title>Faceted Projects Overview</title> <para>The idea behind faceted projects is that each project can accept units of functionality, or facets, which can be added or removed by the user. Most often, these facets either add to the project's classpath, enable a builder, or watch the project in @@ -43,6 +43,19 @@ <property>Modify Project...</property> </emphasis> button.</para> + + <figure> + <title>Adding Facets to the Existing Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_0.png"/> + </imageobject> + </mediaobject> + </figure> + + + + <para>The other way is adding necessary facets while organizing a new project. To demonstrate it let&apos;s create a new <property>Dynamic Web Project</property> selecting as usual <emphasis> @@ -87,6 +100,6 @@ described above. Some facets may require others, and some may conflict with others, but on the whole this page allows you to add any number of facets that don't conflict with each other. </para> - <para> Further pages are specific to either the project type, or the facets selected.</para> + <para> Further pages in the wizard are specific to either the project type, or the facets selected.</para> </section> </chapter>