Changes for page Quick Start

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

From version 20.1
edited by Lachlan Deck
on 2011/08/13 21:22
Change comment: updating for maven 3, moving some noise to another page
To version 25.1
edited by Lachlan Deck
on 2008/11/23 16:15
Change comment: Adding warning about installing the right jars

Summary

Details

Page properties
Content
... ... @@ -1,5 +3,3 @@
1 -== Outline ==
2 -
3 3  == Step 1: Installing Maven ==
4 4  
5 5  Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
... ... @@ -6,24 +6,73 @@
6 6  
7 7  {{tip title="Mac Tip"}}
8 8  
9 -install macports [http://www.macports.org/install.php], then on the terminal{noformat}sudo port install maven3{noformat}
7 + install macports [http://www.macports.org/install.php], then on the terminal
8 + {noformat}sudo port install maven2{noformat}
10 10  
11 -In future, to keep this up to date:{noformat}sudo port upgrade maven3{noformat}
10 + In future, to keep this up to date:
11 + {noformat}sudo port upgrade maven2{noformat}
12 12  
13 13  {{/tip}}
14 14  
15 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
15 +**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
16 16  
17 17  == Step 2: Configuring your Maven Settings ==
18 18  
19 -Advanced users can skip this step, but it's highly recommended.
19 +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.,,
20 20  
21 -[[Quick Start Maven Settings Configuration Guide]]
21 +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:
22 22  
23 -**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>^settings.xml]].
23 +{{noformat}}
24 24  
25 -See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
25 +<settings xmlns="http://maven.apache.org/POM/4.0.0"
26 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
28 + http://maven.apache.org/xsd/settings-1.0.0.xsd">
29 + <pluginGroups>
30 + <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
31 + </pluginGroups>
32 + <profiles>
33 + <profile>
34 + <id>woproject</id>
35 + <activation>
36 + <activeByDefault>true</activeByDefault>
37 + </activation>
38 + <pluginRepositories>
39 + <pluginRepository>
40 + <id>mdimension.releases</id>
41 + <name>MDimension Releases Repository</name>
42 + <url>
43 + http://webobjects.mdimension.com/maven2/releases
44 + </url>
45 + <releases>
46 + <enabled>true</enabled>
47 + </releases>
48 + <snapshots>
49 + <enabled>false</enabled>
50 + </snapshots>
51 + </pluginRepository>
52 + <pluginRepository>
53 + <id>mdimension.snapshots</id>
54 + <name>MDimension Snapshots Repository</name>
55 + <url>
56 + http://webobjects.mdimension.com/maven2/snapshots
57 + </url>
58 + <releases>
59 + <enabled>false</enabled>
60 + </releases>
61 + <snapshots>
62 + <enabled>true</enabled>
63 + </snapshots>
64 + </pluginRepository>
65 + </pluginRepositories>
66 + </profile>
67 + </profiles>
68 +</settings>
26 26  
70 +{{/noformat}}
71 +
72 +**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.
73 +
27 27  == Step 3: Installing WebObjects Libraries ==
28 28  
29 29  Maven takes control of all your project's dependencies. To develop WebObjects applications, Maven has to reference the WebObjects jars. You have to install the WebObjects libraries into your local repository to accomplish this:
... ... @@ -34,7 +34,7 @@
34 34  
35 35  {{/noformat}}
36 36  
37 -**NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin>>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.
84 +**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.
38 38  
39 39  {{warning title="Installing the right jars!"}}
40 40  
... ... @@ -49,14 +49,15 @@
49 49  {{noformat}}
50 50  
51 51  mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
52 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
53 - -DarchetypeVersion=2.0.17
99 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
100 + -DarchetypeVersion=2.0.16 \
101 + -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
54 54  
55 55  {{/noformat}}
56 56  
57 57  The maven-archetype-plugin will ask the required information to create the new project.
58 58  
59 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>woapplication-archetype]].
107 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
60 60  
61 61  **NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
62 62  
... ... @@ -83,18 +83,8 @@
83 83  
84 84  {{noformat}}
85 85  
86 -mvn clean package
87 -
88 -{{/noformat}}
89 -
90 -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.
91 -
92 -To install your project into your local repository:
93 -
94 -{{noformat}}
95 -
96 96  mvn clean install
97 97  
98 98  {{/noformat}}
99 99  
100 -This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##
138 +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.