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
===================================================================
--- 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 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="quick_start" role="updated">
- <title>Quick Start with JBoss Server</title>
+ <title>Quick Start with JBoss Server</title>
- <para>This chapter covers the basics of working with the <property>JBoss
Server</property>.</para>
-
- <section id="JBoss_server_key_features">
- <title>Key Features of JBoss Server</title>
- <para>For a start, we propose you to look through the table of main features of
JBoss Server:</para>
-
- <table>
-
- <title>Key Functionality for JBoss AS and Archive Tools</title>
- <tgroup cols="3">
-
- <colspec colnum="1" align="left"
colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
- <colspec colnum="3" align="left"
colwidth="2*"/>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>JBoss AS plugin</para></entry>
- <entry><para>Using WTP, JBoss AS plugin allows working 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.</para></entry>
- <entry>
- <link linkend="runtimes_servers">runtimes and
servers</link>
- </entry>
- </row>
-
- <row>
- <entry><para>JBoss AS Perspective</para></entry>
- <entry><para>It makes managing installed JBoss Server quite easy
and includes the standard Console and Properties views, and specially added Project
archives view and Servers view for that purpose. </para></entry>
- <entry>
- <link linkend="perspective">JBoss AS
perspective</link>
- </entry>
- </row>
-
- <row>
- <entry><para>Modules Deployment</para></entry>
- <entry><para>A number of ways, provided by WTP and JBoss Tools,
to deploy either a project or a single file on the server.</para></entry>
- <entry>
- <link linkend="modules">deploying modules</link>
- </entry>
- </row>
-
- <row>
- <entry><para>TPTP Support</para></entry>
- <entry><para>Test and Performance Tools Platform (TPTP)
profiling.</para></entry>
- <entry>
- <link linkend="tptp_support">TPTP support</link>
- </entry>
- </row>
-
- </tbody>
-
- </tgroup>
- </table>
+ <para>This chapter covers the basics of working with the <property>JBoss
Server</property>.</para>
+
+ <section id="JBoss_server_key_features">
+ <title>Key Features of JBoss Server</title>
+ <para>The table below lists the main features included in JBoss
Server:</para>
+
+ <table>
+
+ <title>Key Functionality for JBoss AS and Archive Tools</title>
+ <tgroup cols="3">
+
+ <colspec colnum="1" align="left" colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <colspec colnum="3" align="left" colwidth="2*"/>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>JBoss AS plugin</para>
+ </entry>
+ <entry>
+ <para>
+ 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.
+ </para>
+ </entry>
+ <entry>
+ <link linkend="runtimes_servers">runtimes and
servers</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>JBoss AS Perspective</para>
+ </entry>
+ <entry>
+ <para>
+ It allows for easy management of an installed JBoss Server and includes the
standard Console and Properties views, and the specially added Project archives and
Servers views.
+ </para>
+ </entry>
+ <entry>
+ <link linkend="perspective">JBoss AS perspective</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Modules Deployment</para>
+ </entry>
+ <entry>
+ <para>Provides a number of ways, using WTP and JBoss Tools, to deploy either
a project or a single file on the server.</para>
+ </entry>
+ <entry>
+ <link linkend="modules">deploying modules</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>TPTP Support</para>
+ </entry>
+ <entry>
+ <para>Test and Performance Tools Platform (TPTP) profiling.</para>
+ </entry>
+ <entry>
+ <link linkend="tptp_support">TPTP support</link>
+ </entry>
+ </row>
+
+ </tbody>
+
+ </tgroup>
+ </table>
- <para>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>
+ If you already have installed the JBoss server and runtime this document will show you
how to configure, start and stop the server, as well as the deployment and archiving
processes. Installing runtimes and servers is covered in more detail in <xref
linkend="runtimes_servers"/>.
+ </para>
- <para>To start working with JBoss AS, select a <property>JBoss AS
Perspective</property> via
- <emphasis><property>Window > Show View > Other > Server >
Servers</property>.</emphasis></para>
- </section>
+ <para>
+ To start working with JBoss AS, select the <guilabel>JBoss AS</guilabel>
Perspective via
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>.
+ </para>
+ </section>
- <section id="starting">
- <title>Starting JBoss Server</title>
+ <section id="starting">
+ <title>Starting JBoss Server</title>
- <para>Starting <property>JBoss Server</property> is quite simple.
You can control the server
- behaviour with the help of a special toolbar in the
<property>Servers</property> view
- where you could <emphasis>
- <property>start</property>
- </emphasis> it in a regular or debug mode, <emphasis>
- <property>stop</property>
- </emphasis> it or <emphasis>
- <property>restart</property>
- </emphasis> it and <emphasis>
- <property>publish</property>
- </emphasis> to the server.</para>
+ <para>
+ Starting <productname>JBoss Server</productname> is quite simple. You can
control the server behavior with the help of a special toolbar in the
<guilabel>Servers</guilabel> view where you can
<guibutton>start</guibutton> it in a regular or debug mode,
<guibutton>stop</guibutton> or <guibutton>restart</guibutton> it,
and <guibutton>publish</guibutton> to the server.
+ </para>
- <figure>
- <title>Servers Toolbar</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Servers Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>To launch the server click the green-with-white-arrow icon on the
<property>Servers
- </property> view 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 > Show View > Other
> Server >
- Servers</property>.</emphasis></para>
+ <para>
+ To launch the server click the green-with-white-arrow icon on the
<guilabel>Servers</guilabel> view or right click server name in this view and
select <guimenuitem>Start</guimenuitem>. If this view is not open, select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>.
+ </para>
- <figure>
- <title>Start JBoss Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Start JBoss Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- </section>
+ </section>
- <section id="stopping">
- <title>Stopping JBoss Server</title>
+ <section id="stopping">
+ <title>Stopping JBoss Server</title>
- <para>To stop the server, click the <emphasis>
- <property>Stop</property>
- </emphasis> icon in the <property>Servers</property> view or
right click the server name
- and press
<emphasis><property>Stop</property>.</emphasis></para>
+ <para>
+ To stop the server, click the <guibutton>Stop</guibutton> icon in the
<guilabel>Servers</guilabel> view or right click the server name
+ and select the <guimenuitem>Stop</guimenuitem> option.
+ </para>
- <figure>
- <title>Stop JBoss Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Stop JBoss Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>When the server is stopped you will see <emphasis>
- <property>Stopped</property>
- </emphasis> state next to its name in the square brackets.</para>
- <para>Learn more about the <property>Servers</property> view
- <link linkend="JBossServerView">here</link>.</para>
- </section>
+ <para>When the server is stopped you will see
<guilabel>Stopped</guilabel> state next to its name in the square
brackets.</para>
+ <para>Learn more about the <guilabel>Servers</guilabel> view in
<xref linkend="JBossServerView"/>.</para>
+ </section>
- <section id="archiving">
+ <section id="archiving">
- <title>Project Archiving</title>
+ <title>Project Archiving</title>
- <para><property>JBoss Tools</property> 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</property>
view you can create War,
- EJB War, EAR or JAR archive.</para>
+ <para>
+ <property>JBoss Tools</property> comes with our own archives tool. The
Project Archives plugin consists primarily of a view to set up each packaging
configuration
(<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss
Tool</guimenuitem><guimenuitem>Project
archives</guimenuitem></menuchoice>).
+ </para>
+ <para>Right clicking in the <guilabel>Project archives</guilabel>
view you can create a War, EJB War, EAR or JAR archive.</para>
- <figure>
- <title>Archive Creating</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Archive Creating</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>Using the context menu on the item you can initiate a
<emphasis><property>full build</property></emphasis> on
- archive, <emphasis><property>edit</property>,</emphasis>
<emphasis><property>delete</property></emphasis> or
- <emphasis><property>publish</property></emphasis>
it.</para>
+ <para>
+ Using the context menu on the item you can initiate a
<emphasis><property>full build</property></emphasis> on an
archive,
<emphasis><property>edit</property>,</emphasis><emphasis><property>delete</property></emphasis>
or <emphasis><property>publish</property></emphasis> it.
+ </para>
- <figure>
- <title>Context Menu on the Item</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Context Menu on the Item</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>If you wish, you can assign a hotkey for the Build Project Archive action.
A key binding can be added
- by navigating to <emphasis>
- <property>Window > Preferences > General >
Keys</property>.</emphasis></para>
+ <para>
+ If you wish, you can assign a hotkey for the Build Project Archive action. A key
binding can be added by selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>General</guimenuitem><guimenuitem>Keys</guimenuitem></menuchoice>.
+ </para>
- <figure>
- <title>Setting the Hotkey for Build Project Archive Action</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/hotkeys.png"
scale="80"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Setting the Hotkey for Build Project Archive Action</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/hotkeys.png"
scale="80"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>To perform the building of the project archives, select the project in the
<property>Package Explorer</property> view and execute the hotkey combination
- you assigned for this action.</para>
+ <para>
+ To build a project archive, select the project in the <guilabel>Package
Explorer</guilabel> view and execute the hotkey combination
+ you assigned for this action.
+ </para>
- <para>Learn more about the <property>Project Archives</property>
view
- <link linkend="Project_archivesView">here</link>.</para>
- </section>
-
- <section id="deployment">
- <title>Deploying an Application to a Server</title>
+ <para>More information about the <guilabel>Project
Archives</guilabel> view can be found in <xref
linkend="Project_archivesView"/>.</para>
+ </section>
- <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>
- </itemizedlist>
+ <section id="deployment">
+ <title>Deploying an Application to a Server</title>
- <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>
+ <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>
+ </itemizedlist>
- <figure>
- <title>Runtime and Server Sections in the New Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_4a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ When you create a new project (Seam, JSF or Struts) with the New Project or Import
Project wizards, they will include the <guilabel>Target Runtime</guilabel> and
<guilabel>Target Server</guilabel> sections. You can deploy the application
through the appropriate configuration in these sections.
+ </para>
- <figure>
- <title>Runtime and Server Sections in the Import Project
Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_4b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <figure>
+ <title>Runtime and Server Sections in the New Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_4a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <para>You can deploy an existing application to a server by right-clicking the
target defined
- server in the <property>Servers</property> view and then selecting
<emphasis><property>Add and
- Remove Projects</property></emphasis> from the context
menu.</para>
+ <figure>
+ <title>Runtime and Server Sections in the Import Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_4b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Add and Remove Projects From the Context Menu.</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>
+ You can deploy an existing application to a server by right-clicking the target
defined server in the <guilabel>Servers</guilabel> view and then selecting
<guimenuitem>Add and Remove Projects</guimenuitem> from the context menu.
+ </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>Add and Remove Projects From the Context Menu.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <figure>
- <title>Modifying The Projects that are Configured on the
Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="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 the application to this server.
+ </para>
+
+ <figure>
+ <title>Modifying The Projects that are Configured on the Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section id="publishing">
<title>Publishing to JBoss Server</title>
<para>The publishing of all the modules added to a Server is performed
automatically when starting a Server.</para>
- <para>The automatic publish of the changes made to the workspace is turned on by
default in order to permanently keep
- the workspace in sync with the publish folder. If you need to control when to publish
the changes,
- just disable the automatic publish in the <link
linkend="server_editor">Server Editor</link> and use the
<emphasis>
- <property>Publish to Server</property></emphasis>
(<inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/publish_button.png"/>
- </imageobject>
- </inlinemediaobject>) button which initiates an incremental publish.
+ <para>
+ Automatically publishing changes made to the workspace is enabled by default, allowing
the workspace to remain in sync with the publish folder. If you need to control when to
publish the changes, just disable the automatic publish in the Server Editor (see <xref
linkend="server_editor"/>) and use the <guibutton>Publish to
Server</guibutton> (<inlinemediaobject><imageobject><imagedata
fileref="images/quick_start/publish_button.png"/></imageobject></inlinemediaobject>)
button which will incrementally publish the workspace.
</para>
- <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>
+ <para>
+ This section has provided some basic information that will allow you to use the common
features provided by the JBoss server. However, JBoss server includes a great deal more
functionality, which will be discussed in subsequent chapters.
+ </para>
</section>
- <section>
- <title>Other relevant resources on the topic</title>
+ <section>
+ <title>Other relevant resources on the topic</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find
<ulink
-
url="http://docs.jboss.org/tools/2.1.0.GA">on JBoss Tools release
documentation page</ulink>.</para>
- <para>The latest documentation builds are available <ulink
-
url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools
nightly builds documentation page</ulink>.</para>
-
- <para>Find out the answers on the frequently asked questions about JBoss AS 5
usage in the
- <ulink
url="http://community.jboss.org/wiki/JBossAS5FAQ">JBossAS5FA...;.
+ <para>
+ All JBoss Developer Studio/JBoss Tools documentation can be found on the <ulink
url="http://docs.jboss.org/tools/2.1.0.GA">on JBoss Tools release
documentation page</ulink>.
+ </para>
+ <para>
+ The latest documentation builds are available from the <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly
builds documentation page</ulink>.
+ </para>
+
+ <para>
+ Find answers to frequently asked questions about JBoss AS 5 usage in the <ulink
url="http://community.jboss.org/wiki/JBossAS5FAQ">JBossAS5FA...;.
</para>
- <para>The information on how to monitor a remote JBoss Server from Eclipse you
can find in the following
- <ulink
url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFr...
article</ulink>.</para>
- </section>
+ <para>
+ Information on how to monitor a remote JBoss Server from Eclipse can be found in this
<ulink
url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFr...
article</ulink>.</para>
+ </section>
</chapter>