Author: mcaspers Date: 2011-01-30 23:23:37 -0500 (Sun, 30 Jan 2011) New Revision: 28744 Modified: trunk/as/docs/reference/en-US/modules.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/modules.xml =================================================================== --- trunk/as/docs/reference/en-US/modules.xml 2011-01-31 04:11:32 UTC (rev 28743) +++ trunk/as/docs/reference/en-US/modules.xml 2011-01-31 04:23:37 UTC (rev 28744) @@ -1,24 +1,21 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="modules"> <title>Deploying Modules</title> - + <para>In this chapter it will be described how to deploy modules onto the server.</para> - <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> - + <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> - - <para>On the package explorer it is possible to publish either a project to a server or just - a single file. Let&apos;s look at how to do this.</para> + + <para>On the package explorer it is possible to publish either a project to a server or just a single file. Let&apos;s look at how to do this.</para> <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> + <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 <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server</guimenuitem></menuchoice>. 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> @@ -27,10 +24,7 @@ </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> + <para>Click the <guibutton>Next</guibutton> button to see add or remove projects page where you can choose projects to configure them on server.</para> <figure id="add_rem_proj"> <title>Add or Remove Projects</title> <mediaobject> @@ -39,42 +33,24 @@ </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> + <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 the <guibutton> &lt; Remove</guibutton>. 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 <filename>.war</filename>, <filename>.jar</filename>, or <filename>.ear</filename> as appropriate, and then copies that file into the proper deploy directory. For quicker smarter deployment, you will need to create archives using the Project Archives view (see <xref linkend="Project_archivesView"/>) and customize packaging yourself. + </para> - + </section> - + <section id="single_file_deployment"> <?dbhtml filename="DeployToServer.html"?> <title>Deploying single files</title> - - <para>Sometimes it becomes necessary to deploy one or more files to a server. For - that in order not to do a full republish in the context menu of files a <emphasis><property>Deploy To Server</property></emphasis> - option is provided that allows a single file deployment. To deploy these non-WTP files/projects - right click on the file (<emphasis> - <property>-ds.xml</property></emphasis>, <emphasis> - <property>.ear</property></emphasis>, <emphasis> - <property>.jar</property></emphasis> etc.) and select <emphasis> - <property>Deploy To Server</property> - </emphasis> and it will be automatically deployed.</para> + + <para> + Sometimes it becomes necessary to deploy one or more files to a server. For that in order not to do a full republish in the context menu of files a <guimenuitem>Deploy To Server</guimenuitem> option is provided that allows a single file deployment. To deploy these non-WTP files/projects right click on the file (<filename>-ds.xml</filename>, <filename>.ear</filename>, <filename>.jar</filename> etc.) and select <guimenuitem>Deploy To Server</guimenuitem> and it will be automatically deployed. + </para> <figure> <title>Deploy to Sever</title> <mediaobject> @@ -83,8 +59,7 @@ </imageobject> </mediaobject> </figure> - <para>The deployed files are listed side-by-side with other modules that are deployed to - the server.</para> + <para>The deployed files are listed side-by-side with other modules that are deployed to the server.</para> <figure> <title>Deployed files on the Server</title> @@ -94,21 +69,20 @@ </imageobject> </mediaobject> </figure> - + </section> - + </section> <section> <title>Deploying with Servers View</title> - <para>As it has been already mentioned <property>Servers</property> view contains two - parts: the top part that displays all defined servers and the bottom part which provides - categories with additional information. Thus, in this section we suggest two more ways - to deploy resources onto the server.</para> + <para> + As it has been already mentioned <guilabel>Servers</guilabel> view contains two parts: the top part that displays all defined servers and the bottom part which provides categories with additional information. Thus, in this section we suggest two more ways to deploy resources onto the server. + </para> <section> <title>Top part of Servers view</title> - <para>In the top part of the <property>Servers</property> view you should right click on a server and select the <emphasis> - <property>Add and Remove</property> - </emphasis> menu item.</para> + <para> + In the top part of the <guilabel>Servers</guilabel> view you should right click on a server and select the <guimenuitem>Add and Remove</guimenuitem> menu item. + </para> <figure> <title>Add and Remove Projects</title> <mediaobject> @@ -117,28 +91,17 @@ </imageobject> </mediaobject> </figure> - - <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing - you to either publish projects or modules to a server, or remove them from the - server. If the selected module is a project like a Dynamic Web project, EJB project, - or EAR project, it will be published as through <emphasis> - <property>Run on Server</property> - </emphasis> wizard, with a best-guess full package. If, however, the selected - element is an archive from the <link linkend="Project_archivesView">Project Archives - view</link>, it will be published according to the rules of that module - type.</para> + + <para> + This will bring up a dialog (see <xref linkend="add_rem_proj"/>) that allows you to either publish projects or modules to a server, or remove them from the server. If the selected module is a project like a Dynamic Web project, EJB project, or EAR project, it will be published as through <guilabel>Run on Server</guilabel> wizard, with a best-guess full package. If, however, the selected element is an archive from the Project Archives view (see <xref linkend="Project_archivesView"/>), it will be published according to the rules of that module type. + </para> </section> - + <section> <title>Bottom part of Servers view</title> - <para>In the bottom part of <emphasis> - <property>Servers</property> view - </emphasis> there is a category called <emphasis> - <property>Modules</property> - </emphasis> which should display all currently-published modules on the server. - Right-clicking on the desired module and selecting <emphasis> - <property>Full Publish</property> - </emphasis> will force a full rebuild of the entire module.</para> + <para> + In the bottom part of <guilabel>Servers</guilabel> view there is a category called <guilabel>Modules</guilabel> which should display all currently-published modules on the server. Right-clicking on the desired module and selecting <guimenuitem>Full Publish</guimenuitem> will force a full rebuild of the entire module. + </para> <figure> <title>Full Publish</title> <mediaobject> @@ -147,19 +110,17 @@ </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> + + <para> + Here, <guilabel>Incremental Publish</guilabel> 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> - <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> + <para> + In the <guilabel>Project Archives View</guilabel> you can right-click on any declared archive and select the <guilabel>Publish To Server</guilabel> element. For more on this subject, see <xref linkend="PublishToServer"/> in the Project Archives View section. + </para> <figure> <title>Publish to Server</title> <mediaobject> @@ -168,16 +129,9 @@ </imageobject> </mediaobject> </figure> - <para> The only way to ensure an <emphasis> - <property>Incremental Build</property> - </emphasis>, such as changes to one <emphasis> - <property>.jsp</property>, </emphasis> - <emphasis> - <property>.html</property>, </emphasis> or <emphasis> - <property>.class</property> - </emphasis> file, is to enable the builder for that project. This is done by either - changing the global preferences for the <property>Archives View</property>, or by - enabling project-specific preferences and ensuring the builder is on.</para> + <para> + The only way to ensure an <guilabel>Incremental Build</guilabel>, such as changes to one <filename>.jsp</filename>, <filename>.html</filename>, or <filename>.class</filename> file, is to enable the builder for that project. This is done by either changing the global preferences for the <guilabel>Archives View</guilabel>, or by enabling project-specific preferences and ensuring the builder is on. + </para> <para>You can also use the "Finger touch" button for a quick restart of the project without restarting the server:</para> <figure> @@ -187,11 +141,12 @@ <imagedata fileref="images/modules/modules_8_finger_touch.png"/> </imageobject> </mediaobject> - </figure> - <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</para> + </figure> - - <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a - server.</para> + <para> + The "Finger" touches descriptors dependent on project (i.e. <filename>web.xml</filename> for WAR, <filename>application.xml</filename> for EAR, <filename>jboss-esb.xml</filename> in ESB projects). + </para> + + <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a server.</para> </section> </chapter>