From 85bc31b1192b4cfafd69bbfdcec674511b49fd5c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Timo=20Westk=C3=A4mper?= <timo.westkamper@mysema.com>
Date: Fri, 15 Aug 2008 09:00:26 +0000
Subject: [PATCH] updated documentation

---
 querydsl-root/src/site/xdoc/index.xml | 46 +++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 querydsl-root/src/site/xdoc/index.xml
diff --git a/querydsl-root/src/site/xdoc/index.xml b/querydsl-root/src/site/xdoc/index.xml
new file mode 100644
index 000000000..93d1196c8
--- /dev/null
+++ b/querydsl-root/src/site/xdoc/index.xml
@@ -0,0 +1,46 @@
+<document>
+  <properties>
+    <author email="timo@mysema.com">Timo Westkämper</author>
+    <title>querydsl</title>
+  </properties>
+  <body>
+    <section name="Intro">
+      <p>
+      querydsl is a framework which enables the construction of statically typed SQL-like queries. 
+      Instead of writing queries as inline strings or externalizing them into XML files they can be constructed via a 
+      <a href="http://www.martinfowler.com/bliki/FluentInterface.html">fluent</a> API.
+      </p>
+      
+      <p>
+      The benefits of using a fluent API in comparison to simple strings are 
+      <ul>
+        <li>code completion in IDE</li>
+        <li>almost none syntactically invalid queries allowed</li>
+        <li>domain types and properties can be referenced safely</li>
+        <li>adopts better to refactoring changes in domain types</li>        
+      </ul>
+      </p>
+    </section>
+    
+    <section name="Modules">
+      <p>
+      querydsl is based on various modules with different purposes. The modules are
+      <ul>
+        <li><a href="../querydsl-core">querydsl-core</a> with the basic constructs used in various query language specific versions of the API</li>
+        <li><a href="../querydsl-annotations">querydsl-annotations</a> with Java annotations for domain and DTO types</li>
+        <li><a href="../querydsl-apt">querydsl-apt</a> for code generation via <a href="http://java.sun.com/j2se/1.5.0/docs/guide/apt/GettingStarted.html">APT</a></li>
+        <li><a href="../querydsl-hql">querydsl-hql</a> as a fluent API for <a href="http://www.hibernate.org/hib_docs/reference/en/html/queryhql.html">Hibernate HQL</a></li>
+        <li><a href="../querydsl-sql">querydsl-sql</a> as a fluent API for SQL</li>
+      </ul>
+      </p>
+    </section>
+    
+    <section name="Getting started">
+      <p>
+       Read the Getting started guides of <a href="../querydsl-hql/getting-started.html">querydsl-hql</a> 
+       if HQL is your target language or <a href="../querydsl-sql/getting-started.html">querydsl-sql</a> for SQL.
+      </p>
+    </section>
+  
+  </body>
+</document>
\ No newline at end of file
