[jbosstools-commits] JBoss Tools SVN: r41963 - trunk/maven/docs/reference/en-US.
jbosstools-commits at lists.jboss.org
jbosstools-commits at lists.jboss.org
Thu Jun 14 01:24:50 EDT 2012
Author: irooskov at redhat.com
Date: 2012-06-14 01:24:49 -0400 (Thu, 14 Jun 2012)
New Revision: 41963
Added:
trunk/maven/docs/reference/en-US/Author_Group.xml
trunk/maven/docs/reference/en-US/Book_Info.xml
trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.ent
trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.xml
trunk/maven/docs/reference/en-US/adding_maven_support.xml
trunk/maven/docs/reference/en-US/creating_a_maven_module.xml
Modified:
trunk/maven/docs/reference/en-US/Revision_History.xml
Log:
updating book, the files didn't go up last time
Added: trunk/maven/docs/reference/en-US/Author_Group.xml
===================================================================
--- trunk/maven/docs/reference/en-US/Author_Group.xml (rev 0)
+++ trunk/maven/docs/reference/en-US/Author_Group.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<authorgroup>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ </author>
+</authorgroup>
+
Added: trunk/maven/docs/reference/en-US/Book_Info.xml
===================================================================
--- trunk/maven/docs/reference/en-US/Book_Info.xml (rev 0)
+++ trunk/maven/docs/reference/en-US/Book_Info.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,35 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<bookinfo id="book-Maven_Integration_Guide-Maven_Integration_Guide">
+ <title>Maven Tools Reference Guide</title>
+ <subtitle>
+ Provides information about the use of <application>Maven</application> within the <application>JBoss Developer Studio</application>.
+ </subtitle>
+
+ <productname>JBoss Developer Studio</productname>
+
+ <productnumber>5.0</productnumber>
+
+ <edition>5.0.0</edition>
+
+ <pubsnumber>3</pubsnumber>
+
+ <abstract>
+ <para>
+ The Maven Tools Reference Guide explains how to utilize Maven from within the JBoss Developer Studio.
+ </para>
+ </abstract>
+
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
Added: trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.ent
===================================================================
--- trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.ent (rev 0)
+++ trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.ent 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,7 @@
+<!ENTITY PRODUCT "JBoss">
+<!ENTITY BOOKID "Maven_Tools_Reference_Guide">
+<!ENTITY YEAR "2012">
+<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Maven Tools Reference Guide">
+<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss%20Developer%20Studio%205&component=Maven%20Tools%20Reference%20Guide&version=5.0.0&short_desc=Error%20in%20Maven%20Tools%20Reference%20Guide'>http://bugzilla.redhat.com/</ulink>">
Added: trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.xml
===================================================================
--- trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.xml (rev 0)
+++ trunk/maven/docs/reference/en-US/Maven_Tools_Reference_Guide.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="creating_a_maven_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="creating_a_maven_module.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="adding_maven_support.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
+
Modified: trunk/maven/docs/reference/en-US/Revision_History.xml
===================================================================
--- trunk/maven/docs/reference/en-US/Revision_History.xml 2012-06-14 05:16:11 UTC (rev 41962)
+++ trunk/maven/docs/reference/en-US/Revision_History.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -1,24 +1,25 @@
<?xml version='1.0' encoding='utf-8' ?>
-<appendix id="appe-Beginners_Guide-Revision_History">
- <title>Revision History</title>
- <simpara>
- <revhistory>
- <revision>
- <revnumber>0-0</revnumber>
- <date>Mon May 21 2012</date>
- <author>
- <firstname>Isaac</firstname>
- <surname>Rooskov</surname>
- </author>
- <email></email>
- <revdescription>
- <simplelist>
- <member>Initial creation of book</member>
- </simplelist>
- </revdescription>
- </revision>
- </revhistory>
- </simpara>
-</appendix>
-
+ <appendix id="appe-Maven_Tools_Reference_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1-0</revnumber>
+ <date>Thu Jun 14 2012</date>
+ <author>
+ <firstname>Isaac</firstname>
+ <surname>Rooskov</surname>
+ <email>irooskov at redhat.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+ </appendix>
+
+
\ No newline at end of file
Added: trunk/maven/docs/reference/en-US/adding_maven_support.xml
===================================================================
--- trunk/maven/docs/reference/en-US/adding_maven_support.xml (rev 0)
+++ trunk/maven/docs/reference/en-US/adding_maven_support.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,108 @@
+<chapter id="adding_maven_support">
+ <title>Adding Maven support to an existing project</title>
+ <para>
+ Select the project that Maven support will be added to from the <guilabel>Project Explorer</guilabel>.
+ </para>
+ <figure id="adding_maven_support_00">
+ <title>Selecting Maven project conversion</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_00.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Selecting Convert to Maven Project from the context menu of the chosen project.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Right-click on the project to bring up the context menu.
+ </para>
+ <para>
+ From the context menu navigate to <menuchoice><guimenuitem>Configure</guimenuitem><guimenuitem>Convert to Maven Project</guimenuitem></menuchoice>.
+ </para>
+ <figure id="adding_maven_support_01">
+ <title>Selecting Maven project conversion</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_01.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Selecting Convert to Maven Project from the context menu of the chosen project.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click on the <guimenuitem>Convert to Maven Project</guimenuitem> menu option.
+ </para>
+ <para>
+ A <guilabel>Maven POM</guilabel> wizard will launch. The wizard will create a <filename>pom.xml</filename> file for your project. This file will contain the projects Maven settings. All necessary fields of the wizard will be automatically filled.
+ </para>
+ <figure id="adding_maven_support_02">
+ <title>Maven POM wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_02.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The wizard to create a <filename>pom.xml</filename> file for your project.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ It is recommended that you change the <guilabel>Packaging</guilabel> option to <guimenuitem>pom</guimenuitem> to avoid any issues in expansion of the project with Maven modules in the future.
+ </para>
+ <figure id="adding_maven_support_03">
+ <title>Changing Packaging setting to pom</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_03.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Showing the selection of pom from the drop-down menu of the Packaging setting.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click <guibutton>Finish</guibutton>.
+ </para>
+ <para>
+ Once Maven support has been added to the project, a new <filename>pom.xml</filename> file will appear in the list of files for the project. This can be viewed in the <guilabel>Project Explorer</guilabel>.
+ </para>
+ <figure id="adding_maven_support_04">
+ <title>New pom.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_04.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The project now has a new pom.xml file, seen in the Project Explorer.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Double-click on the <filename>pom.xml</filename> file to view the settings associated with it. The settings here were set in the <guilabel>Maven POM</guilabel> wizard and can be edited from this <guilabel>Overview</guilabel> screen.
+ </para>
+ <figure id="adding_maven_support_05">
+ <title>Overview screen for pom.xml</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_maven_support/adding_maven_support_05.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The Overview screen for the new pom.xml file.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
Added: trunk/maven/docs/reference/en-US/creating_a_maven_module.xml
===================================================================
--- trunk/maven/docs/reference/en-US/creating_a_maven_module.xml (rev 0)
+++ trunk/maven/docs/reference/en-US/creating_a_maven_module.xml 2012-06-14 05:24:49 UTC (rev 41963)
@@ -0,0 +1,168 @@
+<chapter id="creating_a_maven_application">
+ <title>Creating a Maven Module</title>
+ <para>
+ A Maven module is a sub-project. To create a Maven module you will need to already have a Maven project available.
+ </para>
+ <para>
+ The parent project must have its <guilabel>Packaing</guilabel> option be pre-configured to <guimenuitem>pom</guimenuitem> for a module to be created and associated to it. To ensure your parent project has this option set correctly before proceeding, double-click on the <filename>pom.xml</filename> file of your parent project in the <guilabel>Project Explorer</guilabel>.
+ </para>
+ <para>
+ In the <guilabel>Overview</guilabel> settings page that is now displayed in your workbench, confirm that the option <guibutton>Packaging</guibutton> is set to <guimenuitem>pom</guimenuitem>. If it is not, select <guimenuitem>pom</guimenuitem> from the list menu and save the changes to your <filename>pom.xml</filename> file.
+ </para>
+ <figure id="module_creation_01">
+ <title>Parent project pom.xml file settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_01.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The settings associated with the pom.xml file of the parent project.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ From your workspace navigate to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and from the wizard selection screen select <menuchoice><guimenuitem>Maven</guimenuitem><guimenuitem>Maven Module</guimenuitem></menuchoice>.
+ </para>
+ <figure id="module_creation_02">
+ <title>Selecting the Maven Module wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_02.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Wizard selection screen with the Maven Module wizard selected.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Type a name for the module in the <guilabel>Module Name</guilabel> field.
+ </para>
+ <figure id="module_creation_03">
+ <title>Naming the module</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_03.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Typing a name for the module.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click the <guibutton>Browse</guibutton> button beside the <guilabel>Parent Project</guilabel> field. This will launch a project selection box.
+ </para>
+ <para>
+ Select the project to be used as the parent project of the module you are creating, and click <guibutton>OK</guibutton>.
+ </para>
+ <figure id="module_creation_04">
+ <title>Selecting the parent project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_04.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Selecting the project that will be the parent project of the module.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ You will be returned to the <guilabel>Select a parent project</guilabel> screen and the <guilabel>Parent Project</guilabel> field will contain the name of the project you selected.
+ </para>
+ <figure id="module_creation_05">
+ <title>Parent Project field populated with project name</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_05.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The Select a parent project screen with the Parent Project field now containing the name of the selected project.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click the <guibutton>Next</guibutton> button.
+ </para>
+ <para>
+ Select an archetype available in the list displayed. For the purposes of this example the <guimenuitem>maven-archetype-quickstart</guimenuitem> is selected.
+ </para>
+ <figure id="module_creation_06">
+ <title>Archetype selection screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_06.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Selecting an archetype for the module.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click the <guibutton>Next</guibutton> button.
+ </para>
+ <para>
+ Specify archetype parameters <guilabel>Group Id</guilabel> and <guilabel>Version</guilabel>. Ensure that the values you specify for these fields are unique from those set in the parent project.
+ </para>
+ <para>
+ In this example, the <guilabel>Group Id</guilabel> and <guilabel>Version</guilabel> settings of the parent project used are set to <property>group_id</property> and <property>0.0.1-SNAPSHOT</property> respectively. For the module <guilabel>Group Id</guilabel> and <guilabel>Version</guilabel> settings are being specified as <property>sub_group_id</property> and <property>0.1.1-SNAPSHOT</property> respectively, to avoid conflict.
+ </para>
+ <figure id="module_creation_07">
+ <title>Archetype parameter settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_07.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Specifying the settings to be used by the archetype for the module being created.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Click the <guibutton>Finish</guibutton> button.
+ </para>
+ <para>
+ The module will now be created and appear in your <guilabel>Project Explorer</guilabel>.
+ </para>
+ <figure id="module_creation_08">
+ <title>Created module in the Project Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_08.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The module has now been created and appears in the Project Explorer.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ You can view and change settings associated with the module by selecting the module's <filename>pom.xml</filename> file from the <guilabel>Project Explorer</guilabel> and double-clicking on it. This will launch an <guilabel>Overview</guilabel> screen containing the module settings.
+ </para>
+ <figure id="module_creation_09">
+ <title>Module Overview screen</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/module_creation/module_creation_09.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The module Overview page, where settings can be viewed and changed.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
More information about the jbosstools-commits
mailing list