From 2ec0af491d992d9c26000f803bbc61fdb1299318 Mon Sep 17 00:00:00 2001 From: Kai Moritz Date: Sat, 16 Jul 2016 21:10:16 +0200 Subject: [PATCH] Reworked project-documentation: moved to maven-thymeleaf-skin --- pom.xml | 7 +- src/site/site.xml | 17 +- src/site/template.vm | 334 ---------------------------- src/site/xhtml/configuration.xhtml | 1 + src/site/xhtml/debugging.xhtml | 1 + src/site/xhtml/force.xhtml | 1 + src/site/xhtml/index.xhtml | 18 +- src/site/xhtml/issue-tracking.xhtml | 1 + src/site/xhtml/mail-lists.xhtml | 1 + src/site/xhtml/pitfalls.xhtml | 1 + src/site/xhtml/skip.xhtml | 1 + 11 files changed, 34 insertions(+), 349 deletions(-) delete mode 100644 src/site/template.vm diff --git a/pom.xml b/pom.xml index 2356d057..11f9e547 100644 --- a/pom.xml +++ b/pom.xml @@ -12,10 +12,10 @@ de.juplo hibernate-maven-plugin Hibernate Maven Plugin - Plugin for generating a database-schema from Hibernate-Mapping-Annotations + A simple plugin for generating a database-schema from Hibernate-Mappings 2.1-SNAPSHOT maven-plugin - http://juplo.de/hibernate-maven-plugin + http://juplo.de/hibernate-maven-plugin/index.html 2.0.6 @@ -326,10 +326,9 @@ maven-site-plugin - 3.4 + 3.5.1 ${project.build.directory}/filtered-site - src/site/template.vm diff --git a/src/site/site.xml b/src/site/site.xml index 111fb6b4..e62c0b12 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -1,16 +1,29 @@ - UA-571104-3 + - + + + + + de.juplo.maven + maven-thymeleaf-skin + 1.0.0 + + + + /hibernate-maven-plugin/ + + + diff --git a/src/site/template.vm b/src/site/template.vm deleted file mode 100644 index 5f586296..00000000 --- a/src/site/template.vm +++ /dev/null @@ -1,334 +0,0 @@ - - -## Datenstrukturen für die Navigation (Breadcrumbs und Menü) vorbereiten -#set ( $crumbs = $project.getClass().forName('java.util.LinkedList').newInstance() ) -#set ( $parents = $project.getClass().forName('java.util.LinkedList').newInstance() ) -#set ( $active = 'index.html' ) -#set ( $skiplist = [ 'index.html' ] ) -#macro ( searchBreadcrumbTrail $items ) - #if ( $breadcrumbs ) - ## Der zuerst gefundene Pfad gilt (denn dieser liegt im selbst erzeugten Menü) - #else - #foreach ( $item in $items ) - #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) ) - #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) ) - #if ( $alignedFileName == $currentItemHref ) - ## Sonderfall abfangen :/ - #if ( $alignedFileName == 'index.html' ) - #set ( $breadcrumbs = [] ) - #set ( $path = [ 'index.html' ] ) - #else - #set ( $breadcrumbs = $crumbs.clone() ) - ## Den Titel der Seite korrigieren! - #set ( $title = "$project.name - $item.name" ) - #set ( $shortTitle = $item.name ) - ## Pfad für die Identifizierung sichtbarer Menüeinträge aufbauen - #set ( $path = [ 'index.html' ] ) - #foreach ( $crumb in $crumbs ) - #set ( $currentItemHref = $PathTool.calculateLink( $crumb.href, $relativePath ) ) - #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) ) - #set ( $sinkhole = $path.add( $currentItemHref ) ) - #end - #set ( $sinkhole = $path.add( $alignedFileName ) ) - #end - #else - #if ( !$item.items.empty ) - #set ( $sinkhole = $crumbs.push( $item ) ) - #searchBreadcrumbTrail ( $item.items ) - #set ( $sinkhole = $crumbs.pop() ) - #end - #end - #end - #end -#end -#macro ( buildSkiplist $item ) - #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) ) - #set ( $sinkhole = $skiplist.add( $currentItemHref.replaceAll( '\\', '/' ) ) ) - #foreach ( $item in $item.items ) - #buildSkiplist ( $item ) - #end -#end -#macro ( findActive $item $skip) - #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) ) - #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) ) - #set ( $doskip = false ) - #if ( $skip ) - #foreach ( $toskip in $skiplist ) - #if ( $currentItemHref == $toskip ) - #set ( $doskip = true ) - #end - #end - #end - #if ( !$doskip ) - #if ( $alignedFileName == $currentItemHref ) - #if ( $item.items.size() > 0 ) - #set ( $active = $alignedFileName ) - #else - #set ( $active = $parents.peek() ) - #end - #end - #set ( $sinkhole = $parents.push( $currentItemHref ) ) - #foreach ( $item in $item.items ) - #findActive ( $item $skip ) - #end - #set ( $sinkhole = $parents.pop() ) - #end -#end -#foreach ( $menu in $decoration.body.menus ) - ## Breadcrumb-Pfad suchen - #searchBreadcrumbTrail ( $menu.items ) - ## Bestimmen, welche Pfade in dem selbst definierten Menü liegen - #set ( $sinkhole = $parents.push( 'index.html' ) ) - #if ( !$menu.name ) - #foreach ( $item in $menu.items ) - #buildSkiplist( $item ) - #end - ## Aktives (Unter-)Menü bestimmen (und dabei nichts überspringen) - #foreach ( $item in $menu.items ) - #findActive( $item false) - #end - #else - ## Aktives (Unter-)Menü bestimmen (und dabei Einträge aus dem selbst - ## definierten Menü überspringen) - #foreach ( $item in $menu.items ) - #findActive( $item true) - #end - #end - #set ( $sinkhole = $parents.pop() ) - ## Sonderbehandlung der Einträge im selbst angelegten Menü - ## Das Menü wird daran erkannt, das der Name leer ist! -#end - - - - -## -#macro ( link $href $name $class ) - #set ( $linkTitle = ' title="' + $name + '"' ) - #if ( $href.toLowerCase().startsWith("http:/") || $href.toLowerCase().startsWith("https:/") || - $href.toLowerCase().startsWith("ftp:/") || $href.toLowerCase().startsWith("mailto:") || - $href.toLowerCase().startsWith("file:/") || ($href.toLowerCase().indexOf("://") != -1) ) - #set ( $linkClass = ' class="external ' + $class + '"' ) - #else - #set ( $linkClass = ' class="' + $class + '"' ) - #end - $name -#end -## -#macro ( menuItem $item $parent $skip) - #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) ) - #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) ) - #set ( $doskip = false ) - #if ( $skip ) - #foreach ( $toskip in $skiplist ) - #if ( $currentItemHref == $toskip ) - #set ( $doskip = true ) - #end - #end - #end -## - #if ( !$doskip ) - #set ( $onPath = false ) - #set ( $parentActive = false ) - #set ( $off = '' ) - #set ( $sub = '' ) - #set ( $cssClass = 's' ) - #foreach ( $entry in $path ) - #if ( $entry == $currentItemHref ) - #set ( $onPath = true ) - #set ( $cssClass = 's selected' ) - #end - #if ( $entry == $parent && $parent == $active ) - #set ( $parentActive = true ) - #end - #end - #if ( $item.items.size() > 0 ) - #set ( $sub = ' sub' ) - #end - #if ( !$onPath && !$parentActive ) - #set ( $off = ' off' ) - #end -
  • - #if ( $alignedFileName == $currentItemHref ) - $item.name - #else - #link( $currentItemHref $item.name $cssClass ) - #end - #if ( $item.items.size() > 0 && ( $currentItemHref == $active || $onPath ) ) - #set ( $newparent = $currentItemHref ) -
      - #foreach( $item in $item.items ) - #menuItem( $item $newparent $skip ) - #end -
    - #end -
    • - #end -#end -## -#macro ( copyright ) - #if ( $project ) - #set ( $currentYear = ${currentDate.year} + 1900 ) -## - #if ( ${project.inceptionYear} && ( ${project.inceptionYear} != ${currentYear.toString()} ) ) - ${project.inceptionYear}-${currentYear} - #else - ${currentYear} - #end - #end -#end -## - - - juplo - $title - - - - - - - - -#foreach( $author in $authors ) - -#end -#if ( $dateCreation ) - -#end - #if ( $decoration.body.head ) - #foreach( $item in $decoration.body.head.getChildren() ) - ## Workaround for DOXIA-150 due to a non-desired behaviour in p-u - ## @see org.codehaus.plexus.util.xml.Xpp3Dom#toString() - ## @see org.codehaus.plexus.util.xml.Xpp3Dom#toUnescapedString() - #set ( $documentHeader = '' ) - #if ( $item.name == "script" ) - $StringUtils.replace( $item.toUnescapedString(), $documentHeader, "" ) - #else - $StringUtils.replace( $item.toString(), $documentHeader, "" ) - #end - #end - #end - $headContent - - -
    - - -
    -
    -

    $shortTitle

    - $bodyContent -
    -
    - - -
    -
    - -
    - #if( $decoration.googleAnalyticsAccountId && $decoration.googleAnalyticsAccountId != "" ) - - #end - - diff --git a/src/site/xhtml/configuration.xhtml b/src/site/xhtml/configuration.xhtml index 712bdfb4..e6e738da 100644 --- a/src/site/xhtml/configuration.xhtml +++ b/src/site/xhtml/configuration.xhtml @@ -4,6 +4,7 @@ +

    Configuration Examples

    Configuration Through A Configuration-File

    The most simple way to configure the plugin is, to put all the diff --git a/src/site/xhtml/debugging.xhtml b/src/site/xhtml/debugging.xhtml index 6271077d..2fab3254 100644 --- a/src/site/xhtml/debugging.xhtml +++ b/src/site/xhtml/debugging.xhtml @@ -4,6 +4,7 @@ +

    Enable Debugging-Output

    If you are new to hibernate-maven-plugin, in many cases, the Configuration-Method-Precedence diff --git a/src/site/xhtml/force.xhtml b/src/site/xhtml/force.xhtml index ecdab5bd..4e4fdcbb 100644 --- a/src/site/xhtml/force.xhtml +++ b/src/site/xhtml/force.xhtml @@ -4,6 +4,7 @@ +

    Force Execution

    The hibernate-maven-plugin computes MD5-sums for all found annotated classes and stores them together with the generated schema. diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml index 7a2b02c8..ff1ca5ef 100644 --- a/src/site/xhtml/index.xhtml +++ b/src/site/xhtml/index.xhtml @@ -4,8 +4,8 @@ -

    Hibernate Maven Plugin

    -

    A simple Plugin for generating a Database-Schema from Hibernate Mapping-Annotations

    +

    ${project.name}

    +

    ${project.description}

    The hibernate-maven-plugin is a plugin for generating a database-schema from your Hibernate-Mappings and create or update your database @@ -58,14 +58,14 @@

    Releases

    diff --git a/src/site/xhtml/issue-tracking.xhtml b/src/site/xhtml/issue-tracking.xhtml index f7e68598..40e609d8 100644 --- a/src/site/xhtml/issue-tracking.xhtml +++ b/src/site/xhtml/issue-tracking.xhtml @@ -4,6 +4,7 @@ +

    Issue Tracking

    There is no bug-tracking system set up for this project!

    Please send your bug-reports, questions or feature-requests directly diff --git a/src/site/xhtml/mail-lists.xhtml b/src/site/xhtml/mail-lists.xhtml index ff8d7f2b..3dbb7330 100644 --- a/src/site/xhtml/mail-lists.xhtml +++ b/src/site/xhtml/mail-lists.xhtml @@ -4,6 +4,7 @@ +

    Mailing Lists

    There are no mailinglists defined for this project!

    Please send your bug-reports, questions or feature-requests directly diff --git a/src/site/xhtml/pitfalls.xhtml b/src/site/xhtml/pitfalls.xhtml index d762b3ae..3d8c6164 100644 --- a/src/site/xhtml/pitfalls.xhtml +++ b/src/site/xhtml/pitfalls.xhtml @@ -4,6 +4,7 @@ +

    Known Pitfalls (FAQ)

    Annotated classes in dependencies are not found.

    hibernate-maven-plugin by default scans dependencies in the scope diff --git a/src/site/xhtml/skip.xhtml b/src/site/xhtml/skip.xhtml index e25ed0ed..9b570c9f 100644 --- a/src/site/xhtml/skip.xhtml +++ b/src/site/xhtml/skip.xhtml @@ -4,6 +4,7 @@ +

    Skipping Execution

    In most use-cases, the hibernate-maven-plugin is used to create a test-database automatically. In this use-cases, it is very likely, that it -- 2.20.1