Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09

From version 59.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: Updating archetypeVersion to use for quick start. Adding reminder about installing maven_select.
To version 60.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,38 +2,45 @@
2 2  
3 3  == Step 1: Installing Maven ==
4 4  
5 -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.
6 6  
7 7  {{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:
8 8  
9 -install macports [http://www.macports.org/install.php], then on the terminal:
10 -{noformat}
10 +{{noformat}}
11 +
11 11  sudo port install maven3
12 -{noformat}
13 13  
14 +{{/noformat}}
15 +
14 14  In future, to keep this up to date:
15 -{noformat}
17 +
18 +{{noformat}}
19 +
16 16  sudo port upgrade maven3
17 -{noformat}
18 18  
22 +{{/noformat}}
23 +
19 19  Don't forget to install maven_select:
20 -{noformat}
25 +
26 +{{noformat}}
27 +
21 21  sudo port install maven_select
22 -{noformat}
23 23  
30 +{{/noformat}}
24 24  {{/tip}}
25 25  
26 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
33 +**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
27 27  
28 28  == Step 2: Configuring your Maven Settings ==
29 29  
30 30  Advanced users can skip this step, but it's highly recommended.
31 31  
32 -[[Quick Start Maven Settings Configuration Guide]]
39 +[[doc:Quick Start Maven Settings Configuration Guide]]
33 33  
34 -**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>^settings.xml]] and install it to /.m2/settings.xml.
41 +**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.
35 35  
36 -See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
43 +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.
37 37  
38 38  == Step 3: Installing WebObjects Libraries ==
39 39  
... ... @@ -47,14 +47,12 @@
47 47  
48 48  **NOTE**: WebObjects must be installed.
49 49  
50 -**See** the [[maven-wobootstrap-plugin>>maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
57 +**See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
51 51  
52 -**See** [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
59 +**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.
53 53  
54 54  {{warning title="Installing the right jars!"}}
55 -
56 -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.
57 -
62 +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.
58 58  {{/warning}}
59 59  
60 60  == Step 4: Creating a WebObjects or Wonder Project ==
... ... @@ -71,11 +71,11 @@
71 71  
72 72  The maven-archetype-plugin will ask the required information to create the new project.
73 73  
74 -**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]].
79 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>doc:woapplication-archetype]].
75 75  
76 -**NOTE**: You can use archetypes within Eclipse as described [[here>>documentation:Maven Create WO Application Project||anchor="m2eclipse"]].
81 +**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
77 77  
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/]].**
83 +**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 79  
80 80  == Step 5: Importing the Project into Eclipse ==
81 81  
... ... @@ -82,17 +82,16 @@
82 82  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.
83 83  
84 84  {{note title="Warning"}}
85 -
86 86  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:
87 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
88 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
89 -# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
90 90  
92 +1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
93 +1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
94 +1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
91 91  {{/note}}
92 92  
93 93  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.
94 94  
95 -**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"]].
99 +**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"]].
96 96  
97 97  == Step 6: Building WebObjects Applications with Maven ==
98 98  
... ... @@ -114,4 +114,4 @@
114 114  
115 115  {{/noformat}}
116 116  
117 -This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##
121 +This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}