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

Content

...	...	@@ -1,133 +1,97 @@
1	1	== Outline ==
2	2
3		-{{toc style="disc" indent="20px"}}{{/toc}}
4		-
5	5	== Step 1: Installing Maven ==
6	6
7		-Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
	5	+Downloading and installing the latest version of [[Maven>>url:http://maven.apache.org/download||shape="rect"]] is the first step to start using this tool.
8	8
9	9	{{tip title="Mac Tip"}}
	8	+install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:
10	10
11		- install macports [http://www.macports.org/install.php], then on the terminal
12		- {noformat}sudo port install maven2{noformat}
	10	+{{noformat}}
	11	+sudo port install maven3
13	13
14		- In future, to keep this up to date:
15		- {noformat}sudo port upgrade maven2{noformat}
	13	+{{/noformat}}
16	16
17		-{{/tip}}
	15	+In future, to keep this up to date:
18	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.
	17	+{{noformat}}
	18	+sudo port upgrade maven3
20	20
21		-== Step 2: Configuring your Maven Settings ==
	20	+{{/noformat}}
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.,,
	22	+Don't forget to install maven_select:
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:
26		-
27	27	{{noformat}}
	25	+sudo port install maven_select
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">
33		- <pluginGroups>
34		- <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
35		- </pluginGroups>
36		- <profiles>
37		- <profile>
38		- <id>woproject</id>
39		- <activation>
40		- <activeByDefault>true</activeByDefault>
41		- </activation>
42		- <pluginRepositories>
43		- <pluginRepository>
44		- <id>wocommunity.releases</id>
45		- <name>WOCommunity Releases Repository</name>
46		- <url>
47		- http://maven.wocommunity.org/content/groups/public
48		- </url>
49		- <releases>
50		- <enabled>true</enabled>
51		- </releases>
52		- <snapshots>
53		- <enabled>false</enabled>
54		- </snapshots>
55		- </pluginRepository>
56		- <pluginRepository>
57		- <id>wocommunity.snapshots</id>
58		- <name>WOCommunity Snapshots Repository</name>
59		- <url>
60		- http://maven.wocommunity.org/content/groups/public-snapshots
61		- </url>
62		- <releases>
63		- <enabled>false</enabled>
64		- </releases>
65		- <snapshots>
66		- <enabled>true</enabled>
67		- </snapshots>
68		- </pluginRepository>
69		- </pluginRepositories>
70		- </profile>
71		- </profiles>
72		-</settings>
73		-
74	74	{{/noformat}}
	28	+{{/tip}}
75	75
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.
	30	+**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
77	77
	32	+== Step 2: Configuring your Maven Settings ==
	33	+
	34	+Advanced users can skip this step, but it's highly recommended.
	35	+
	36	+[[doc:Quick Start Maven Settings Configuration Guide]]
	37	+
	38	+**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>attach:settings.xml]] and install it to ~~/.m2/settings.xml.
	39	+
	40	+See [[Maven Settings Reference>>url:http://maven.apache.org/settings.html||shape="rect"]] if you want more information about additional options for the settings.xml file.
	41	+
78	78	== Step 3: Installing WebObjects Libraries ==
79	79
80		-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:
	44	+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>>url:http://wocreator.sourceforge.net/repository-howto.html||shape="rect"]] to accomplish this:
81	81
82	82	{{noformat}}
83		-
84	84	mvn wobootstrap:install
85	85
86	86	{{/noformat}}
87	87
88		-**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.
	51	+**NOTE**: WebObjects must be installed.
89	89
90		-{{warning title="Installing the right jars!"}}
	53	+**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
91	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.
	55	+**See** [[Maven Introduction to Repositories>>url:http://maven.apache.org/guides/introduction/introduction-to-repositories.html||shape="rect"]] if you want more information about Maven repositories.
93	93
	57	+{{warning title="Installing the right jars!"}}
	58	+Do **not** link to or install the WebObjects jars located inside {{code language="none"}}/System/Library/Frameworks{{/code}} or {{code language="none"}}/Library/Frameworks{{/code}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{code language="none"}}/Library/WebObjects/lib{{/code}}. For example, the jar {{code language="none"}}/Library/WebObjects/lib/JavaWebObjects.jar{{/code}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{code language="none"}}/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar{{/code}} does not.
94	94	{{/warning}}
95	95
96		-== Step 4: Creating a WebObjects Project ==
	61	+== Step 4: Creating a WebObjects or Wonder Project ==
97	97
98		-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:
	63	+Archetypes are the fast way to create a new project using Maven and WOProject provides various archetypes of its own to get you started with WebObjects, or better, Wonder-based applications. Execute the following command to generate a basic Wonder application project:
99	99
100	100	{{noformat}}
	66	+mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
	67	+ -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
	68	+ -DarchetypeVersion=2.1
101	101
102		-mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
103		- -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
104		- -DarchetypeVersion=2.0.16 \
105		- -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
106		-
107	107	{{/noformat}}
108	108
109	109	The maven-archetype-plugin will ask the required information to create the new project.
110	110
111		-**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
	74	+**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:woapplication-archetype]].
112	112
113		-**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
	76	+**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
114	114
	78	+**NOTE:** You can see the list of available archetypes in the following location: [[http:~~/~~/wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/>>url:http://wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/||shape="rect"]].
	79	+
115	115	== Step 5: Importing the Project into Eclipse ==
116	116
117	117	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.
118	118
119	119	{{note title="Warning"}}
120		-
121	121	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:
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.
125	125
	87	+1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
	88	+1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
	89	+1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
126	126	{{/note}}
127	127
128	128	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.
129	129
130		-**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"]].
	94	+**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>doc:General Maven Documentation||anchor="IDE Integration"]].
131	131
132	132	== Step 6: Building WebObjects Applications with Maven ==
133	133
...	...	@@ -134,7 +134,6 @@
134	134	Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
135	135
136	136	{{noformat}}
137		-
138	138	mvn clean package
139	139
140	140	{{/noformat}}
...	...	@@ -144,9 +144,8 @@
144	144	To install your project into your local repository:
145	145
146	146	{{noformat}}
147		-
148	148	mvn clean install
149	149
150	150	{{/noformat}}
151	151
152		-This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
	114	+This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}