From jbosstools-commits at lists.jboss.org Sun Jan 30 19:43:04 2011 Content-Type: multipart/mixed; boundary="===============2476147648817838977==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28738 - trunk/as/docs/reference/en-US. Date: Sun, 30 Jan 2011 19:43:04 -0500 Message-ID: <201101310043.p0V0h4tZ012140@svn01.web.mwc.hst.phx2.redhat.com> --===============2476147648817838977== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-01-30 19:43:03 -0500 (Sun, 30 Jan 2011) New Revision: 28738 Modified: trunk/as/docs/reference/en-US/quick_start.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/quick_start.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/as/docs/reference/en-US/quick_start.xml 2011-01-30 22:38:37 UTC (= rev 28737) +++ trunk/as/docs/reference/en-US/quick_start.xml 2011-01-31 00:43:03 UTC (= rev 28738) @@ -1,293 +1,290 @@ - Quick Start with JBoss Server + Quick Start with JBoss Server = - This chapter covers the basics of working with the JBoss= Server. - = -
- Key Features of JBoss Server - For a start, we propose you to look through the table of main fe= atures of JBoss Server: - = - - = - Key Functionality for JBoss AS and Archive Tools - - = - - - - = - - - Feature - Benefit - Chapter - - - - - JBoss AS plugin - Using WTP, JBoss AS plugin allows working with th= e server in run or debug mode. You can easily install runtimes and servers,= copy the existing runtime configuration or configure it up to your needs.<= /para> - - runtimes and servers - - - = - - JBoss AS Perspective - It makes managing installed JBoss Server quite ea= sy and includes the standard Console and Properties views, and specially a= dded Project archives view and Servers view for that purpose. - - JBoss AS perspective - - - = - - Modules Deployment - A number of ways, provided by WTP and JBoss Tools= , to deploy either a project or a single file on the server. - - deploying modules - - - = - - TPTP Support - Test and Performance Tools Platform (TPTP) profi= ling. - - TPTP support - - - = - - = - -
+ This chapter covers the basics of working with the JBoss = Server. + +
+ Key Features of JBoss Server + The table below lists the main features included in JBoss Server:<= /para> + + + = + Key Functionality for JBoss AS and Archive Tools + + + + + + + + + Feature + Benefit + Chapter + + + + + + JBoss AS plugin + + + + Using WTP, the JBoss AS plugin allows you to work with the server = in run or debug mode. You can easily install runtimes and servers, copy the= existing runtime configuration or configure it up to your needs. + + + + runtimes and servers + + + + + + JBoss AS Perspective + + + + It allows for easy management of an installed JBoss Server and inc= ludes the standard Console and Properties views, and the specially added P= roject archives and Servers views. + + + + JBoss AS perspective + + + + + + Modules Deployment + + + Provides a number of ways, using WTP and JBoss Tools, to depl= oy either a project or a single file on the server. + + + deploying modules + + + + + + TPTP Support + + + Test and Performance Tools Platform (TPTP) profiling. + + + TPTP support + + + + + + +
= - 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 in= stall runtimes and servers - read in the Runtimes and Servers in= the JBoss AS plugin - chapter. + + If you already have installed the JBoss server and runtime this documen= t will show you how to configure, start and stop the server, as well as the= deployment and archiving processes. Installing runtimes and servers is cov= ered in more detail in . + = - To start working with JBoss AS, select a JBoss AS Persp= ective via - Window > Show View > Other > Server > Servers. -
+ + To start working with JBoss AS, select the JBoss AS Perspective via WindowShow ViewOtherServer= Servers. + +
= -
- Starting JBoss Server +
+ Starting JBoss Server = - Starting JBoss Server is quite simple. You = can control the server - behaviour with the help of a special toolbar in the Server= s view - where you could - start - it in a regular or debug mode, - stop - it or - restart - it and - publish - to the server. + + Starting JBoss Server is quite simple. You c= an control the server behavior with the help of a special toolbar in the Servers view where you can start = it in a regular or debug mode, stop or re= start it, and publish to the server. + = -
- Servers Toolbar - - - - - -
+
+ Servers Toolbar + + + + + +
= - To launch the server click the green-with-white-arrow icon on th= e Servers - view or right click server name in this view and selec= t - Start. If this view is not open, = select - Window > Show View > Other > Server= > - Servers. + + To launch the server click the green-with-white-arrow icon on the Servers view or right click server name in this view and se= lect Start. If this view is not open, select WindowShow ViewOtherServerServers. + = -
- Start JBoss Server - - - - - -
+
+ Start JBoss Server + + + + + +
= -
+
= -
- Stopping JBoss Server +
+ Stopping JBoss Server = - To stop the server, click the - Stop - icon in the Servers view or right c= lick the server name - and press Stop. + + To stop the server, click the Stop icon in the <= guilabel>Servers view or right click the server name + and select the Stop option. + = -
- Stop JBoss Server - - - - - -
+
+ Stop JBoss Server + + + + + +
= - When the server is stopped you will see - Stopped - state next to its name in the square brackets. - Learn more about the Servers view - here. -
+ When the server is stopped you will see Stopped state next to its name in the square brackets. + Learn more about the Servers view in . +
= -
+
= - Project Archiving + Project Archiving = - JBoss Tools comes with our own archives too= l. The Project Archives - plugin consists primarily of a view to set up each packaging configu= ration ( - Window > Show View > Other > JBoss Tools > Project arc= hives). - - Right clicking in the Project archives view= you can create War, - EJB War, EAR or JAR archive. + + JBoss Tools comes with our own archives tool. The = Project Archives plugin consists primarily of a view to set up each packagi= ng configuration (WindowShow ViewOtherJBoss = ToolProject archives). + + Right clicking in the Project archives view y= ou can create a War, EJB War, EAR or JAR archive. = -
- Archive Creating - - - - - -
+
+ Archive Creating + + + + + +
= - Using the context menu on the item you can initiate a = full build on - archive, edit, <= property>delete or - publish it. + + Using the context menu on the item you can initiate a full build on an archive, edit= ,delete or = publish it. + = -
- Context Menu on the Item - - - - - -
+
+ Context Menu on the Item + + + + + +
= - If you wish, you can assign a hotkey for the Build Project Archiv= e action. A key binding can be added = - by navigating to - Window > Preferences > General > Keys.<= /emphasis> + + If you wish, you can assign a hotkey for the Build Project Archive acti= on. A key binding can be added by selecting Window= PreferencesGeneralKeys. + = -
- Setting the Hotkey for Build Project Archive Action - - - - - -
+
+ Setting the Hotkey for Build Project Archive Action + + + + + +
= - To perform the building of the project archives, select the proje= ct in the Package Explorer view and execute the hotkey= combination = - you assigned for this action. + + To build a project archive, select the project in the Package= Explorer view and execute the hotkey combination = + you assigned for this action. + = - Learn more about the Project Archives view - here. -
- = -
- Deploying an Application to a Server + More information about the Project Archives v= iew can be found in . +
= - There are two times to deploy your application: - - - While creating it - - - After it already exists - - +
+ Deploying an Application to a Server = - 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 app= ropriate selection in - these sections. + There are two times to deploy your application: + + + While creating it + + + After it already exists + + = -
- Runtime and Server Sections in the New Project Wizard - - - - - -
+ + When you create a new project (Seam, JSF or Struts) with the New Projec= t or Import Project wizards, they will include the Target Runtime= and Target Server sections. You can deploy= the application through the appropriate configuration in these sections. + = -
- Runtime and Server Sections in the Import Project Wizard</tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/quick_start/quick_start_4b.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Runtime and Server Sections in the New Project Wizard + + + + + +
= - You can deploy an existing application to a server by right-clic= king the target defined - server in the Servers view and then selecting <= emphasis>Add and - Remove Projects from the context menu. +
+ Runtime and Server Sections in the Import Project Wizard + + + + + +
= -
- Add and Remove Projects From the Context Menu. - - - - - -
+ + You can deploy an existing application to a server by right-clicking th= e target defined server in the Servers view and then s= electing Add and Remove Projects from the contex= t menu. + = - If this application is not assigned to a server, it will be in t= he left-hand available - projects list. Clicking on the Add > button wil= l add it to the right-hand - configured projects list and deploy the application to this server.<= /para> +
+ Add and Remove Projects From the Context Menu. + + + + + +
= -
- Modifying The Projects that are Configured on the Server</tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/quick_start/quick_start_6.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + <para> + If this application is not assigned to a server, it will be in the left= -hand available projects list. Clicking on the <guibutton>Add ></guibutton>= button will add it to the right-hand configured projects list and deploy t= he application to this server. + </para> + + <figure> + <title>Modifying The Projects that are Configured on the Server + + + + + +
+
=
Publishing to JBoss Server The publishing of all the modules added to a Server is performed a= utomatically when starting a Server. - The automatic publish of the changes made to the workspace is turn= ed on by default in order to permanently keep = - the workspace in sync with the publish folder. If you need to control w= hen to publish the changes, = - just disable the automatic publish in the Server Editor and use the - Publish to Server (= = - - - - ) button which initiates an incremental publish. + + Automatically publishing changes made to the workspace is enabled by de= fault, allowing the workspace to remain in sync with the publish folder. If= you need to control when to publish the changes, just disable the automati= c publish in the Server Editor (see ) and = use the Publish to Server () button which will incrementally publish the w= orkspace. = - Here, we have just performed the basic steps you should know to qu= ick start with JBoss - server. In fact, there are more functionalities which you can make use = of. Further we will - talk about them in detail. + + This section has provided some basic information that will allow you to= use the common features provided by the JBoss server. However, JBoss serve= r includes a great deal more functionality, which will be discussed in subs= equent chapters. +
= -
- Other relevant resources on the topic +
+ Other relevant resources on the topic = - All JBoss Developer Studio/JBoss Tools documentation you can fin= d on JBoss Tools releas= e documentation page. - The latest documentation builds are available JBoss To= ols nightly builds documentation page. - - Find out the answers on the frequently asked questions about JBos= s AS 5 usage in the = - JBossAS5FA= Q. + + All JBoss Developer Studio/JBoss Tools documentation can be found on th= e on JBoss Tools releas= e documentation page. + + + The latest documentation builds are available from the JBoss Tools nightly buil= ds documentation page. + + = + + Find answers to frequently asked questions about JBoss AS 5 usage in th= e JBossAS5FAQ. = - The information on how to monitor a remote JBoss Server from Ecli= pse you can find in the following - wiki article. -
+ + Information on how to monitor a remote JBoss Server from Eclipse can be= found in this wiki article. +
= --===============2476147648817838977==--