Added project-documentation

diff --git a/pom.xml b/pom.xml
index c74c7df..25050cc 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -6,6 +6,37 @@
   <artifactId>juplo-dialect</artifactId>
   <version>1.0-SNAPSHOT</version>
 
+  <name>Juplo Thymeleaf-Dialect</name>
+  <description>A thymeleaf-dialect, that collects some usefull utils, missing in the thymeleaf-distribution</description>
+  <url>http://juplo.de/juplo-dialect/index.html</url>
+
+  <scm>
+    <connection>scm:git:http://juplo.de/git/juplo-dialect</connection>
+    <developerConnection>scm:git:ssh://juplo.de:/var/lib/git/juplo/juplo-dialect</developerConnection>
+    <url>http://juplo.de/gitweb/?p=juplo-dialect;a=summary</url>
+  </scm>
+
+  <developers>
+    <developer>
+      <id>kai</id>
+      <name>Kai Moritz</name>
+      <email>kai@juplo.de</email>
+    </developer>
+  </developers>
+
+  <organization>
+    <name>juplo</name>
+    <url>http://juplo.de</url>
+  </organization>
+
+  <licenses>
+    <license>
+      <name>GNU Lesser General Public License, Version 3.0</name>
+      <url>http://www.gnu.org/licenses/lgpl-3.0.en.html</url>
+      <distribution>repo</distribution>
+    </license>
+  </licenses>
+
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <java.version>1.8</java.version>
@@ -65,7 +96,102 @@
           <target>${java.version}</target>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>2.1.2</version><!-- Should be same version as in oss-parent-7 -->
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <phase>verify</phase>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-resources-plugin</artifactId>
+        <version>2.7</version>
+        <dependencies>
+          <dependency>
+            <groupId>org.apache.maven.shared</groupId>
+            <artifactId>maven-filtering</artifactId>
+            <version>1.3</version>
+          </dependency>
+        </dependencies>
+        <executions>
+          <execution>
+            <id>copy-resources</id>
+            <phase>pre-site</phase>
+            <goals>
+              <goal>copy-resources</goal>
+            </goals>
+            <configuration>
+              <outputDirectory>${project.build.directory}/filtered-site</outputDirectory>
+              <resources>
+                <resource>
+                  <directory>src/site</directory>
+                  <filtering>true</filtering>
+                </resource>
+              </resources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <artifactId>maven-site-plugin</artifactId>
+          <version>3.5.1</version>
+          <configuration>
+            <siteDirectory>${project.build.directory}/filtered-site</siteDirectory>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
   </build>
 
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-changes-plugin</artifactId>
+        <version>2.11</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.7</version><!-- Should be same version as in oss-parent-7 -->
+        <configuration>
+          <additionalparam>-Xdoclint:none</additionalparam>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>2.5</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-pmd-plugin</artifactId>
+        <version>3.4</version>
+        <configuration>
+          <linkXref>true</linkXref>
+          <targetJdk>1.5</targetJdk>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>2.9</version>
+        <configuration>
+          <linkOnly>true</linkOnly>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+
 </project>

diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644 (file)
index 0000000..36f2cf0
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,21 @@
+<project>
+  <skin>
+    <groupId>de.juplo.maven</groupId>
+    <artifactId>maven-thymeleaf-skin</artifactId>
+    <version>1.0.0</version>
+  </skin>
+  <body>
+    <menu>
+      <item name="About" href="index.html"/>
+      <item name="Project Information" href="project-info.html"/>
+      <item name="Project Reports" href="project-reports.html"/>
+    </menu>
+    <menu ref="reports"/>
+  </body>
+  <custom>
+    <thymeproxy>
+      <path>/juplo-dialect/</path>
+      <crumbs><![CDATA[{&quot;uri&quot;:&quot;/projects.html&quot;,&quot;name&quot;:&quot;Projects&quot;}]]></crumbs>
+    </thymeproxy>
+  </custom>
+</project>

diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml
new file mode 100644 (file)
index 0000000..852b5ae
--- /dev/null
+++ b/src/site/xhtml/index.xhtml
@@ -0,0 +1,46 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ </head>
+ <body>
+  <h1>${project.name}</h1>
+  <h2>${project.description}</h2>
+  <p>
+    The Juplo Thymeleaf-Dialect collects some usefull utils, that we found were missing in the thymeleaf-distribution.
+    The following attribute-processors are added by the dialect:
+  </p>
+  <ul>
+    <li>
+      The <strong>juplo:active</strong> substitutes an <code>&lt;a&gt;</code>-tag by an <code>&lt;strong&gt;</code>-tag, if its parameter evaluates to <code>true</code>.
+       The content of the tag and all attributes, that are also valid in the context of an <code>&lt;strong&gt;</code>-tag are kept.
+    </li>
+    <li>
+      The <strong>juplo:inactive</strong> substitutes an <code>&lt;a&gt;</code>-tag by an <code>&lt;span&gt;</code>-tag, if its parameter evaluates to <code>true</code>.
+       The content of the tag and all attributes, that are also valid in the context of an <code>&lt;span&gt;</code>-tag are kept.
+    </li>
+    <li>
+      The <strong>juplo:variables</strong> parses JSON-data, that must contain an object as root-element and imports the key/value-pairs of this object as node-local variables.
+    </li>
+  </ul>
+  <p>
+    <strong>juplo:active</strong> and <strong>juplo:inactive</strong> are very usefull, if you build a complex navigation-logic like a deep menu or a breadcrumb-path and do not want, that links to the current page appear in the markup.
+    <strong>juplo:variables</strong> can be used to make variables available to a thymeleaf-template, when it is not possible or desirable, to change or add a controller to do so.
+  </p>
+  <p>
+    This thymeleaf-dialect was developed as a part of the project
+    <a href="http://yourshouter.com/projekte/crowdgest%C3%BCtzte-veranstaltungs-suchmaschine.html">Entwicklung einer crowdgestützten Suchmaschine für Veranstaltungs- und Locationdaten</a>.
+    As one of the winners of the
+    <a href="http://yourshouter.com/referenzen/leitmarktwettbewerb-createmedia-nrw.html">CreateMedia.NRW</a>-contest,
+    the project is promoted by the
+    <a href="http://yourshouter.com/partner/mweimh-nrw.html">ministerium for economy, energy, industry, medium-sized bussinesses and handcraft for the state of North-Rhine Westphalia</a>
+    in the course of the
+    <a href="http://yourshouter.com/partner/efre--europ%C3%A4ischer-fonds-f%C3%BCr-regionale-entwicklung.html">OP EFRE.NRW 2014 — 2020</a>.
+  </p>
+  <h2>Releases</h2>
+  <ul>
+    <li><a href="${project.url}">current version</a></li>
+    <li>${project.version} (this version)</li>
+  </ul>
+ </body>
+</html>

diff --git a/src/site/xhtml/issue-tracking.xhtml b/src/site/xhtml/issue-tracking.xhtml
new file mode 100644 (file)
index 0000000..f7e6859
--- /dev/null
+++ b/src/site/xhtml/issue-tracking.xhtml
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ </head>
+ <body>
+  <strong>There is no bug-tracking system set up for this project!</strong>
+  <p>
+  Please send your bug-reports, questions or feature-requests directly
+  to the developer.
+  </p>
+ </body>
+</html>

diff --git a/src/site/xhtml/mail-lists.xhtml b/src/site/xhtml/mail-lists.xhtml
new file mode 100644 (file)
index 0000000..ff8d7f2
--- /dev/null
+++ b/src/site/xhtml/mail-lists.xhtml
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ </head>
+ <body>
+  <strong>There are no mailinglists defined for this project!</strong>
+  <p>
+  Please send your bug-reports, questions or feature-requests directly
+  to the developer.
+  </p>
+ </body>
+</html>