added documentation texts. Reference documentation is now uploaded automatically...
authorn.hoffmann <n.hoffmann@localhost>
Wed, 10 Nov 2010 17:10:04 +0000 (17:10 +0000)
committern.hoffmann <n.hoffmann@localhost>
Wed, 10 Nov 2010 17:10:04 +0000 (17:10 +0000)
pom.xml
src/site/apt/getting-started.apt
src/site/apt/reference.apt
src/site/fml/troubleshooting.fml
src/site/site.xml

diff --git a/pom.xml b/pom.xml
index 11a5bfc0c3e7d57fe42310fe11d18090e244e1d4..25e1a99350f5c5b8239aa202e7cdeedcb8aed510 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -66,7 +66,7 @@
        </organization>\r
        <developers>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>ben.clark</id>\r
                        <name>\r
                                Ben Clark\r
                                <role>Architect</role>\r
                                <role>Java Developer</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>n.hoffmann</id>\r
                        <name>\r
                                Niels Hoffmann\r
                        <roles>\r
                                <role>Java Developer</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>a.kohlbecker</id>\r
                        <name>\r
                                Andreas Kohlbecker\r
                        <roles>\r
                                <role>Java Developer</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>k.luther</id>\r
                        <name>\r
                                Katja Luther\r
                        <roles>\r
                                <role>Java Developer</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>a.mueller</id>\r
                        <name>\r
                                Andreas Müller\r
                                <role>Java Developer</role>\r
                                <role>Release Manager</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
                <developer>\r
-<!-- your SVN account id please! -->\r
+                       <!-- your SVN account id please! -->\r
                        <id>f.revilla</id>\r
                        <name>\r
                                Francisco Revilla       \r
                        <roles>\r
                                <role>Java Developer</role>\r
                        </roles>\r
-                       <url></url>\r
+                       <url/>\r
                </developer>\r
        </developers>\r
-<!--contributors>\r
+       <!--contributors>\r
                <contributor>\r
                        <name>Test-Contributor</name>\r
                </contributor>\r
                <url>http://dev.e-taxonomy.eu/trac/</url>\r
        </issueManagement>\r
        <ciManagement>\r
-           <system>Hudson</system>\r
-           <url>http://160.45.63.201/hudson</url>\r
+               <system>Hudson</system>\r
+               <url>http://160.45.63.201/hudson</url>\r
        </ciManagement>\r
-<!-- **** REPOSITORIES **** -->\r
+       <!-- **** REPOSITORIES **** -->\r
        <repositories>\r
-<!-- sun repository -->\r
+               <!-- sun repository -->\r
                <repository>\r
                        <id>java.net</id>\r
                        <url>http://download.java.net/maven/1/</url>\r
                </repository>\r
-<!-- the cdm internal repository -->\r
+               <!-- the cdm internal repository -->\r
                <repository>\r
                        <id>EditRepository</id>\r
                        <url>http://wp5.e-taxonomy.eu/cdmlib/mavenrepo/</url>\r
                </repository>\r
-<!-- apache incubating repository -->\r
+               <!-- apache incubating repository -->\r
                <repository>\r
                        <id>ApacheIncubating</id>\r
                        <url>http://people.apache.org/repo/m2-incubating-repository/</url>\r
                </repository>\r
-<!-- Neccessary for hibernate-envers -->\r
+               <!-- Neccessary for hibernate-envers -->\r
                <repository>\r
                        <releases>\r
                                <enabled>true</enabled>\r
                        <name>JBoss Repository</name>\r
                        <url>http://repository.jboss.com/maven2</url>\r
                </repository>\r
-<!-- codehaus mule repository needed for yourkit  -->\r
+               <!-- codehaus mule repository needed for yourkit  -->\r
                <repository>\r
                        <id>CodehausMuleRepository</id>\r
                        <url>http://dist.codehaus.org/mule/dependencies/maven2/</url>\r
                </repository>\r
