From: Kai Moritz Date: Wed, 9 Oct 2013 19:30:28 +0000 (+0200) Subject: Reworked APT-Documentation: page-titles were missing X-Git-Tag: hibernate4-maven-plugin-1.0.3~5 X-Git-Url: http://juplo.de/gitweb/?a=commitdiff_plain;h=84e8517be79d88d7e2bec2688a8f965f591394bf;p=hibernate4-maven-plugin Reworked APT-Documentation: page-titles were missing --- diff --git a/src/site/apt/configuration.apt b/src/site/apt/configuration.apt index a0934138..98fad3bc 100644 --- a/src/site/apt/configuration.apt +++ b/src/site/apt/configuration.apt @@ -1,6 +1,10 @@ -Configuration Examples + --- + Configuration Examples + --- + Kai Moritz + --- -* Configuration through a hibernate.properties-File +Configuration through a hibernate.properties-File The most simple way to configure the plugin is, to put all the hibernate-configuration in a <>-file on your @@ -59,7 +63,7 @@ Configuration Examples You never can overwrite them by accident when specifying a property on the commandline or in your <<>>. -* Configuration through maven-properties +Configuration through maven-properties Alternatively, it is possible, to configure the plugin via maven-properties. Each relevant configuration-option has a corresponding maven-property @@ -120,7 +124,7 @@ Configuration Examples --------------- -* Configuration through the plugin-configuration +Configuration through the plugin-configuration A third way for configuring the plugin is the plugin-configuration. The relevant configuration-parameters are: diff --git a/src/site/apt/debugging.apt b/src/site/apt/debugging.apt index 5e3d5ab6..37e81186 100644 --- a/src/site/apt/debugging.apt +++ b/src/site/apt/debugging.apt @@ -1,4 +1,8 @@ -Enabling Debug-Output + --- + Enabling Debug-Output + --- + Kai Moritz + --- If you are new to <<>>, in many cases, the {Configuration-Method-Precedence} may be the source of configuration diff --git a/src/site/apt/force.apt b/src/site/apt/force.apt index 566811ae..bff87d87 100644 --- a/src/site/apt/force.apt +++ b/src/site/apt/force.apt @@ -1,4 +1,8 @@ -Force execution + --- + Force execution + --- + Kai Moritz + --- The hibernate4-maven-plugin computes MD5-sums for all found annotated classes and stores them together with the generated schema. diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index 63116846..76af6732 100644 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -1,4 +1,8 @@ -A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annotations. + --- + A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annotations. + --- + Kai Moritz + --- <> is a plugin for generating a database-schema from your Hibernate-4-Mappings and create or update your database @@ -31,7 +35,7 @@ A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annota 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 +Documentation * See {{{./configuration.html} Configuration Examples}} for Usage-Explanations and simple examples of how to use this plugin. @@ -42,7 +46,7 @@ A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annota of the Hibernate-Tools <<>> and <<>>, that do the work in the background. -* Releases +Releases * {{{http://juplo.de/hibernate4-maven-plugin} current version}} diff --git a/src/site/apt/issue-tracking.apt b/src/site/apt/issue-tracking.apt index 8edcb435..42292e1a 100644 --- a/src/site/apt/issue-tracking.apt +++ b/src/site/apt/issue-tracking.apt @@ -1,4 +1,8 @@ -Issue Tracking + --- + Issue Tracking + --- + Kai Moritz + ---- <> diff --git a/src/site/apt/mail-lists.apt b/src/site/apt/mail-lists.apt index f55b6207..e8c17ec5 100644 --- a/src/site/apt/mail-lists.apt +++ b/src/site/apt/mail-lists.apt @@ -1,4 +1,8 @@ -Mailing Lists + --- + Mailing Lists + --- + Kai Moritz + --- <> diff --git a/src/site/apt/pitfalls.apt b/src/site/apt/pitfalls.apt index 24909a5c..33c40cfa 100644 --- a/src/site/apt/pitfalls.apt +++ b/src/site/apt/pitfalls.apt @@ -1,6 +1,10 @@ -Known Pitfalls + --- + Known Pitfalls + --- + Kai Moritz + --- -* hibernate4-maven-plugin always needs a database-connection +hibernate4-maven-plugin always needs a database-connection The default-configuration uses the EXPORT-target of the SchemaExport-Tool. If you do not need to create a database with the evaluated schema, you can @@ -17,7 +21,7 @@ Known Pitfalls But even when no database is to be created, hibernate always needs to know the dialect. Hence, the plugin will fail if this parameter is missing! -* Dependency for driver-class XYZ is missing +Dependency for driver-class XYZ is missing One regular problem is the scope of the jdbc-driver-dependency. It is very unlikely, that this dependency is needed at compile-time. @@ -81,7 +85,7 @@ Known Pitfalls Because otherwise, this dependency will unnecessarily bloat the runtime-dependencies of your project. -* DBUnit {fails} after execution of hibernate4 was skipped because nothing has changed +DBUnit {fails} after execution of hibernate4 was skipped because nothing has changed If hibernate4-maven-plugin skips its excecution, this may lead to errors in other plugins. @@ -113,7 +117,7 @@ Known Pitfalls ------------ -* The database will not be recreated after a manual drop/clean +The database will not be recreated after a manual drop/clean If one manually drops the database or removes the hsqldb-files, it will not be recreated by the hibernate4-maven-plugin, because it cannot detect, that @@ -135,7 +139,7 @@ Known Pitfalls mvn hibernate4:export -Dhibernate.export.force=true ------------- -* The hibernate4:export goal is not executed, when tests are skipped +The hibernate4:export goal is not executed, when tests are skipped The hibernate4-maven-plugin automatically skips its execution, when <<>> is set to <<>>. If you need it to be always @@ -153,4 +157,4 @@ mvn hibernate4:export -Dhibernate.export.force=true ------------ Background-information for this design-decission can be found on the extra - page {{{./skip.html}To skip or not to skip: that is the question}}... \ No newline at end of file + page {{{./skip.html}To skip or not to skip: that is the question}}...