Author: afedosik Date: 2007-11-01 10:13:19 -0400 (Thu, 01 Nov 2007) New Revision: 4626 Added: trunk/as/docs/reference/ trunk/as/docs/reference/build.xml trunk/as/docs/reference/en/ trunk/as/docs/reference/en/images/ trunk/as/docs/reference/en/images/JBossASPerspective/ trunk/as/docs/reference/en/images/JBossASPerspective/Enableprefer.png trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddinganxpath.png trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddxpath.png trunk/as/docs/reference/en/images/JBossASPerspective/JBSVaddingcategory.png trunk/as/docs/reference/en/images/JBossASPerspective/JBSVxpathpreview.png trunk/as/docs/reference/en/images/JBossASPerspective/JBVEventlogactions.png trunk/as/docs/reference/en/images/JBossASPerspective/JBVExtensions.png trunk/as/docs/reference/en/images/JBossASPerspective/JBVModulesactions.png trunk/as/docs/reference/en/images/JBossASPerspective/JBVServerisstopped.png trunk/as/docs/reference/en/images/JBossASPerspective/JBVxmlconfigandprop.png trunk/as/docs/reference/en/images/JBossASPerspective/archives1.png trunk/as/docs/reference/en/images/JBossASPerspective/archives2.png trunk/as/docs/reference/en/images/JBossASPerspective/archives3.png trunk/as/docs/reference/en/images/JBossASPerspective/archives4.png trunk/as/docs/reference/en/images/JBossASPerspective/deploytoserver.png trunk/as/docs/reference/en/images/JBossASPerspective/jbossserverview.png trunk/as/docs/reference/en/master.xml trunk/as/docs/reference/en/modules/ trunk/as/docs/reference/en/modules/JBossASPerspective.xml trunk/as/docs/reference/en/modules/RuntimesAndServers.xml Log: http://jira.jboss.com/jira/browse/RHDS-270 "reference" folder added instead of "userguide" Added: trunk/as/docs/reference/build.xml =================================================================== --- trunk/as/docs/reference/build.xml (rev 0) +++ trunk/as/docs/reference/build.xml 2007-11-01 14:13:19 UTC (rev 4626) @@ -0,0 +1,20 @@ +<project name="Documentation" default="all.doc" basedir="."> + + <!-- Set the following property to generate the doco in the output folder --> + <property name="build.dir" value="${basedir}/../build/reference"/> + + <property name="pdf.name" value="Getting_Started_with_RHDS.pdf" /> + <import file="../resources/support.xml" /> + + <target name="all.doc" depends="clean"> + <antcall target="lang.all"><param name="lang" value="en"/></antcall> + </target> + + <!-- Use this alternate target to enable uptodate checking, i.e. + don't generate docs if nothing has changed + <target name="all.doc"> + <antcall target="lang.all.run"><param name="lang" value="en"/></antcall> + </target> + --> + +</project> Added: trunk/as/docs/reference/en/images/JBossASPerspective/Enableprefer.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/Enableprefer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddinganxpath.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddinganxpath.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddxpath.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVAddxpath.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVaddingcategory.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVaddingcategory.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVxpathpreview.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBSVxpathpreview.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBVEventlogactions.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBVEventlogactions.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBVExtensions.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBVExtensions.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBVModulesactions.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBVModulesactions.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBVServerisstopped.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBVServerisstopped.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/JBVxmlconfigandprop.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/JBVxmlconfigandprop.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/archives1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/archives1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/archives2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/archives2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/archives3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/archives3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/archives4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/archives4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/deploytoserver.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/deploytoserver.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/images/JBossASPerspective/jbossserverview.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en/images/JBossASPerspective/jbossserverview.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en/master.xml =================================================================== --- trunk/as/docs/reference/en/master.xml (rev 0) +++ trunk/as/docs/reference/en/master.xml 2007-11-01 14:13:19 UTC (rev 4626) @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"../../resources/support/docbook-dtd/docbookx.dtd" + +[<!ENTITY RuntimesAndServers SYSTEM "modules/RuntimesAndServers.xml"> +<!ENTITY JBossASPerspective SYSTEM "modules/JBossASPerspective.xml"> + + +]> + +<book> + + <bookinfo> + <title>JBoss Server Manager Reference Guide</title> + <copyright> + <year>2007</year> + <holder>Red Hat</holder> + </copyright> + <releaseinfo> +<para>Version: 1.0.0.beta2</para> +<para>Note: This document is a work in progress and hence some sections might be incomplete and screenshots not 100% accurate.</para></releaseinfo> + </bookinfo> + + + <toc/> + &RuntimesAndServers; + &JBossASPerspective; + +</book> Added: trunk/as/docs/reference/en/modules/JBossASPerspective.xml =================================================================== --- trunk/as/docs/reference/en/modules/JBossASPerspective.xml (rev 0) +++ trunk/as/docs/reference/en/modules/JBossASPerspective.xml 2007-11-01 14:13:19 UTC (rev 4626) @@ -0,0 +1,251 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="JBossASPerspective" xreflabel="JBossASPerspective"> + <?dbhtml filename="JBossASPerspective.html"?> + <chapterinfo> + <keywordset> + <keyword>Red Hat Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>JBoss AS Perspective</title> + + <para>The <property>JBoss AS</property> Perspective is similar to the Java perspective, but it contains a few additional views. Two of the additional views are standard views, specifically the <property>Console </property> view and the <property>Properties</property> view. + The other two views that are added are the <property>Project archives</property> view and the <property>JBoss Servers View</property>.</para> + + <section id="JBossServersView"> + <?dbhtml filename="JBossServerView.html"?> + <title>The JBoss Servers View</title> + <para>This chapter will focus on the the JBoss Server's View. The JBoss Servers View is based on the Webtool's view, Servers View. The top half of the JBoss Servers View essentially embeds the original Servers View directly into it, making slight changes to the context menu. + A second half was added to provide additional information about the server selected in the top half. In the image provided, categories in the second half include which modules are currently deployed.</para> + + <figure> + <title>The JBoss Servers View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/jbossserverview.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>In order to access the view'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 want on or off, the order they appear + in the view, as well as any other extension-specific preferences that may be available.</para> + <figure> + <title>View Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/Enableprefer.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Extender is meant to provide additional functionality relevent to the server selected in the top half of the view. If a standard server element is selected from above, some + of the extensions may still provide the additional information. Others may not. + + So, let's look at the currently available extensions to the JBoss Server's View.</para> + <figure> + <title>View Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBVExtensions.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>Modules</property> section shows what modules are currently deployed to the server, and allows you to remove them + from the server, or force a full republish upon them. It only shows which modules have been deployed through Eclipse, + not any and all modules that happen to be in the deploy directory.</para> + <figure> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBVModulesactions.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>Event Log</property> will show relevent information to your server's startup, shutdown, and publish processes. This allows + you to keep an eye on what's going on (such as automatic incremental deployment if you have it enabled). + The only action available is to clear the event log. However if the properties view is opened, you can receive further + information on each event log item (when available).</para> + <figure> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBVEventlogactions.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Stopping the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBVServerisstopped.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>XML Configuration</property> 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 Properties view. Basically, XML Configuration are 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> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBVxmlconfigandprop.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The view itself contains only a list of categories. By right-clicking on <emphasis><property>XML Configuration</property></emphasis>, you can create a new category. + Ports are provided by default and is filled with many of the most commonly used ports in the JBoss Server.</para> + <figure> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBSVaddingcategory.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By right-clicking on <emphasis><property>Ports</property></emphasis>, you can create a new XPaths.</para> + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBSVAddxpath.png"/> + </imageobject> + </mediaobject> + </figure> + <para>After that, the dialog shown below will appear.</para> + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBSVAddinganxpath.png"/> + </imageobject> + </mediaobject> + </figure> + <para>As you type, the fields autocomplete to help you locate exactly what xpath you're looking for. The goal here is to + get an end result where the xpath matches up with an easily changed property. With that in mind, if the property + you want to change is the text of an element, then the final field Attribute Name + should be left blank and your xpath should end with port. + If, on the other hand, your desired field is the port attribute of &lt;fieldName port="35"&gt;, then your xpath will end + with fieldName and your Attribute Name will be "port". + When finished, you can click <emphasis><property>Preview</property></emphasis> to see how many matches you have for that particular xpath, as shown below.</para> + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/JBSVxpathpreview.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="Project_archivesView"> + <title>Project archives View</title> + <para>Every application, whether plain old Java, J2EE, or some other language altogether, needs to be packaged in some way. In Java-related projects, + many people use ANT. Red Hat Developer Studio comes with our own archives tool with a bit easier and less-verbose XML and a handy user interface.</para> + <para>The Project Archives plugin consists primarily of a view to set up each packaging configuration. Each project can enable or disable its builder, or depend on the global setting.</para> + <para>The packaging configuration for each project is stored in that project's root folder, and is in a file named <property>.packages</property>, which has a fairly simple XML + structure. Modifying the file by hand is neither required nor reccommended, and using the UI is the official way of modifying your packaging structure.</para> + <para>Aside from the builder, the other preferences for the plugin are mostly cosmetic, allowing you to show full or truncated paths, show the project at the + root, etc. None of these have any effect on the functionality of the packaging plugin.</para> + + <section id="Creating an archive"> + <title>Creating an Archive</title> + <para>When creating a new archive, you have some different options at your disposal. If the project has no <property>.packages</property> file, your + options will be presented to you all at once for you to choose from (as above). Otherwise you will right-click inside the view and select <emphasis><property>New Archive</property></emphasis> + to see your archive type options.</para> + <figure> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/archives1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>JAR is the standard archive type, and does very little configuration, leaving most of the work up to you. You can customize the name, add folders, + filesets, and inner jars to it.</para> + <para>The other types, for the most part, simply start off with a default setting, usually the jar with some specific children based on an expected + structure of the project. For example, if the project is a dynamic web project, and you create a WAR 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 New Jar Wizard, that page is shown below.</para> + <figure> + <title>New JAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/archives2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The page is pretty simple. All it asks is for the name of your new archive, a destination, which we'll get to in a moment, and whether the archive + is exploded or packaged up.</para> + <para>The destination of an archive can be anywhere on the filesystem, anywhere in the workspace, inside some other archive, or inside a folder + declared inside an archive. You can browse to workspace or filesystem destinations by clicking on their respective buttons. To select a destination + inside some other archive, you'll need to press the <property>Workspace...</property> button. At the bottom of the list, you'll see archives that have been declared in the + workspace.</para> + <section id="CreatingaFolder"> + <title>Creating a Folder</title> + <para>Creating a folder is much easier. You simply right-click on an archive or folder you want your new folder to be a child under. The only piece of + required information is naming the file.</para> + </section> + <section id="CreatingaFileSet"> + <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 + New Fileset. The New Fileset Wizard requires a destination (where the files will go), and a root directory (or where the files are coming from). + The source can be anywhere in the workspace or from the filesystem at large.</para> + <para>Below that, the fileset requires only an includes pattern and an excludes pattern. As you type in either of these fields, the preview viewer should + update itself with which files are matched.</para> + </section> + </section> + <section id="View Actions"> + <title>View Actions</title> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/archives3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The context menu on the items in the view is extendable, but there are several that come standard. The first is the <property>Build Archive</property> action, enabled + only on top-level archives, which initiates a full build on that archive. Editing and deleting nodes are also standard actions, with deletion not needing + an explanation. The edit action brings up the wizard associated with that particular node type and allows the details to be changed. The final action + contribution here is the ability to publish to a declared server.</para> + </section> + <section id="PublishToServer"> + <title>Publish to Server</title> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/archives4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <property>Publish To Server</property>. To simply publish once, you just select the server(s) that you want, and finish. + If you want the Publish to Server action on that particular Archive to always publish to that set of servers, then check the appropriate checkbox. + And finally, to enable automatic publishing upon build events, check the last checkbox.</para> + <para>The automatic publishing feature is nice if, for example, your package's destination (where it is built) is a temporary folder and you want the + archive published to several servers. If you only really want your archive published to one server, it might be easier to have the archive's destination + folder be the deploy folder of the server.</para> + </section> + + </section> + + <section id="Deploy to Server"> + <?dbhtml filename="DeployToServer.html"?> + <title>Deploy to Server</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> + <figure> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/JBossASPerspective/deploytoserver.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The deployed files are listed side-by-side with other modules that are deployed to the server.</para> + +</section> +</chapter> Added: trunk/as/docs/reference/en/modules/RuntimesAndServers.xml =================================================================== --- trunk/as/docs/reference/en/modules/RuntimesAndServers.xml (rev 0) +++ trunk/as/docs/reference/en/modules/RuntimesAndServers.xml 2007-11-01 14:13:19 UTC (rev 4626) @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="RuntimesAndServers" xreflabel="RuntimesAndServers"> + <?dbhtml filename="RuntimesAndServers.html"?> + <chapterinfo> + <keywordset> + <keyword>Red Hat Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Runtimes and Servers in the JBoss AS plugin</title> + + </chapter>