-<!-- current spring source repositories -->\r
+               <!-- current spring source repositories -->\r
                <repository>\r
                        <id>SpringSource Enterprise Bundle Repository - External Bundle Milestones</id>\r
                        <url>http://repository.springsource.com/maven/bundles/milestone</url>\r
                        <url>http://repository.springsource.com/maven/bundles/external</url>\r
                </repository>\r
        </repositories>\r
-<!-- **** PLUGINS **** -->\r
+       <!-- **** PLUGINS **** -->\r
        <build>\r
                <plugins>\r
                        <plugin>\r
                                <version>1.0-beta-3</version>\r
                                <executions>\r
                                        <execution>\r
-<!--<phase>deploy</phase>-->\r
+                                               <!--<phase>deploy</phase>-->\r
                                                <goals>\r
                                                        <goal>create</goal>\r
                                                </goals>\r
                                </executions>\r
                                <configuration>\r
                                        <doCheck>false</doCheck>\r
-<!-- Only create the build number if there are no local modifications -->\r
+                                       <!-- Only create the build number if there are no local modifications -->\r
                                        <doUpdate>false</doUpdate>\r
-<!-- automatically update the local svn copy -->\r
+                                       <!-- automatically update the local svn copy -->\r
                                </configuration>\r
                        </plugin>\r
                        <plugin>\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-site-plugin</artifactId>\r
-<!-- \r
-                               Falling back to maven-site-plugin 2.0-beta-5 since\r
-                maven-site-plugin 2.0-beta-6 has this problem:\r
-                               Embedded error: Unrecognised tag: 'site' (position: START_TAG seen <?xml\r
-                version="1.0" encoding="ISO-8859-1"?>\r\n<site>... @2:7) -->\r
                                <version>2.1.1</version>\r
                                <configuration>\r
                                        <locales>en</locales>\r
                        <plugin>\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-source-plugin</artifactId>\r
+                               <version>2.1.2</version>\r
                                <executions>\r
                                        <execution>\r
                                                <id>attach-sources</id>\r
                        <plugin>\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-javadoc-plugin</artifactId>\r
+                               <version>2.7</version>\r
                                <configuration>\r
-                                       <aggregate>true</aggregate>\r
                                        <stylesheet>maven</stylesheet>\r
+                                       <quiet>true</quiet>\r
+                                       <detectLinks>true</detectLinks>\r
+                                       <failOnError>false</failOnError>\r
                                </configuration>\r
+                               <executions>\r
+                                       <execution>\r
+                                               <id>aggregate</id>\r
+                                               <goals>\r
+                                                       <goal>aggregate</goal>\r
+                                               </goals>\r
+                                               <phase>site</phase>\r
+                                       </execution>\r
+                               </executions>\r
                        </plugin>\r
                        <plugin>\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-eclipse-plugin</artifactId>\r
+                               <version>2.8</version>\r
                                <configuration>\r
                                        <downloadSources>true</downloadSources>\r
                                        <downloadJavadocs>true</downloadJavadocs>\r
                                        <chunkedOutput>true</chunkedOutput>\r
                                        <htmlStylesheet>resources/css/html.css</htmlStylesheet>\r
                                        <xincludeSupported>true</xincludeSupported>\r
-<!--<htmlCustomization>src/docbkx/resources/xsl/html_chunk.xsl</htmlCustomization>-->\r
-<!-- if anyone can get the xsl-fo customization to work properly, then by all \r
+                                       <!--<htmlCustomization>src/docbkx/resources/xsl/html_chunk.xsl</htmlCustomization>-->\r
+                                       <!-- if anyone can get the xsl-fo customization to work properly, then by all \r
                means use it\r
             <foCustomization>src/docbkx/resources/xsl/fopdf.xsl</foCustomization>\r
           -->\r
                                                        <value>${pom.version}</value>\r
                                                </entity>\r
                                        </entities>\r
