============================================
JIOWA Code Generator Framework 2.1:  README
============================================

Run class "com.jiowa.codegen.example.ExampleCodeGenerationApplication" as Java Application 
to start the Code Generation Example.

--------------------------------------
Please check also the following files:
--------------------------------------

- LICENSE (This software is licensed under the JIOWA Backlinking License v1.0 )
- Jiowa-Code-Generator-2.1-Tutorial_and_Handbook.pdf 
  (Online version on slideshare.net is always up to date)
- JavaDoc: ./doc/javadoc-online.html  redirects to  http://www.jiowa.de/jiowa-codegen/doc/api/

-----------------------------
IMPORTANT BUILD INFORMATION:
-----------------------------

- Activate “Build Automatically” in your IDE.

- a) For Eclipse IDE everything is pre-configured:
     Whenever a template or property file is changed, 
     a Maven build is triggered and the template beans are rebuild.
     
  b) If you are not using Eclipse, you should configure your IDE to call the Maven build whenever a template 
     or one of the property files is changed (in order to rebuild the template beans).
     You can also call Maven build manually instead.

- beanbuild.cmd: 
  For Unix/Linux/MacOS: executable flag is set automatically via the maven build (in the initialize phase)
                        ( You can set it also manually: chmod +x beanbuild.cmd )

- Set the IDE to "Insert spaces for tabulators"  (4 spaces == 1 Tabulator; which is Eclipse default)

- Activate Java Syntax highlighting in your IDE for all files with *.jgt suffix (if your target platform is Java).

- All templates are located in src/main/resources/generator/templates

- The property files for the code generators in this example project are: jiowa.codegen.properties & letter.codegen.properties

- There are two example code generators (ClassGenerator, LetterGenerator) which are used by 
  class ExampleCodeGenerationApplication.

- Template syntax errors are shown on save
  a) in the console
     and
  b) in a generated class TemplateBeanCompilerResult.java in the template bean directory src/gen-beans/java
     The syntax error messages intentionally create java compile errors in class TemplateBeanCompilerResult
     to ensure compile-time safety for Jiowa generator templates (*.jgt files).
     Using this approach, no specific plugin for any IDE is necessary.

- Version control: 
  Template beans should never be checked in.
  Make sure the files under src/gen-beans/java will not be checked in.
  
- Your own generated sources have to be checked in 
  (because you might want to used protected regions etc.)
  and are placed into src/gen/java

- The java compiler in pom.xml is set to 1.6 just in case you are not using the newest Java version.
  You can change that to 1.8 (or 1.7).

That's all! Have fun!  

Questions?
Feedback?

Email: codegen@jiowa.de


(C) 2012-2015 JIOWA Business Solutions GmbH, Bettinastr. 30, D-60325 Frankfurt am Main, Germany, www.jiowa.de