Fixed bug in site-configuration

[hibernate4-maven-plugin] / src / site / apt / index.apt

diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 3b237a2..76af673 100644 (file)
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -1,26 +1,59 @@
-A simple plugin for generating a database-schema from Hibernate 4 mapping-annotations.
-
-  Hibernate comes with the buildin functionality, to automatically create or
-  update the database schema.
-  This functionality is configured in the session-configuraton via the
-  parameter <hbm2ddl.auto>
-  (see {{{http://docs.jboss.org/hibernate/orm/4.1/manual/en-US/html_single/#configuration-optional} Hibernate Reference Documentation - Chapter 3.4. Optional configuration properties}}).
-  But doing so
-  {{{http://stackoverflow.com/questions/221379/hibernate-hbm2ddl-auto-update-in-production} is not very wise}}, because you can easily corrupt or erase your
-  production database, if this configuration parameter slips through to your
-  production environment.
-  Alternatively, you can
-  {{{http://stackoverflow.com/questions/835961/how-to-creata-database-schema-using-hibernate} run the tools SchemaExport or SchemaUpdate by hand}}.
-  But that is not very comfortable and being used to maven you will quickly
-  long for a plugin, that does that job automatically for you, when you fire
-  up your test cases.
-
-  In the good old times, there was the
-  {{{http://mojo.codehaus.org/maven-hibernate3/hibernate3-maven-plugin/} Maven Hibernate3 Plugin}}, that does this for you.
-  But unfortunatly, this plugin is not compatible with Hibernate 4.x.
-
-  Since there does not seem to be any successor for the Maven Hibernate3 Plugin
-  and {{{http://www.google.de/search?q=hibernate4+maven+plugin} googeling}}
-  does not help, I decided to write up this simple plugin (inspired by these
-  two articles I found: {{{http://www.tikalk.com/alm/blog/schema-export-hibernate-4-and-maven} Schema Export with Hibernate 4 and Maven}} and
-  {{{http://doingenterprise.blogspot.de/2012/05/schema-generation-with-hibernate-4-jpa.html} Schema generation with Hibernate 4, JPA and Maven}}).
+  ---
+  A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annotations.
+  ---
+  Kai Moritz
+  ---
+
+  <<hibernate4-maven-plugin>> is a plugin for generating a database-schema
+  from your Hibernate-4-Mappings and create or update your database
+  accordingly.
+  Its main usage is to automatically create and populate a test-database
+  for unit-tests in cooperation with the
+  {{{http://mojo.codehaus.org/dbunit-maven-plugin/} dbunit-maven-plugin}}.
+
+  The plugin was designed with three main goals in mind:
+
+    * It should be easy to use.
+
+    * It should be maximal unlikely, to erase a producation-database by
+      accident.
+
+    * It should not slow down the development cycle.
+
+  To achieve the first goal, the convention-over-configuration paradigma
+  was applied and the plugin was stuffed with usefull logging-messages.
+  So, if in doubt, just turn on the {{{./debugging.html} debugging output}} with the <<<mvn -X ...>>>. 
+
+  To achieve the second goal, the precedence in which the configuration
+  locations are consulted was layouted in a way that makes it possible, to
+  prevent overwrites of the wrong database by accident.
+
+  Last but not least, in order to not slow down the development cycle, the
+  hibernate4-maven-plugin only executes the schema-export, if the mapping
+  or the dialect changes (or if you force it to do so).
+
+  For more information about the inspiration to write this tiny plugin,
+  {{{/hibernate4-maven-plugin-a-simple-plugin-for-generating-a-database-schema-from-hibernate-4-mapping-annotations/} read our blog-article about the hibernate4-maven-plugin}}.
+
+Documentation
+
+ * See {{{./configuration.html} Configuration Examples}} for Usage-Explanations
+   and simple examples of how to use this plugin.
+
+ * See {{{./export-mojo.html}hibernate4:export}} and
+    {{{./plugin-info.html} Plugin Documentation}} for the full
+   autogenerated documentation. These are mostly configuration-options
+   of the Hibernate-Tools <<<SchemaExport>>> and <<<SchemaUpdate>>>, that do
+   the work in the background.
+
+Releases
+
+ * {{{http://juplo.de/hibernate4-maven-plugin} current version}}
+
+ * ${project.version} (this version)
+
+ * {{{http://juplo.de/hibernate4-maven-plugin-1.0.2} 1.0.2}}
+
+ * {{{http://juplo.de/hibernate4-maven-plugin-1.0.1} 1.0.1}}
+
+ * {{{http://juplo.de/hibernate4-maven-plugin-1.0} 1.0}}