-<!--We want the final documentation and the required resources to end up in \r
+                                       <!--We want the final documentation and the required resources to end up in \r
               the right place-->\r
                                        <postProcess>\r
                                                <copy todir="target/site/reference">\r
                                                        <fileset dir="target/docbkx">\r
-                                                               <include name="**/*.html"></include>\r
-                                                               <include name="**/*.pdf"></include>\r
+                                                               <include name="**/*.html"/>\r
+                                                               <include name="**/*.pdf"/>\r
                                                        </fileset>\r
                                                </copy>\r
                                                <copy todir="target/site/reference/html">\r
                                                        <fileset dir="src/docbkx">\r
-                                                               <include name="**/*.css"></include>\r
-                                                               <include name="**/*.png"></include>\r
-                                                               <include name="**/*.gif"></include>\r
-                                                               <include name="**/*.jpg"></include>\r
+                                                               <include name="**/*.css"/>\r
+                                                               <include name="**/*.png"/>\r
+                                                               <include name="**/*.gif"/>\r
+                                                               <include name="**/*.jpg"/>\r
                                                        </fileset>\r
                                                </copy>\r
                                        </postProcess>\r
                                </configuration>\r
                        </plugin>\r
+                       <plugin>\r
+                               <groupId>org.codehaus.mojo</groupId>\r
+                               <artifactId>wagon-maven-plugin</artifactId>\r
+                               <version>1.0-beta-3</version>\r
+                               <configuration>\r
+                                       <fromDir>${project.build.directory}/docbkx/</fromDir>\r
+                                       <includes>**/*</includes>\r
+                                       <excludes/>\r
+                                       <url>scpexe://160.45.63.151</url>\r
+                                       <serverId>wp5.e-taxonomy.eu</serverId>\r
+                                       <toDir>var/www/wp5.e-taxonomy.eu/cdmlib/reference/${pom.version}</toDir>\r
+                               </configuration>\r
+                               <executions>\r
+                                       <execution>\r
+                                               <id>upload-reference-documentation</id>\r
+                                               <phase>site-deploy</phase>\r
+                                               <goals>\r
+                                                       <goal>upload</goal>\r
+                                               </goals>\r
+                                       </execution>\r
+                               </executions>\r
+                       </plugin>\r
                </plugins>\r
-<!--  -->\r
+               <!--  -->\r
                <extensions>\r
                        <extension>\r
                                <groupId>org.apache.maven.wagon</groupId>\r
                                <artifactId>wagon-scm</artifactId>\r
                                <version>1.0-alpha-5</version>\r
                        </extension>\r
-<!--\r
+                       <extension>\r
+                               <groupId>org.apache.maven.wagon</groupId>\r
+                               <artifactId>wagon-ssh</artifactId>\r
+                               <version>1.0-beta-6</version>\r
+                       </extension>\r
+                       <extension>\r
+                               <groupId>org.apache.maven.wagon</groupId>\r
+                               <artifactId>wagon-ssh-external</artifactId>\r
+                               <version>1.0-beta-6</version>\r
+                       </extension>\r
+                       <!--\r
                                <extension>\r
                                <groupId>org.apache.maven.wagon</groupId>\r
                                <artifactId>wagon-ssh-external</artifactId>\r
                                <artifactId>maven-scm-provider-svnexe</artifactId>\r
                                <version>1.0</version>\r
                        </extension>\r
-<!-- WebDAV plugin to upload snapshots -->\r
+                       <!-- WebDAV plugin to upload snapshots -->\r
                        <extension>\r
                                <groupId>org.apache.maven.wagon</groupId>\r
                                <artifactId>wagon-webdav</artifactId>\r
        <reporting>\r
                <plugins>\r
                        <plugin>\r
-<!-- you will want to start by publishing your classes' Javadocs -->\r
+                               <!-- you will want to start by publishing your classes' Javadocs -->\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-javadoc-plugin</artifactId>\r
+                               <version>2.7</version>\r
                                <configuration>\r
-                                       <links>\r
-                                               <link>http://java.sun.com/j2se/1.6.0/docs/api/</link>\r
-                                               <link>http://static.springframework.org/spring/docs/2.5.x/api/</link>\r
-                                               <link>http://www.hibernate.org/hib_docs/v3/api/</link>\r
-<!-- more libraries? -->\r
-                                       </links>\r
+                                       <detectLinks>true</detectLinks>\r
                                </configuration>\r
                        </plugin>\r
                        <plugin>\r
-<!-- this will generate an indexed and cross-referenced HTML version of your source code -->\r
+                               <!-- this will generate an indexed and cross-referenced HTML version of your source code -->\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-jxr-plugin</artifactId>\r
+                               <version>2.2</version>\r
                        </plugin>\r
                        <plugin>\r
-<!-- if you use @todo tags to remind you of things to be done (which is a good coding practice), the taglist report will generate a list of all the items marked @todo or TODO -->\r
+                               <!-- if you use @todo tags to remind you of things to be done (which is a good coding practice), the taglist report will generate a list of all the items marked @todo or TODO -->\r
                                <groupId>org.codehaus.mojo</groupId>\r
                                <artifactId>taglist-maven-plugin</artifactId>\r
+                               <version>2.4</version>\r
                        </plugin>\r
                        <plugin>\r
-<!-- Test coverage can be a useful indication of the quality of your unit tests. It basically tells you how much of your code is actually run by your unit tests, which, in turn, can give you a good idea of the tests' quality -->\r
+                               <!-- Test coverage can be a useful indication of the quality of your unit tests. It basically tells you how much of your code is actually run by your unit tests, which, in turn, can give you a good idea of the tests' quality -->\r
                                <groupId>org.codehaus.mojo</groupId>\r
                                <artifactId>cobertura-maven-plugin</artifactId>\r
-<!--\r
+                               <version>2.4</version>\r
+                               <!--\r
                                        <executions>\r
                                        <execution>\r
                                        <id>clean</id>\r
                                        </executions>\r
                                -->\r
                        </plugin>\r
-<!--                   \r
+                       <!--                    \r
                        <plugin>\r
                                <groupId>org.apache.maven.plugins</groupId>\r
                                <artifactId>maven-project-info-reports-plugin</artifactId>\r
                                        </reportSet>\r
                                </reportSets>\r
                        </plugin>       -->\r
-<!-- The changes-maven-plugin plug-in uses a special XML file (src/changes/changes.xml) to track releases and changes in each release -->\r
-<!-- \r
+                       <!-- The changes-maven-plugin plug-in uses a special XML file (src/changes/changes.xml) to track releases and changes in each release -->\r
                        <plugin>\r
-                               <groupId>org.codehaus.mojo</groupId>\r
-                               <artifactId>changes-maven-plugin</artifactId>\r
+                               <groupId>org.apache.maven.plugins</groupId>\r
+                               <artifactId>maven-changes-plugin</artifactId>\r
+                               <version>2.3</version>\r
+                               <reportSets>\r
+                                       <reportSet>\r
+                                               <reports>\r
+                                                       <report>changes-report</report>\r
+                                               </reports>\r
+                                       </reportSet>\r
+                               </reportSets>\r
                        </plugin>\r
+                       <!--\r
                        <plugin>\r
                                <artifactId>maven-surefire-plugin</artifactId>\r
                        </plugin>\r
                        -->\r
-<!-- The changelog plug-in generates a nice report describing which files have been changed and by whom -->\r
-<!-- \r
+                       <!-- The changelog plug-in generates a nice report describing which files have been changed and by whom -->\r
+                       <!-- \r
                        <plugin>\r
                                <groupId>org.codehaus.mojo</groupId>\r
                                <artifactId>changelog-maven-plugin</artifactId>\r
                        -->\r
                </plugins>\r
        </reporting>\r
-<!--    DISTRIBUTION MANAGEMENT -->\r
+       <!--     DISTRIBUTION MANAGEMENT -->\r
        <distributionManagement>\r
                <site>\r
                        <id>wp5.e-taxonomy.eu</id>\r
                        <layout>default</layout>\r
                </repository>\r
        </distributionManagement>\r
-<!-- **** DEPENDENCIES **** -->\r
+       <!-- **** DEPENDENCIES **** -->\r
        <dependencies>\r
                <dependency>\r
                        <groupId>org.unitils</groupId>\r
                                <artifactId>cdmlib-print</artifactId>\r
                                <version>${project.version}</version>\r
                        </dependency>\r
-<!--*********** JAXB********* -->\r
+                       <!--*********** JAXB********* -->\r
                        <dependency>\r
                                <groupId>javax.xml.bind</groupId>\r
                                <artifactId>jaxb-api</artifactId>\r
                                <artifactId>jaxb-xjc</artifactId>\r
                                <version>2.1.6</version>\r
                        </dependency>\r
-<!-- ******* VARIOUS ******* -->\r
+                       <!-- ******* VARIOUS ******* -->\r
                        <dependency>\r
                                <groupId>log4j</groupId>\r
                                <artifactId>log4j</artifactId>\r
                                <version>1.2.15</version>\r
                        </dependency>\r
-<!-- hibernate 3.4 uses slf4j -->\r
+                       <!-- hibernate 3.4 uses slf4j -->\r
                        <dependency>\r
                                <groupId>org.slf4j</groupId>\r
                                <artifactId>slf4j-api</artifactId>\r
                                <artifactId>sanselan</artifactId>\r
                                <version>0.97-incubator</version>\r
                        </dependency>\r
-<!-- joda-time -->\r
+                       <!-- joda-time -->\r
                        <dependency>\r
                                <groupId>joda-time</groupId>\r
                                <artifactId>joda-time</artifactId>\r
                                <artifactId>dozer</artifactId>\r
                                <version>5.3.0</version>\r
                        </dependency>\r
-<!-- ******* XML ******* -->\r
+                       <!-- ******* XML ******* -->\r
                        <dependency>\r
                                <groupId>xml-apis</groupId>\r
                                <artifactId>xml-apis</artifactId>\r
                                <artifactId>stax</artifactId>\r
                                <version>1.2.0</version>\r
                        </dependency>\r
-<!-- ******* HIBERNATE / EJB3 ******* -->\r
+                       <!-- ******* HIBERNATE / EJB3 ******* -->\r
                        <dependency>\r
                                <groupId>javax.persistence</groupId>\r
                                <artifactId>persistence-api</artifactId>\r
                                <artifactId>servlet-api</artifactId>\r
                                <version>2.5</version>\r
                        </dependency>\r
-<!-- ******* SPRING ******* -->\r
+                       <!-- ******* SPRING ******* -->\r
                        <dependency>\r
                                <groupId>org.springframework</groupId>\r
                                <artifactId>org.springframework.core</artifactId>\r
                                        </exclusion>\r
                                </exclusions>\r
                        </dependency>\r
-<!-- ******* SERVLET/JSP/JSF ******* -->\r
+                       <!-- ******* SERVLET/JSP/JSF ******* -->\r
                        <dependency>\r
                                <groupId>javax.servlet</groupId>\r
                                <artifactId>servlet-api</artifactId>\r
                                <version>2.5</version>\r
                        </dependency>\r
-<!-- ******* DATABASES DRIVER ******* -->\r
+                       <!-- ******* DATABASES DRIVER ******* -->\r
                        <dependency>\r
-<!-- SQL Server and Sybase -->\r
+                               <!-- SQL Server and Sybase -->\r
                                <groupId>net.sourceforge.jtds</groupId>\r
                                <artifactId>jtds</artifactId>\r
                                <version>1.2.2</version>\r
                                <artifactId>hsqldb</artifactId>\r
                                <version>1.8.0.7</version>\r
                        </dependency>\r
-<!--for sqlserver2008 and sqlserver2005-->\r
+                       <!--for sqlserver2008 and sqlserver2005-->\r
                        <dependency>\r
                                <groupId>com.microsoft.sqlserver</groupId>\r
                                <artifactId>jdbc4</artifactId>\r
                                <version>2.0</version>\r
                        </dependency>\r
-<!-- use SQL Server 2005 driver instead (com.microsoft.sqlserver/jdbc)\r
+                       <!-- use SQL Server 2005 driver instead (com.microsoft.sqlserver/jdbc)\r
                <dependency>\r
                        <groupId>com.microsoft.jdbcdriver</groupId>\r
                        <artifactId>mssqlserver</artifactId>\r
                                <artifactId>h2</artifactId>\r
                                <version>1.1.115</version>\r
                        </dependency>\r
-<!-- yourkit profiler api controller (used in ..)-->\r
+                       <!-- yourkit profiler api controller (used in ..)-->\r
                        <dependency>\r
                                <groupId>com.yourkit</groupId>\r
                                <artifactId>yjp-controller-api-redist</artifactId>\r
                                <version>8.0.1</version>\r
                        </dependency>\r
-<!-- For Validation -->\r
+                       <!-- For Validation -->\r
                        <dependency>\r
                                <groupId>javax.validation</groupId>\r
                                <artifactId>validation-api</artifactId>\r
index be2952c26b230008bcced01de03a57ef10452bde..36df4b1f00723c1fc0e504f996abdb37a3b30b9a 100644 (file)
@@ -1 +1,151 @@
-Getting Started
\ No newline at end of file
+Developing with the CDM Library
+
+  Table of Contents
+
+       * {{{Integrating_the_CDM_Library_into_a_maven_project}Integrating the CDM Library into a maven project}}
+       
+       * {{{Spring_applications_with_the_CDM_Library}Spring applications with the CDM Library}}
+       
+       * {{{Developing_the_CDM_Library}Developing the CDM Library}}
+       
+
+  <<Note:>> If you are not familiar with eclipse, maven or subversion please read the {{{http://dev.e-taxonomy.eu/trac/wiki/DeveloperApplications}developer applications document}} for brief introductions. Please see {{{./troubleshooting.html}Troubleshooting}} in case you run into problems or contact {{{mailto:editsupport@bgbm.org}editsupport@bgbm.org}}.
+
+* Integrating the CDM Library into a maven project
+
+  To integrate the CDM Library into your personal maven project pelase add our maven repository to your POM: {{http://wp5.e-taxonomy.eu/cdmlib/mavenrepo/}}. To use the <cdmlib-service> package add the following dependency to you POM (adapt the right version number !!):
+
+---
+<dependency>
+       <groupId>eu.etaxonomy</groupId>
+       <artifactId>cdmlib-service</artifactId>
+       <version>x.x</version>
+</dependency>
+---
+
+
+* Spring applications with the CDM Library
+
+  In your own applicationContext.xml you can simply import the cdm service spring beans from the library. In addition it also needs a datasource bean and a hibernateProperties bean specific for that datasource. The CDM Library comes with an embedded hypersonic database that is super easy to use. All you need to do is to import that hsql specific spring configuration like this:
+
+---
+applicationContext.xml
+
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.springframework.org/schema/beans   
+               http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+       <import resource="classpath:/eu/etaxonomy/cdm/services.xml" />
+       <import resource="classpath:/eu/etaxonomy/cdm/hsql-datasource.xml" />
+    
+</beans>
+---
+
+  In case you want to define the datasource within your own applicationContext you can surely do so. For a typical mysql database it looks like this: 
+
+---
+applicationContext.xml
+
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.springframework.org/schema/beans   
+               http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
+
+       <import resource="classpath:/eu/etaxonomy/cdm/services.xml" />
+
+    <bean id="dataSource" 
+                       class="org.springframework.jdbc.datasource.DriverManagerDataSource">
+        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
+        <property name="url" value="jdbc:mysql://192.168.2.10/cdm_build"/>
+        <property name="username" value="cdm_user"/>
+        <property name="password" value="why_do_i_need_this"/>
+    </bean>
+    
+    <bean id="hibernateProperties" 
+                       class="org.springframework.beans.factory.config.PropertiesFactoryBean">
+        <property name="properties">
+            <props>
+                <prop key="hibernate.hbm2ddl.auto">validate</prop>
+                <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
+                <prop key="hibernate.cache.provider_class">
+                                       org.hibernate.cache.NoCacheProvider
+                               </prop>
+                <prop key="hibernate.show_sql">false</prop>
+                <prop key="hibernate.format_sql">false</prop>
+            </props>
+        </property>
+    </bean>    
+</beans>
+---
+
+
+* Developing the CDM Library
+
+  To use the entire CDM Library with Eclipse, you need some plugins and to follow this installation guide:
+
+    * install maven 2.0.x commandline tools locally (http://maven.apache.org/download.html). Follow the instruction to install maven on your local machine.
+
+    * install subclipse 1.6.x in eclipse if not yet installed (Update Site: http://subclipse.tigris.org/update_1.6.x). 
+
+    * make sure Java JDK >= 1.6 is installed (JRE is not enough) and JAVA_HOME is set to JDK path
+
+    * checkout cdmlib and create eclipse artifacts (using e.g. tortoiseSVN):
+
+---
+$ svn co http://dev.e-taxonomy.eu/svn/trunk/cdmlib/ .
+---
+
+    * make sure maven has run at least one time (to create the .m2 folder). If unsure how to do this, run <<<mvn install>>> in the new checked out folder ../cdmlib/cmlib-commons
+    
+       * Set in Eclipse preferences (not project properties) M2_REPO java class variable (menue: java-buildPath-Classpath), pointing to your local repository. 
+       
+               * In OSX for example    /Users/USERNAME/.m2/repository 
+    
+               * In WinXP for example  C:\Documents and Settings\USERNAME\.m2\repository
+               
+    * setup new eclipse workspace (where ever you want but using the cdmlib folder may be comfortable
+    
+       * run the following commands in your cdmlib folder
+
+---
+$ mvn install 
+---
+         to compile and install the cdmlib packages in your local repository.
+      
+--- 
+$ mvn eclipse:eclipse 
+---
+      to let maven create project dependencies and Eclipse metafiles (.project s.o.)
+
+    * create the java projects: 
+
+       * In Eclipse open the Import Wizard: File->Import->General->Existing Projects into Workspace. 
+
+       * Choose "Select root directory". Click "Browse" and navigate to your cdmlib folder (should open by default) and confirm the file dialog.
+
+       * The projects should now show in the Import Wizard window. Select the projects you want wo work on and hit OK.
+
+    * Install AspectJ compiler {{http://www.eclipse.org/aspectj/downloads.php}} , make sure you add the \<aspectj install dir\>/lib/aspectjrt.jar to your class path and <aspectj install dir>/lib/ to your path
+
+    * Install AspectJ Development Tools (AJDT) - Plugin (for eclipse) (Update-Site:{{http://download.eclipse.org/tools/ajdt/xx/dev/update}}) where xx depends on your eclipse installation: xx=35 for eclipse 3.5 and xx=36 for eclipse 3.6
+
+    * Referesh cdmlib-model project within eclipse 
+
+    * Convert the cdmlib-model to AspectJ (right mouse click on project -> AspectJ Tools -> ...).
+!! Each time when running mvn eclipse:eclipse on cdmlib-model (or on cdmlib parent folder) you have to first remove and then add AspectJ anew!! 
+
+    * It is also recommended to use the EclipseCodeTemplate
+
+
+* Where do I go from here?
+
+       Now that you have integrated or installed the CDM Library you are probably looking for documentation on how to develop with it. A good start is to read the {{{./reference.html}reference documentation}} of the CDM Library. The {{{./cdm-uml}UML diagrams}} are also a good starting point to get familiar with the structure of the Common Data Model itself or consult the {{{./apidocs}javadoc}} for the API documentation.
+       
+       If you want to start coding immediately, we prepared some {{{https://dev.e-taxonomy.eu/trac/wiki/CDMLibraryExamples}code examples}} in the developers wiki.
+
+
index cc7d2052e35e3a2cc6edaa0b2550c0da899e77b9..af695fedeca5b739736f697b405a10bfcc4e98a7 100644 (file)
@@ -1 +1,7 @@
-Reference
\ No newline at end of file
+Reference Documentation
+
+       The reference documentation for the CDM Library exists in two flavors:
+       
+       * {{{./reference/html/ReferenceDocumentation.html}Read reference documentation online}}
+       
+       * {{{./reference/pdf/ReferenceDocumentation.pdf}Download reference documentation as pdf}}
\ No newline at end of file
index 6215adba63d3895e11075ebd0f9e5d9b43088d12..2416a3c8c4e8b6525b0439a0c1691ace25e7b968 100644 (file)
@@ -1,49 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<faqs xmlns="http://maven.apache.org/FML/1.0.1"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
-  title="Troubleshooting"
-  toplink="false">
-
-  <part id="general">
-    <title>General</title>
-
-    <faq id="whats-foo">
-      <question>
-        What is Foo?
+<faqs xmlns="http://maven.apache.org/FML/1.0.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd" title="Troubleshooting" toplink="false">
+       <part id="maven">
+               <title>Maven</title>
+               <faq id="generic-errors">
+                       <question>
+        Why do I get "... is not within its bound" errors when running maven install?
       </question>
-      <answer>
-        <p>some markup goes here</p>
-
-        <source>some source code</source>
-
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-
-    <faq id="whats-bar">
-      <question>
-        What is Bar?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-  </part>
-
-  <part id="install">
-
-    <title>Installation</title>
-
-    <faq id="how-install">
-      <question>
-        How do I install Foo?
-      </question>
-      <answer>
-        <p>some markup goes here</p>
-      </answer>
-    </faq>
-
-  </part>
-
-</faqs>
\ No newline at end of file
+                       <answer>
+                               <p>For some unclear reasons we encountered problems using maven in combination with aspectj.
+               We did not yet resolve this problem but at least found a work-around:</p>
+                               <ol>
+                                       <li>run <code>mvn clean</code> (probably not really needed)</li>
+                                       <li>open Eclipse IDE</li>
+                                       <li>make sure that cdmlib-model is converted to an AspcetJ project (see [#Eclipsesetup Eclipse setup] for detailed information) - sometimes it helps if you first remove AspectJ and then convert it again</li>
+                                       <li>run Project-clean</li>
+                                       <li>run <code>mvn install</code></li>
+                               </ol>
+                               <p>This seems to work at least on our computers as eclipse better compiles aspectj then maven does. So please first try the above if you encounter any compilation problems.</p>
+                               <p>If it still does not work please try to install the newest eclipse aspectj plugin (for installation instructions see below).If it still does not work please let us know.</p>
+                       </answer>
+               </faq>
+       </part>
+</faqs>
index a43ef27fdbb2f4de3858cb59daa0a1251c31e16e..205d2206358a197a00395d36f06ac628060fd087 100644 (file)
@@ -18,7 +18,7 @@
                        <item name="Details" href="overview.html"/>
                        <item name="FAQ" href="faq.html"/>
                        <item name="License" href="license.html"/>
-                       <item name="Download" href="download.html"/>
+                       <item name="Releases" href="changes-report.html"/>
                </menu>
                <menu name="Developer">
                        <item name="Getting started" href="getting-started.html"/>