Index: navigation.xml =================================================================== RCS file: /home/cvspublic/maven-plugins/genapp/xdocs/navigation.xml,v retrieving revision 1.5 diff -u -r1.5 navigation.xml --- navigation.xml 29 Mar 2004 16:37:11 -0000 1.5 +++ navigation.xml 25 Nov 2004 15:57:00 -0000 @@ -30,6 +30,7 @@ + Index: customizationguide.xml =================================================================== RCS file: customizationguide.xml diff -N customizationguide.xml --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ customizationguide.xml 1 Jan 1970 00:00:00 -0000 @@ -0,0 +1,91 @@ + + + + + + + Customization Guide + Miguel Griffa + + + +
+

+ The genapp plugin provides several general purpose tempaltes. + Companies or large sites may have their own application templates + that for whatever reason they want to keep inhouse. +

+

+ This guide is intended to help writing and mantaining application + templates outside the plugin. In this manner, the plugin can be updated + and the template is not affected. +

+

+ If you have some good application templates, consider contributing a general + purpose version to the project, so more users can benefit from it. +

+ +

+ Information on this guide can be used to write custom templates or to simpliy + customize buil-in templates. Since templates are currently stored in in .jar + you can't modify that template without having to mantain the version of the plugin + (for example, an upgrade of the plugin will not include you changes, unless they were + commited to maven's cvs). +

+ +
+
+ +

+ Go to you local maven installation, and open extract in a working directory + the contents of plugins/maven-genapp-plugin.x.y.jar (x.y is you current version). +

+

+ Inside the plugin-resources directory you can find many directories with different + templates. These directories contain the resources associated with the different + templates. Start by copying one of there to a different directory. This new copy + will be the one that we'll be working on. For this example, we will consider the + new tempalte directory to be on /opt/templates/foo +

+ + +

+ Go to /opt/templates/foo. You should find there a template.properties file and a + template-resources directory. The template properties file may be customized (open + it and play with its properties. +

+

+ Just play with files in the template until you have what you want. One of the things that + you are likely to change is the project.xml, to have you company infromation, your + directory layout and reports you use. +

+ +
+
+

+ Create a directory for your application and type maven genapp -Dmaven.genapp.template.dir=/opt/templates/foo + This should generate the application template you defined. +

+

+ If you are to write more templates, consider using the property maven.genapp.template.repository and place + there all your templates. Then, you can invoke you template by the name of the directory. +

+
+ +