Changes for page Getting started

Summary

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

Details

Page properties

Author

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

Content

...	...	@@ -1,70 +1,72 @@
1		-== Outline ==
	1	+== Introduction ==
2	2
3		-{{toc style="disc" indent="20px"}}{{/toc}}
	3	+This guide is aimed at those who'd like to set up a local wolips development environment. This guide is mainly targeted towards maven users of WOLips, however much of guide is useful, whether you use maven or ant, so far as installation instructions for eclipse plugins. At least, these are the steps that I (ldeck) travel through and it is essentially a brain-dump to save me from future maintenance work .
4	4
5		-== Introduction ==
	5	+== Outline ==
6	6
7		-This guide is aimed at those who'd like to set up a local wolips development environment utilising maven and scm (git, svn).
	7	+{{toc style="disc" indent="20px"/}}
8	8
9	9	== Install Maven ==
10	10
11		-You can download and install maven for most platforms [[here>>http://maven.apache.org/download]].
	11	+You can download and install maven for most platforms [[here>>url:http://maven.apache.org/download||shape="rect"]].
12	12
13	13	{{tip title="Mac Tip"}}
	14	+install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal
14	14
15		- install macports [http://www.macports.org/install.php], then on the terminal
16		- {noformat}sudo port install maven2{noformat}
	16	+{{noformat}}
	17	+sudo port install maven2
	18	+{{/noformat}}
17	17
18		- In future, to keep this up to date:
19		- {noformat}sudo port upgrade maven2{noformat}
	20	+In future, to keep this up to date:
20	20
	22	+{{noformat}}
	23	+sudo port upgrade maven2
	24	+{{/noformat}}
21	21	{{/tip}}
22	22
23	23	== Download Eclipse ==
24	24
25		-Eclipse can be downloaded and installed from [[www.eclipse.org/downloads/>>http://www.eclipse.org/downloads/]]. For mac it's just a simple matter of unpacking the zip file downloaded into /Applications or /Users/youraccount/Applications.
	29	+Eclipse can be downloaded and installed from [[www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]]. For mac it's just a simple matter of unpacking the zip file downloaded into /Applications or /Users/youraccount/Applications.
26	26
27	27	{{tip title="Which one do I choose?"}}
28		-
29		- Eclipse Classic (161MB) is a popular choice among WO developers.
30		- However, the more lightweight Eclipse IDE for Java Developers (91MB) should work.
31		-
	32	+Eclipse Classic (161MB) is a popular choice among WO developers.
	33	+ However, the more lightweight Eclipse IDE for Java Developers (91MB) should work.
32	32	{{/tip}}
33	33
34	34	== Launch Eclipse ==
35	35
36	36	Open eclipse by double clicking on the application icon (from where you installed it).
37		-[[image:LaunchEclipse.png]]
	39	+[[image:attach:LaunchEclipse.png]]
38	38
39	39	Eclipse will then ask you for the location of a 'workspace' which is where eclipse will store its metadata.
40		-[[image:LaunchEclipseWorkspace.png]]
	42	+[[image:attach:LaunchEclipseWorkspace.png]]
41	41
42		-== Eclipse plugins ==
	44	+== Install Eclipse plugins ==
43	43
44	44	Various plugins have prerequisites, and some are just useful anyway, so here's a suggested order of installing some useful plugins when setting up a brand new eclipse environment.
45	45
46	46	==== Step 1 - Choose the menu item: Help > install new software... ====
47	47
48		-[[image:install_menu.png]]
	50	+[[image:attach:install_menu.png]]
49	49
50	50	This will open the install window:
51		-[[image:install_window.png]]
	53	+[[image:attach:install_window.png]]
52	52
53	53	==== Step 2 - install the testNG plugin (for a simple example) ====
54	54
55	55	===== a) Click the "Add..." button to define the update site, fill in the details, click OK. =====
56	56
57		-[[image:addsite_testng.png]]
	59	+[[image:attach:addsite_testng.png]]
58	58
59	59	===== b) Tick the plugin fragments to install =====
60	60
61		-[[image:fragments_testng.png]]
	63	+[[image:attach:fragments_testng.png]]
62	62
63	63	===== c) Click next repeatedly, confirming license agreements, finally clicking "Finish" to install. =====
64	64
65	65	===== d) after the software plugin has installed, it will prompt you for a restart of eclipse. Click Yes. =====
66	66
67		-[[image:install_restart.png]]
	69	+[[image:attach:install_restart.png]]
68	68
69	69	===== e) after eclipse has restarted, continue... =====
70	70
...	...	@@ -71,36 +71,135 @@
71	71	==== Step 3 - install Groovy ====
72	72
73	73	Repeat step 2 with the following detail changes:
74		-Site name: Groovy-dev
75		-Site location: http:~/~/dist.codehaus.org/groovy/distributions/updateDev/
	76	+ Site name: Groovy-dev
	77	+ Site location: [[http:~~/~~/dist.codehaus.org/groovy/distributions/updateDev/>>url:http://dist.codehaus.org/groovy/distributions/updateDev/||rel="nofollow" shape="rect" class="external-link"]]
76	76
77	77	==== Step 4 - Install subversive connectors ====
78	78
79	79	Repeat step 2 with the following detail changes:
80		-Site name: Subversive-connectors
81		-Site location: http:~/~/community.polarion.com/projects/subversive/download/eclipse/2.0/galileo-site/
82		-Fragments selected: 'Subversive SVN Connectors', 'SVNKit 1.3 Implementation (Optional)'
	82	+ Site name: Subversive-connectors
	83	+ Site location: [[http:~~/~~/community.polarion.com/projects/subversive/download/eclipse/2.0/galileo-site/>>url:http://community.polarion.com/projects/subversive/download/eclipse/2.0/galileo-site/||rel="nofollow" shape="rect" class="external-link"]]
	84	+ Fragments selected: 'Subversive SVN Connectors', 'SVNKit 1.3 Implementation (Optional)'
83	83
84		-[[image:fragments_subversive.png]]
	86	+[[image:attach:fragments_subversive.png]]
85	85
86		-===== Step 5 - Install egit =====
	88	+===== Step 5 - Install egit =====
87	87
88	88	Repeat step 2 with the following detail changes:
89		-Site name: egit
90		-Site location: http:~/~/www.jgit.org/updates
	91	+ Site name: egit
	92	+ Site location: [[http:~~/~~/www.jgit.org/updates>>url:http://www.jgit.org/updates||rel="nofollow" shape="rect" class="external-link"]]
91	91
92	92	===== Step 6 - Install m2eclipse =====
93	93
94	94	Repeat step 2 with the following detail changes:
95		-Site name: m2eclipse
96		-Site location: http:~/~/m2eclipse.sonatype.org/update-dev/
97		-Fragments selected: all fragments of 'Maven Integration'
98		-[[image:fragments_m2eclipse.png]]
	97	+ Site name: m2eclipse
	98	+ Site location: [[http:~~/~~/m2eclipse.sonatype.org/sites/m2e>>url:http://m2eclipse.sonatype.org/sites/m2e||rel="nofollow" shape="rect" class="external-link"]]
	99	+ Fragments selected: "Maven Integration for Eclipse (Required)"
	100	+[[image:attach:fragments_m2e_lmg.png]]
99	99
100		-===== Step 6 - Install WOLips 3.5 =====
	102	+===== Step 6 - Install WOLips =====
101	101
	104	+Choose an update site that's appropriate for the version of Eclipse you're running. The update site for Eclipse 3.5 is as follows. (Ask on the mailing list for future versions if it's not been updated here).
	105	+
102	102	Repeat step 2 with the following detail changes:
103		-Site name: WOLips//3//5
104		-Site location: http:~/~/webobjects.mdimension.com/wolips/eclipse_3_5/
105		-Fragments selected: all fragments of 'Maven Integration'
106		-[[image:fragments_wolips.png]]
	107	+ Site name: WOLips_3_5
	108	+ Site location: [[http:~~/~~/webobjects.mdimension.com/wolips/eclipse_3_5/>>url:http://webobjects.mdimension.com/wolips/eclipse_3_5/||rel="nofollow" shape="rect" class="external-link"]]
	109	+ Fragments selected: all "Standard Install" components
	110	+[[image:attach:fragments_wolips.png]]
	111	+
	112	+===== Step 7 - Other plugins =====
	113	+
	114	+Oh, sure I also install jadclipse ([[http:~~/~~/jadclipse.sf.net/update>>url:http://jadclipse.sf.net/update||rel="nofollow" shape="rect" class="external-link"]]) for keeping in touch with things but that's beyond the scope of this guide.
	115	+
	116	+== Configuring Eclipse ==
	117	+
	118	+==== wolips binding validation ====
	119	+
	120	+[[image:attach:wolips_bindingsvalidation.png]]
	121	+
	122	+==== wolips spaces around html tags ====
	123	+
	124	+[[image:attach:wolips_nospaces.png]]
	125	+
	126	+==== wolips launching ====
	127	+
	128	+As of this writing, wolips has forgotten to set the key "-WOHost" with value "localhost". Add it.
	129	+I also untick a few things that don't need to be specifically ticked so that your project's properties are used (as you're mimicking the deployment env locally)
	130	+[[image:attach:wolips_launching.png]]
	131	+
	132	+==== Set the default jvm ====
	133	+
	134	+[[image:attach:prefs_jvm.png]]
	135	+
	136	+==== Java typing prefs ====
	137	+
	138	+[[image:attach:prefs_java_typing.png]]
	139	+
	140	+==== Java Templates prefs ====
	141	+
	142	+[[image:attach:prefs_java_templates.png]]
	143	+
	144	+==== Run / Debug prefs ====
	145	+
	146	+I'll have 4 spaces per tab rather than 8 thanks!
	147	+ And I prefer to kill the console buffer manually rather than lose messages that might be important.
	148	+[[image:attach:prefs_console.png]]
	149	+
	150	+==== Launch configurations ====
	151	+
	152	+I don't like them disappearing on me when I close / delete projects
	153	+[[image:attach:prefs_launchconfig.png]]
	154	+
	155	+==== Lines numbers please ====
	156	+
	157	+[[image:attach:prefs_linenumbers.png]]
	158	+
	159	+==== UTF-8 Thanks ====
	160	+
	161	+[[image:attach:prefs_utf8.png]]
	162	+
	163	+== Creating a project ==
	164	+
	165	+TODO
	166	+
	167	+== Launching your project ==
	168	+
	169	+==== Configure eomodel connection dictionaries, log4j, additional properties ====
	170	+
	171	+In my application projects I create an additional folder called 'Properties' which contains additional property files for differing launches.
	172	+ e.g.,
	173	+ When connecting to a local database I use the local files listed below during launch:
	174	+
	175	+{{noformat}}
	176	+
	177	+jdbc.local.properties
	178	+log4j.local.properties
	179	+runtime.local.properties
	180	+...
	181	+jdbc.test.properties
	182	+log4j.test.properties
	183	+runtime.test.properties
	184	+
	185	+{{/noformat}}
	186	+
	187	+To achieve this switching easily I define in the launch configuration for the application the following two additional properties (from those defined globally in WOLips prefs)
	188	+
	189	+* key: -runtime.config.dir value:"../../Properties"
	190	+* key: -runtime.config.name value:".local"
	191	+
	192	+And in my application's Properties file I have the following properties declared
	193	+
	194	+{{noformat}}
	195	+
	196	+runtime.config.dir=Properties
	197	+runtime.config.name=
	198	+
	199	+er.extensions.ERXProperties.OptionalConfigurationFiles=(\
	200	+@@runtime.config.dir@@/log4j@@runtime.config.name@@.properties,\
	201	+@@runtime.config.dir@@/jdbc@@runtime.config.name@@.properties,\
	202	+@@runtime.config.dir@@/runtime@@runtime.config.name@@.properties\
	203	+)
	204	+
	205	+{{/noformat}}
	206	+
	207	+Naturally, within the jdbc property files are the relevant project wonder properties for configuring the eomodels connection dictionaries, withing the lo4j files are the relevant config for log4j, and runtime properties is available for any special configuration for that particular environment.