Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09

From version 53.1
edited by Lachlan Deck
on 2008/12/08 15:48
Change comment: Quick review - adding table of contents, grammar fixes.
To version 46.1
edited by Henrique Prange
on 2008/05/01 18:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.hprange
Content
... ... @@ -1,44 +5,25 @@
1 -== Outline ==
2 -
3 -{{toc style="disc" indent="20px"}}{{/toc}}
4 -
5 5  == Step 1: Installing Maven ==
6 6  
7 7  Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
8 8  
9 -{{tip title="Mac Tip"}}
5 +**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
10 10  
11 - install macports [http://www.macports.org/install.php], then on the terminal
12 - {noformat}sudo port install maven2{noformat}
13 -
14 - In future, to keep this up to date:
15 - {noformat}sudo port upgrade maven2{noformat}
16 -
17 -{{/tip}}
18 -
19 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
20 -
21 21  == Step 2: Configuring your Maven Settings ==
22 22  
23 -Before start using Maven, you have to configure it in order to use the plug-ins provided by WOProject. General Maven configuration is made in a settings.xml file. This file can be found in a folder called ##.m2## in each user's home directory (,,/.m2 on Unix systems and C:ocuments and SettingsserNamem2 on Windows). If this file does not yet exist, you can just create it.,,
9 +Before start using Maven, you have to configure it in order to use the plug-ins provided by WOProject. General Maven configuration is made in a settings.xml file. This file can be found at .m2 folder in the user home (,,/.m2 on Unix systems and C:ocuments and Settingsserm2 on Windows). If this file doesn't exist yet, just create it.,,
24 24  
25 -You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following xml is sufficient to configure maven for using WOProject-maven plugin:
11 +You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following snippet shows how to make this configuration:
26 26  
27 27  {{noformat}}
28 28  
29 -<settings xmlns="http://maven.apache.org/POM/4.0.0"
30 - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
31 - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
32 - http://maven.apache.org/xsd/settings-1.0.0.xsd">
15 +<settings>
16 + ...
33 33   <pluginGroups>
34 34   <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
35 35   </pluginGroups>
20 + ...
36 36   <profiles>
37 37   <profile>
38 - <id>woproject</id>
39 - <activation>
40 - <activeByDefault>true</activeByDefault>
41 - </activation>
42 42   <pluginRepositories>
43 43   <pluginRepository>
44 44   <id>mdimension.releases</id>
... ... @@ -66,14 +66,15 @@
66 66   <enabled>true</enabled>
67 67   </snapshots>
68 68   </pluginRepository>
69 - </pluginRepositories>
50 + <pluginRepositories>
70 70   </profile>
71 71   </profiles>
53 + ...
72 72  </settings>
73 73  
74 74  {{/noformat}}
75 75  
76 -**NOTE**: You can download the complete and most recent settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
58 +**NOTE**: You can download the complete settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
77 77  
78 78  == Step 3: Installing WebObjects Libraries ==
79 79  
... ... @@ -87,12 +87,6 @@
87 87  
88 88  **NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin]] documentation for more information. See [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
89 89  
90 -{{warning title="Installing the right jars!"}}
91 -
92 -Do *not* link to or install the WebObjects jars located inside {{/System/Library/Frameworks}} or {{/Library/Frameworks}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{/Library/WebObjects/lib}}. For example, the jar {{/Library/WebObjects/lib/JavaWebObjects.jar}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar}} does not.
93 -
94 -{{/warning}}
95 -
96 96  == Step 4: Creating a WebObjects Project ==
97 97  
98 98  Archetypes are the fast way to create a new project using Maven. WOProject provides one archetype to create WebObjects Application. Execute the following command to generate a basic WebObjects project:
... ... @@ -101,7 +101,7 @@
101 101  
102 102  mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
103 103   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
104 - -DarchetypeVersion=2.0.16 \
80 + -DarchetypeVersion=2.0.14 \
105 105   -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
106 106  
107 107  {{/noformat}}
... ... @@ -110,8 +110,6 @@
110 110  
111 111  **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
112 112  
113 -**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
114 -
115 115  == Step 5: Importing the Project into Eclipse ==
116 116  
117 117  The new project is ready to be imported into Eclipse workspace. Use the Eclipse's import wizard (File > Import...) and choose the option "Existing Projects into Workspace". Select the root directory of your new project and finish the import wizard.
... ... @@ -119,9 +119,9 @@
119 119  {{note title="Warning"}}
120 120  
121 121  As Maven takes care of the dependency management, you must use a mechanism to add the jars to your Eclipse build path. There are 3 options:
122 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
123 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
124 -# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
96 +# Use the mvn eclipse:eclipse goal to update your .classpath file.
97 +# Use the m2eclipse plug-in for Eclipse.
98 +# Use the q4e plug-in for Eclipse.
125 125  
126 126  {{/note}}
127 127  
... ... @@ -131,22 +131,12 @@
131 131  
132 132  == Step 6: Building WebObjects Applications with Maven ==
133 133  
134 -Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
108 +Now, building your project with Maven is easy. Point to the project folder on Terminal and execute:
135 135  
136 136  {{noformat}}
137 137  
138 -mvn clean package
139 -
140 -{{/noformat}}
141 -
142 -This goal will generate a WOA package inside the target folder of your project. It also generates two compressed packages: one for woapplication and other for the webserver resources.
143 -
144 -To install your project into your local repository:
145 -
146 -{{noformat}}
147 -
148 148  mvn clean install
149 149  
150 150  {{/noformat}}
151 151  
152 -This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
116 +This goal will generate a WOA package inside the target folder of your project. It also generates two compressed packages: one for woapplication and other for the webserver resources.