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,32 +1,79 @@
	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.
6		-
	9	+{{tip title="Mac Tip"}}
7	7
	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	+
8	8	== Step 2: Configuring your Maven Settings ==
9	9
10		-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.,,
11	11
12		-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:
13	13
14	14	{{noformat}}
15	15
16		-<settings>
17		- ...
	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">
18	18	<pluginGroups>
19	19	<pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
20	20	</pluginGroups>
21		- ...
	36	+
22	22	<profiles>
23	23	<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>
24	24	<pluginRepositories>
25	25	<pluginRepository>
26		- <id>mdimension.releases</id>
27		- <name>MDimension Releases Repository</name>
	73	+ <id>wocommunity.releases</id>
	74	+ <name>WOCommunity Releases Repository</name>
28	28	<url>
29		- http://webobjects.mdimension.com/maven2/releases
	76	+ http://maven.wocommunity.org/content/groups/public
30	30	</url>
31	31	<releases>
32	32	<enabled>true</enabled>
...	...	@@ -36,10 +36,10 @@
36	36	</snapshots>
37	37	</pluginRepository>
38	38	<pluginRepository>
39		- <id>mdimension.snapshots</id>
40		- <name>MDimension Snapshots Repository</name>
	86	+ <id>wocommunity.snapshots</id>
	87	+ <name>WOCommunity Snapshots Repository</name>
41	41	<url>
42		- http://webobjects.mdimension.com/maven2/snapshots
	89	+ http://maven.wocommunity.org/content/groups/public-snapshots
43	43	</url>
44	44	<releases>
45	45	<enabled>false</enabled>
...	...	@@ -48,15 +48,14 @@
48	48	<enabled>true</enabled>
49	49	</snapshots>
50	50	</pluginRepository>
51		- <pluginRepositories>
	98	+ </pluginRepositories>
52	52	</profile>
53	53	</profiles>
54		- ...
55	55	</settings>
56	56
57	57	{{/noformat}}
58	58
59		-**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.
	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.
60	60
61	61	== Step 3: Installing WebObjects Libraries ==
62	62
...	...	@@ -70,6 +70,12 @@
70	70
71	71	**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.
72	72
	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	+
73	73	== Step 4: Creating a WebObjects Project ==
74	74
75	75	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:
...	...	@@ -77,9 +77,8 @@
77	77	{{noformat}}
78	78
79	79	mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
80		- -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
81		- -DarchetypeVersion=2.0.14 \
82		- -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
	132	+ -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
	133	+ -DarchetypeVersion=2.0.17
83	83
84	84	{{/noformat}}
85	85
...	...	@@ -87,6 +87,8 @@
87	87
88	88	**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
89	89
	141	+**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
	142	+
90	90	== Step 5: Importing the Project into Eclipse ==
91	91
92	92	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.
...	...	@@ -94,25 +94,34 @@
94	94	{{note title="Warning"}}
95	95
96	96	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:
	150	+# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
	151	+# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
	152	+# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
97	97
98		-# Use the mvn eclipse:eclipse goal to update your .classpath file.
99		-# Use the m2eclipse plug-in for Eclipse.
100		-# Use the q4e plug-in for Eclipse.
101		-
102	102	{{/note}}
103	103
104	104	After adding the project dependencies to your Eclipse build path, WOLips can build the project and you will be able to start developing and running the application.
105	105
106		-**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>General Maven Documentation]].
	158	+**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>General Maven Documentation||anchor="IDE Integration"]].
107	107
108	108	== Step 6: Building WebObjects Applications with Maven ==
109	109
110		-Now, building your project with Maven is easy. Point to the project folder on Terminal and execute:
	162	+Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
111	111
112	112	{{noformat}}
113	113
114		-mvn clean install
	166	+mvn clean package
115	115
116	116	{{/noformat}}
117	117
118	118	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.
	171	+
	172	+To install your project into your local repository:
	173	+
	174	+{{noformat}}
	175	+
	176	+mvn clean install
	177	+
	178	+{{/noformat}}
	179	+
	180	+This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##