Changes for page Quick Start

Summary

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

Details

Page properties

Author

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

Content

...	...	@@ -1,29 +3,66 @@
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	6
7		-{{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.
8	8
9		-install macports [http://www.macports.org/install.php], then on the terminal{noformat}sudo port install maven3{noformat}
	7	+== Step 2: Configuring your Maven Settings ==
10	10
11		-In future, to keep this up to date:{noformat}sudo port upgrade maven3{noformat}
	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.,,
12	12
13		-{{/tip}}
	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:
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.
	13	+{{noformat}}
16	16
17		-== Step 2: Configuring your Maven Settings ==
	15	+<settings>
	16	+ ...
	17	+ <pluginGroups>
	18	+ <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
	19	+ </pluginGroups>
	20	+ ...
	21	+ <profiles>
	22	+ <profile>
	23	+ <id>default</id>
	24	+ <activation>
	25	+ <activeByDefault>true</activeByDefault>
	26	+ </activation>
	27	+ <pluginRepositories>
	28	+ <pluginRepository>
	29	+ <id>mdimension.releases</id>
	30	+ <name>MDimension Releases Repository</name>
	31	+ <url>
	32	+ http://webobjects.mdimension.com/maven2/releases
	33	+ </url>
	34	+ <releases>
	35	+ <enabled>true</enabled>
	36	+ </releases>
	37	+ <snapshots>
	38	+ <enabled>false</enabled>
	39	+ </snapshots>
	40	+ </pluginRepository>
	41	+ <pluginRepository>
	42	+ <id>mdimension.snapshots</id>
	43	+ <name>MDimension Snapshots Repository</name>
	44	+ <url>
	45	+ http://webobjects.mdimension.com/maven2/snapshots
	46	+ </url>
	47	+ <releases>
	48	+ <enabled>false</enabled>
	49	+ </releases>
	50	+ <snapshots>
	51	+ <enabled>true</enabled>
	52	+ </snapshots>
	53	+ </pluginRepository>
	54	+ </pluginRepositories>
	55	+ </profile>
	56	+ </profiles>
	57	+ ...
	58	+</settings>
18	18
19		-Advanced users can skip this step, but it's highly recommended.
	60	+{{/noformat}}
20	20
21		-[[Quick Start Maven Settings Configuration Guide]]
	62	+**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.
22	22
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		-
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,18 +34,8 @@
34	34
35	35	{{/noformat}}
36	36
37		-**NOTE**: WebObjects must be installed.
	74	+**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		-**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		-
49	49	== Step 4: Creating a WebObjects Project ==
50	50
51	51	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:
...	...	@@ -53,14 +53,15 @@
53	53	{{noformat}}
54	54
55	55	mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
56		- -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
57		- -DarchetypeVersion=2.0.17
	83	+ -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
	84	+ -DarchetypeVersion=2.0.16 \
	85	+ -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
58	58
59	59	{{/noformat}}
60	60
61	61	The maven-archetype-plugin will ask the required information to create the new project.
62	62
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]].
	91	+**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
64	64
65	65	**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
66	66
...	...	@@ -87,18 +87,8 @@
87	87
88	88	{{noformat}}
89	89
90		-mvn clean package
91		-
92		-{{/noformat}}
93		-
94		-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	100	mvn clean install
101	101
102	102	{{/noformat}}
103	103
104		-This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##
	122	+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.