Changes for page Quick Start

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

From version 48.1
edited by johnc
on 2009/04/08 20:19
Change comment: Updated settings.xml to latest version specified in http://wiki.objectstyle.org/confluence/display/WOL/mail/4129472
To version 41.1
edited by Henrique Prange
on 2008/05/01 18:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.johnc
1 +XWiki.hprange
Content
... ... @@ -1,79 +5,31 @@
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>
36 -
20 + ...
37 37   <profiles>
38 38   <profile>
39 - <id>default</id>
40 - <activation>
41 - <activeByDefault>true</activeByDefault>
42 - </activation>
43 - <repositories>
44 - <repository>
45 - <id>wocommunity.releases</id>
46 - <name>WOCommunity Releases Repository</name>
47 - <url>
48 - http://maven.wocommunity.org/content/groups/public
49 - </url>
50 - <releases>
51 - <enabled>true</enabled>
52 - </releases>
53 - <snapshots>
54 - <enabled>false</enabled>
55 - </snapshots>
56 - </repository>
57 - <repository>
58 - <id>wocommunity.snapshots</id>
59 - <name>WOCommunity Snapshots Repository</name>
60 - <url>
61 - http://maven.wocommunity.org/content/groups/public-snapshots
62 - </url>
63 - <releases>
64 - <enabled>false</enabled>
65 - </releases>
66 - <snapshots>
67 - <enabled>true</enabled>
68 - </snapshots>
69 - </repository>
70 - </repositories>
71 71   <pluginRepositories>
72 72   <pluginRepository>
73 - <id>wocommunity.releases</id>
74 - <name>WOCommunity Releases Repository</name>
25 + <id>mdimension.releases</id>
26 + <name>MDimension Releases Repository</name>
75 75   <url>
76 - http://maven.wocommunity.org/content/groups/public
28 + http://webobjects.mdimension.com/maven2/releases
77 77   </url>
78 78   <releases>
79 79   <enabled>true</enabled>
... ... @@ -83,10 +83,10 @@
83 83   </snapshots>
84 84   </pluginRepository>
85 85   <pluginRepository>
86 - <id>wocommunity.snapshots</id>
87 - <name>WOCommunity Snapshots Repository</name>
38 + <id>mdimension.snapshots</id>
39 + <name>MDimension Snapshots Repository</name>
88 88   <url>
89 - http://maven.wocommunity.org/content/groups/public-snapshots
41 + http://webobjects.mdimension.com/maven2/snapshots
90 90   </url>
91 91   <releases>
92 92   <enabled>false</enabled>
... ... @@ -95,14 +95,15 @@
95 95   <enabled>true</enabled>
96 96   </snapshots>
97 97   </pluginRepository>
98 - </pluginRepositories>
50 + <pluginRepositories>
99 99   </profile>
100 100   </profiles>
53 + ...
101 101  </settings>
102 102  
103 103  {{/noformat}}
104 104  
105 -**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|]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
106 106  
107 107  == Step 3: Installing WebObjects Libraries ==
108 108  
... ... @@ -116,12 +116,6 @@
116 116  
117 117  **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.
118 118  
119 -{{warning title="Installing the right jars!"}}
120 -
121 -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.
122 -
123 -{{/warning}}
124 -
125 125  == Step 4: Creating a WebObjects Project ==
126 126  
127 127  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:
... ... @@ -129,9 +129,9 @@
129 129  {{noformat}}
130 130  
131 131  mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
132 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
133 - -DarchetypeVersion=2.0.16 \
134 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
79 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
80 + -DarchetypeVersion=2.0.14 \
81 + -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
135 135  
136 136  {{/noformat}}
137 137  
... ... @@ -139,8 +139,6 @@
139 139  
140 140  **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
141 141  
142 -**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
143 -
144 144  == Step 5: Importing the Project into Eclipse ==
145 145  
146 146  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.
... ... @@ -148,9 +148,9 @@
148 148  {{note title="Warning"}}
149 149  
150 150  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:
151 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
152 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
153 -# 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.
154 154  
155 155  {{/note}}
156 156  
... ... @@ -160,22 +160,12 @@
160 160  
161 161  == Step 6: Building WebObjects Applications with Maven ==
162 162  
163 -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:
164 164  
165 165  {{noformat}}
166 166  
167 -mvn clean package
168 -
169 -{{/noformat}}
170 -
171 -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.
172 -
173 -To install your project into your local repository:
174 -
175 -{{noformat}}
176 -
177 177  mvn clean install
178 178  
179 179  {{/noformat}}
180 180  
181 -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.