Changes for page Quick Start

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.hprange
	1	+XWiki.ldeck

Content

...	...	@@ -1,62 +1,29 @@
	1	+== Outline ==
	2	+
1	1	== Step 1: Installing Maven ==
2	2
3	3	Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
4	4
5		-**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
	7	+{{tip title="Mac Tip"}}
6	6
7		-== Step 2: Configuring your Maven Settings ==
	9	+install macports [http://www.macports.org/install.php], then on the terminal{noformat}sudo port install maven3{noformat}
8	8
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.,,
	11	+In future, to keep this up to date:{noformat}sudo port upgrade maven3{noformat}
10	10
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:
	13	+{{/tip}}
12	12
13		-{{noformat}}
	15	+**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
14	14
15		-<settings>
16		- ...
17		- <pluginGroups>
18		- <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
19		- </pluginGroups>
20		- ...
21		- <profiles>
22		- <profile>
23		- <pluginRepositories>
24		- <pluginRepository>
25		- <id>mdimension.releases</id>
26		- <name>MDimension Releases Repository</name>
27		- <url>
28		- http://webobjects.mdimension.com/maven2/releases
29		- </url>
30		- <releases>
31		- <enabled>true</enabled>
32		- </releases>
33		- <snapshots>
34		- <enabled>false</enabled>
35		- </snapshots>
36		- </pluginRepository>
37		- <pluginRepository>
38		- <id>mdimension.snapshots</id>
39		- <name>MDimension Snapshots Repository</name>
40		- <url>
41		- http://webobjects.mdimension.com/maven2/snapshots
42		- </url>
43		- <releases>
44		- <enabled>false</enabled>
45		- </releases>
46		- <snapshots>
47		- <enabled>true</enabled>
48		- </snapshots>
49		- </pluginRepository>
50		- <pluginRepositories>
51		- </profile>
52		- </profiles>
53		- ...
54		-</settings>
	17	+== Step 2: Configuring your Maven Settings ==
55	55
56		-{{/noformat}}
	19	+Advanced users can skip this step, but it's highly recommended.
57	57
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.
	21	+[[Quick Start Maven Settings Configuration Guide]]
59	59
	23	+**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>^settings.xml]]&nbsp;and install it to /.m2/settings.xml.
	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.
	26	+
60	60	== Step 3: Installing WebObjects Libraries ==
61	61
62	62	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:
...	...	@@ -67,8 +67,18 @@
67	67
68	68	{{/noformat}}
69	69
70		-**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.
	37	+**NOTE**: WebObjects must be installed.
71	71
	39	+**See** the [[maven-wobootstrap-plugin>>maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
	40	+
	41	+**See** [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
	42	+
	43	+{{warning title="Installing the right jars!"}}
	44	+
	45	+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.
	46	+
	47	+{{/warning}}
	48	+
72	72	== Step 4: Creating a WebObjects Project ==
73	73
74	74	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:
...	...	@@ -76,16 +76,17 @@
76	76	{{noformat}}
77	77
78	78	mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
79		- -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
80		- -DarchetypeVersion=2.0.14 \
81		- -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
	56	+ -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
	57	+ -DarchetypeVersion=2.0.17
82	82
83	83	{{/noformat}}
84	84
85	85	The maven-archetype-plugin will ask the required information to create the new project.
86	86
87		-**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
	63	+**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]].
88	88
	65	+**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
	66	+
89	89	== Step 5: Importing the Project into Eclipse ==
90	90
91	91	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.
...	...	@@ -93,9 +93,9 @@
93	93	{{note title="Warning"}}
94	94
95	95	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:
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.
	74	+# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
	75	+# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
	76	+# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
99	99
100	100	{{/note}}
101	101
...	...	@@ -105,12 +105,22 @@
105	105
106	106	== Step 6: Building WebObjects Applications with Maven ==
107	107
108		-Now, building your project with Maven is easy. Point to the project folder on Terminal and execute:
	86	+Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
109	109
110	110	{{noformat}}
111	111
112		-mvn clean install
	90	+mvn clean package
113	113
114	114	{{/noformat}}
115	115
116	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.
	95	+
	96	+To install your project into your local repository:
	97	+
	98	+{{noformat}}
	99	+
	100	+mvn clean install
	101	+
	102	+{{/noformat}}
	103	+
	104	+This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##