Changes between Version 9 and Version 10 of MolgenisApps

Timestamp:

2011-07-21T22:06:13+02:00 (14 years ago)

Author:

Morris Swertz

Comment:

--

MolgenisApps

@@ -41 +41 @@
 == Description of all project elements ==
 
-=== build_xyz automatic build scripts ===
+=== build scripts ===
 Each app can be build automatically by running {{{ant build_xyz.xml}}} or in eclipse, right-click and choose 'run as'->'Ant build'. 
 For example: build_xgap.xml builds a runnable version of xgap. 
-
-The build script defines all settings for the app. For example:
-
-{{{
-!#xml
-<project>
-        <!-- this name is used to name the war file -->
-        <property name="app_name" value="col7a1" />
-
-        <!-- this holds all the settings for the generator -->
-        <property name="app_properties" value="apps/${app_name}/org/molgenis/${app_name}/${app_name}.properties"/>
-        
-        <!-- this determines what additional modules should be loaded -->
-        <path id="app.class.path">
-                <pathelement location="apps/${app_name}" />
-                <pathelement location="modules/datamodel" />
-                <pathelement location="modules/auth" />
-                <pathelement location="modules/pheno" />
-                <pathelement location="modules/search" />       
-        </path>
-
-        <!-- import all tasks from build_common: clean, generate, compile, test, war, standalone-jar -->
-        <import file="build_common.xml" />
-
-</project>
-}}}
 
 The build scripts provide the following standard methods:
@@ -81 +55 @@
 
 At every change in SVN, hudson will run clean-generate-compile-test and sent emails if errors are found.
+
+== Creating a new app ==
+
+In order to create a new app you must:
+
+1. create a new folder in /apps/<name>. This folder should contain:
+  * package org.molgenis.<name>
+  * <name>.properties file
+ 
+2. create a new build script: build_<name>.xml. This file should contain:
+
+{{{
+!#xml
+<project>
+        <!-- this name is used to name the war file -->
+        <property name="app_name" value="appname" />
+
+        <!-- this holds all the settings for the generator -->
+        <property name="app_properties" value="apps/${app_name}/org/molgenis/${app_name}/${app_name}.properties"/>
+        
+        <!-- this determines what additional modules should be loaded -->
+        <path id="app.class.path">
+                <pathelement location="apps/${app_name}" />
+                <!-- below optional dependencies on modules -->
+                <pathelement location="modules/datamodel" />
+                <pathelement location="modules/auth" />
+                <pathelement location="modules/pheno" />
+                <pathelement location="modules/search" />       
+        </path>
+
+        <!-- below, import all tasks from build_common: clean, generate, compile, test, war, standalone-jar -->
+        <import file="build_common.xml" />
+
+</project>
+}}}
+
+
 
 === /apps ===