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.johnc

Content

...	...	@@ -1,31 +1,50 @@
	1	+== Outline ==
	2	+
	3	+{{toc style="disc" indent="20px"}}{{/toc}}
	4	+
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.
	9	+{{tip title="Mac Tip"}}
6	6
	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	+
7	7	== Step 2: Configuring your Maven Settings ==
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.,,
	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.,,
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:
	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:
12	12
13	13	{{noformat}}
14	14
15		-<settings>
16		- ...
	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">
17	17	<pluginGroups>
18	18	<pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
19	19	</pluginGroups>
20		- ...
21	21	<profiles>
22	22	<profile>
	38	+ <id>woproject</id>
	39	+ <activation>
	40	+ <activeByDefault>true</activeByDefault>
	41	+ </activation>
23	23	<pluginRepositories>
24	24	<pluginRepository>
25		- <id>mdimension.releases</id>
26		- <name>MDimension Releases Repository</name>
	44	+ <id>wocommunity.releases</id>
	45	+ <name>WOCommunity Releases Repository</name>
27	27	<url>
28		- http://webobjects.mdimension.com/maven2/releases
	47	+ http://maven.wocommunity.org/content/groups/public
29	29	</url>
30	30	<releases>
31	31	<enabled>true</enabled>
...	...	@@ -35,10 +35,10 @@
35	35	</snapshots>
36	36	</pluginRepository>
37	37	<pluginRepository>
38		- <id>mdimension.snapshots</id>
39		- <name>MDimension Snapshots Repository</name>
	57	+ <id>wocommunity.snapshots</id>
	58	+ <name>WOCommunity Snapshots Repository</name>
40	40	<url>
41		- http://webobjects.mdimension.com/maven2/snapshots
	60	+ http://maven.wocommunity.org/content/groups/public-snapshots
42	42	</url>
43	43	<releases>
44	44	<enabled>false</enabled>
...	...	@@ -47,15 +47,14 @@
47	47	<enabled>true</enabled>
48	48	</snapshots>
49	49	</pluginRepository>
50		- <pluginRepositories>
	69	+ </pluginRepositories>
51	51	</profile>
52	52	</profiles>
53		- ...
54	54	</settings>
55	55
56	56	{{/noformat}}
57	57
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.
	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.
59	59
60	60	== Step 3: Installing WebObjects Libraries ==
61	61
...	...	@@ -69,6 +69,12 @@
69	69
70	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.
71	71
	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	+
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,9 +76,9 @@
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
	103	+ -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
	104	+ -DarchetypeVersion=2.0.16 \
	105	+ -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
82	82
83	83	{{/noformat}}
84	84
...	...	@@ -86,6 +86,8 @@
86	86
87	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]].
88	88
	113	+**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
	114	+
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.
	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.
99	99
100	100	{{/note}}
101	101
...	...	@@ -109,8 +109,18 @@
109	109
110	110	{{noformat}}
111	111
112		-mvn clean install
	138	+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.
	143	+
	144	+To install your project into your local repository:
	145	+
	146	+{{noformat}}
	147	+
	148	+mvn clean install
	149	+
	150	+{{/noformat}}
	151	+
	152	+This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##