Added project-documentation
[juplo-dialect] / src / site / xhtml / index.xhtml
diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml
new file mode 100644 (file)
index 0000000..852b5ae
--- /dev/null
@@ -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>