From c7e8a035dd31c2fd232bfcd7c13fb0d2d2c6337e Mon Sep 17 00:00:00 2001 From: David Montag Date: Thu, 10 Mar 2011 22:37:40 -0800 Subject: [PATCH 1/4] First step toward guidebook style documentation. --- src/docbkx/about-book.xml | 6 ++ src/docbkx/index.xml | 68 ++++++++++++++----- src/docbkx/{ => reference}/cross-store.xml | 0 src/docbkx/{ => reference}/neo4j.xml | 0 src/docbkx/{ => reference}/preface.xml | 0 .../{ => reference}/programming-model.xml | 0 src/docbkx/{ => reference}/samples.xml | 0 src/docbkx/{ => reference}/setup.xml | 0 src/docbkx/tutorial/about-spring-data.xml | 6 ++ src/docbkx/tutorial/about-tutorial.xml | 6 ++ src/docbkx/tutorial/annotations.xml | 6 ++ src/docbkx/tutorial/data-access.xml | 6 ++ src/docbkx/tutorial/domain.xml | 6 ++ src/docbkx/tutorial/recommendations.xml | 6 ++ src/docbkx/tutorial/security.xml | 6 ++ src/docbkx/tutorial/setup.xml | 6 ++ src/docbkx/tutorial/social.xml | 6 ++ 17 files changed, 110 insertions(+), 18 deletions(-) create mode 100644 src/docbkx/about-book.xml rename src/docbkx/{ => reference}/cross-store.xml (100%) rename src/docbkx/{ => reference}/neo4j.xml (100%) rename src/docbkx/{ => reference}/preface.xml (100%) rename src/docbkx/{ => reference}/programming-model.xml (100%) rename src/docbkx/{ => reference}/samples.xml (100%) rename src/docbkx/{ => reference}/setup.xml (100%) create mode 100644 src/docbkx/tutorial/about-spring-data.xml create mode 100644 src/docbkx/tutorial/about-tutorial.xml create mode 100644 src/docbkx/tutorial/annotations.xml create mode 100644 src/docbkx/tutorial/data-access.xml create mode 100644 src/docbkx/tutorial/domain.xml create mode 100644 src/docbkx/tutorial/recommendations.xml create mode 100644 src/docbkx/tutorial/security.xml create mode 100644 src/docbkx/tutorial/setup.xml create mode 100644 src/docbkx/tutorial/social.xml diff --git a/src/docbkx/about-book.xml b/src/docbkx/about-book.xml new file mode 100644 index 000000000..b3ca500e2 --- /dev/null +++ b/src/docbkx/about-book.xml @@ -0,0 +1,6 @@ + + + + foo + + diff --git a/src/docbkx/index.xml b/src/docbkx/index.xml index 692811e82..0fe4edb75 100644 --- a/src/docbkx/index.xml +++ b/src/docbkx/index.xml @@ -1,9 +1,9 @@ - + + - Spring Data Graph - Reference Documentation + The Spring Data Graph Guidebook &version; @@ -37,28 +37,60 @@ - - Introduction + + Foreword: Rod Johnson, CEO of SpringSource + + Rod ... + + - - - - - + + Foreword: Emil Eifrem, CEO of Neo Technology + + Emil ... + + + + + About this book + + Duplex book ... + + + + + Tutorial + + + Tutorial intro ... + + + + + + + + + + + + + Reference - This part of the reference documentation details the API, concepts, annotations, datastore, programming model and - the cross-store approach of Spring Data Graph. + This is the reference part of the book. It has information about the programming model, APIs, + concepts, and annotations of Spring Data Graph. - - - - - - + + + + + + + diff --git a/src/docbkx/cross-store.xml b/src/docbkx/reference/cross-store.xml similarity index 100% rename from src/docbkx/cross-store.xml rename to src/docbkx/reference/cross-store.xml diff --git a/src/docbkx/neo4j.xml b/src/docbkx/reference/neo4j.xml similarity index 100% rename from src/docbkx/neo4j.xml rename to src/docbkx/reference/neo4j.xml diff --git a/src/docbkx/preface.xml b/src/docbkx/reference/preface.xml similarity index 100% rename from src/docbkx/preface.xml rename to src/docbkx/reference/preface.xml diff --git a/src/docbkx/programming-model.xml b/src/docbkx/reference/programming-model.xml similarity index 100% rename from src/docbkx/programming-model.xml rename to src/docbkx/reference/programming-model.xml diff --git a/src/docbkx/samples.xml b/src/docbkx/reference/samples.xml similarity index 100% rename from src/docbkx/samples.xml rename to src/docbkx/reference/samples.xml diff --git a/src/docbkx/setup.xml b/src/docbkx/reference/setup.xml similarity index 100% rename from src/docbkx/setup.xml rename to src/docbkx/reference/setup.xml diff --git a/src/docbkx/tutorial/about-spring-data.xml b/src/docbkx/tutorial/about-spring-data.xml new file mode 100644 index 000000000..10c971d14 --- /dev/null +++ b/src/docbkx/tutorial/about-spring-data.xml @@ -0,0 +1,6 @@ + + + + About Spring Data + foo + diff --git a/src/docbkx/tutorial/about-tutorial.xml b/src/docbkx/tutorial/about-tutorial.xml new file mode 100644 index 000000000..a06352fb7 --- /dev/null +++ b/src/docbkx/tutorial/about-tutorial.xml @@ -0,0 +1,6 @@ + + + + About this tutorial + foo + diff --git a/src/docbkx/tutorial/annotations.xml b/src/docbkx/tutorial/annotations.xml new file mode 100644 index 000000000..d14a4e17c --- /dev/null +++ b/src/docbkx/tutorial/annotations.xml @@ -0,0 +1,6 @@ + + + + Annotating the domain model + foo + diff --git a/src/docbkx/tutorial/data-access.xml b/src/docbkx/tutorial/data-access.xml new file mode 100644 index 000000000..28067b4a3 --- /dev/null +++ b/src/docbkx/tutorial/data-access.xml @@ -0,0 +1,6 @@ + + + + Accessing the data + foo + diff --git a/src/docbkx/tutorial/domain.xml b/src/docbkx/tutorial/domain.xml new file mode 100644 index 000000000..f2eae9a40 --- /dev/null +++ b/src/docbkx/tutorial/domain.xml @@ -0,0 +1,6 @@ + + + + The domain + foo + diff --git a/src/docbkx/tutorial/recommendations.xml b/src/docbkx/tutorial/recommendations.xml new file mode 100644 index 000000000..46fb6698c --- /dev/null +++ b/src/docbkx/tutorial/recommendations.xml @@ -0,0 +1,6 @@ + + + + Adding recommendations + foo + diff --git a/src/docbkx/tutorial/security.xml b/src/docbkx/tutorial/security.xml new file mode 100644 index 000000000..2f8da73e5 --- /dev/null +++ b/src/docbkx/tutorial/security.xml @@ -0,0 +1,6 @@ + + + + Adding security + foo + diff --git a/src/docbkx/tutorial/setup.xml b/src/docbkx/tutorial/setup.xml new file mode 100644 index 000000000..86ec3a4f8 --- /dev/null +++ b/src/docbkx/tutorial/setup.xml @@ -0,0 +1,6 @@ + + + + Project setup + foo + diff --git a/src/docbkx/tutorial/social.xml b/src/docbkx/tutorial/social.xml new file mode 100644 index 000000000..12b1201ad --- /dev/null +++ b/src/docbkx/tutorial/social.xml @@ -0,0 +1,6 @@ + + + + Adding social + foo + From d65e4f6837033c5b3e499e4e0cb773159a51044e Mon Sep 17 00:00:00 2001 From: David Montag Date: Thu, 10 Mar 2011 23:03:16 -0800 Subject: [PATCH 2/4] Fleshed out the tutorial a bit more with prelim headlines. --- src/docbkx/about-book.xml | 6 ---- src/docbkx/index.xml | 5 ++- src/docbkx/tutorial/about-spring-data.xml | 6 +++- src/docbkx/tutorial/about-tutorial.xml | 4 ++- src/docbkx/tutorial/annotations.xml | 23 ++++++++++++- src/docbkx/tutorial/data-access.xml | 24 ++++++++++++-- src/docbkx/tutorial/domain.xml | 34 ++++++++++++++++++- src/docbkx/tutorial/recommendations.xml | 4 ++- src/docbkx/tutorial/security.xml | 4 ++- src/docbkx/tutorial/setup.xml | 40 ++++++++++++++++++++++- src/docbkx/tutorial/social.xml | 4 ++- 11 files changed, 137 insertions(+), 17 deletions(-) delete mode 100644 src/docbkx/about-book.xml diff --git a/src/docbkx/about-book.xml b/src/docbkx/about-book.xml deleted file mode 100644 index b3ca500e2..000000000 --- a/src/docbkx/about-book.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - foo - - diff --git a/src/docbkx/index.xml b/src/docbkx/index.xml index 0fe4edb75..0f3a96b93 100644 --- a/src/docbkx/index.xml +++ b/src/docbkx/index.xml @@ -54,7 +54,10 @@ About this book - Duplex book ... + Duplex book -> Fowler bliki + + 1. Narrative / Tutorial + 2. Reference docs diff --git a/src/docbkx/tutorial/about-spring-data.xml b/src/docbkx/tutorial/about-spring-data.xml index 10c971d14..c98d83546 100644 --- a/src/docbkx/tutorial/about-spring-data.xml +++ b/src/docbkx/tutorial/about-spring-data.xml @@ -2,5 +2,9 @@ About Spring Data - foo + + * What is spring data? + * What is spring data graph? + * Why should I use it? + diff --git a/src/docbkx/tutorial/about-tutorial.xml b/src/docbkx/tutorial/about-tutorial.xml index a06352fb7..36e4fdfc1 100644 --- a/src/docbkx/tutorial/about-tutorial.xml +++ b/src/docbkx/tutorial/about-tutorial.xml @@ -2,5 +2,7 @@ About this tutorial - foo + + * What is Cineasts.net + diff --git a/src/docbkx/tutorial/annotations.xml b/src/docbkx/tutorial/annotations.xml index d14a4e17c..61ad058fb 100644 --- a/src/docbkx/tutorial/annotations.xml +++ b/src/docbkx/tutorial/annotations.xml @@ -2,5 +2,26 @@ Annotating the domain model - foo + + ... + +
+ Persistent entities + + ... + +
+
+ Indexing + + ... + +
+
+ Relationships + + ... + +
+ diff --git a/src/docbkx/tutorial/data-access.xml b/src/docbkx/tutorial/data-access.xml index 28067b4a3..b30b9e1df 100644 --- a/src/docbkx/tutorial/data-access.xml +++ b/src/docbkx/tutorial/data-access.xml @@ -1,6 +1,26 @@ - Accessing the data - foo + Accessing data + + ... + +
+ Importing data + + ... + +
+
+ Repository + + ... + +
+
+ Controllers + + ... + +
diff --git a/src/docbkx/tutorial/domain.xml b/src/docbkx/tutorial/domain.xml index f2eae9a40..e9b9699a3 100644 --- a/src/docbkx/tutorial/domain.xml +++ b/src/docbkx/tutorial/domain.xml @@ -2,5 +2,37 @@ The domain - foo + + ... + +
+ Movie + + ... + +
+
+ Role + + ... + +
+
+ Actor + + ... + +
+
+ User + + ... + +
+
+ Rating + + ... + +
diff --git a/src/docbkx/tutorial/recommendations.xml b/src/docbkx/tutorial/recommendations.xml index 46fb6698c..dd72cf4f4 100644 --- a/src/docbkx/tutorial/recommendations.xml +++ b/src/docbkx/tutorial/recommendations.xml @@ -2,5 +2,7 @@ Adding recommendations - foo + + + diff --git a/src/docbkx/tutorial/security.xml b/src/docbkx/tutorial/security.xml index 2f8da73e5..cef8f2da7 100644 --- a/src/docbkx/tutorial/security.xml +++ b/src/docbkx/tutorial/security.xml @@ -2,5 +2,7 @@ Adding security - foo + + + diff --git a/src/docbkx/tutorial/setup.xml b/src/docbkx/tutorial/setup.xml index 86ec3a4f8..f0fd0b077 100644 --- a/src/docbkx/tutorial/setup.xml +++ b/src/docbkx/tutorial/setup.xml @@ -2,5 +2,43 @@ Project setup - foo + + ... + +
+ Spring Data Graph + + ... + +
+ Maven configuration + + ... + +
+
+ Spring configuration + + ... + +
+
+
+ Spring MVC + + ... + +
+ Maven configuration + + ... + +
+
+ Spring configuration + + ... + +
+
diff --git a/src/docbkx/tutorial/social.xml b/src/docbkx/tutorial/social.xml index 12b1201ad..2ce723e61 100644 --- a/src/docbkx/tutorial/social.xml +++ b/src/docbkx/tutorial/social.xml @@ -2,5 +2,7 @@ Adding social - foo + + ... + From e8d386c99b5f9737ab7d63dbc1cc7a08df8e9a6c Mon Sep 17 00:00:00 2001 From: David Montag Date: Thu, 10 Mar 2011 23:23:08 -0800 Subject: [PATCH 3/4] Fleshed out the reference with more prelim headlines. --- src/docbkx/index.xml | 7 ++++ src/docbkx/reference/annotations.xml | 50 ++++++++++++++++++++++++++ src/docbkx/reference/aspectj-intro.xml | 8 +++++ src/docbkx/reference/neo4j-intro.xml | 8 +++++ src/docbkx/reference/neo4j-server.xml | 8 +++++ src/docbkx/reference/performance.xml | 14 ++++++++ src/docbkx/reference/spring-data.xml | 8 +++++ src/docbkx/reference/template.xml | 38 ++++++++++++++++++++ 8 files changed, 141 insertions(+) create mode 100644 src/docbkx/reference/annotations.xml create mode 100644 src/docbkx/reference/aspectj-intro.xml create mode 100644 src/docbkx/reference/neo4j-intro.xml create mode 100644 src/docbkx/reference/neo4j-server.xml create mode 100644 src/docbkx/reference/performance.xml create mode 100644 src/docbkx/reference/spring-data.xml create mode 100644 src/docbkx/reference/template.xml diff --git a/src/docbkx/index.xml b/src/docbkx/index.xml index 0f3a96b93..fd405e649 100644 --- a/src/docbkx/index.xml +++ b/src/docbkx/index.xml @@ -95,5 +95,12 @@ + + + + + + + diff --git a/src/docbkx/reference/annotations.xml b/src/docbkx/reference/annotations.xml new file mode 100644 index 000000000..4ecb461be --- /dev/null +++ b/src/docbkx/reference/annotations.xml @@ -0,0 +1,50 @@ + + + + Annotation-driven persistence + + ... + +
+ Annotations + + ... this is the most important part + +
+
+ Introduced methods + + ... + +
+
+ Finders + + ... + +
+
+ GraphDatabaseContext + + ... + +
+
+ Indexing + + ... + +
+
+ Traversal + + ... + +
+
+ EntityMapper and Path + + ... + +
+ diff --git a/src/docbkx/reference/aspectj-intro.xml b/src/docbkx/reference/aspectj-intro.xml new file mode 100644 index 000000000..475d54519 --- /dev/null +++ b/src/docbkx/reference/aspectj-intro.xml @@ -0,0 +1,8 @@ + + + + AspectJ introduction + + ... + + diff --git a/src/docbkx/reference/neo4j-intro.xml b/src/docbkx/reference/neo4j-intro.xml new file mode 100644 index 000000000..a0251f00b --- /dev/null +++ b/src/docbkx/reference/neo4j-intro.xml @@ -0,0 +1,8 @@ + + + + Neo4j introduction + + ... + + diff --git a/src/docbkx/reference/neo4j-server.xml b/src/docbkx/reference/neo4j-server.xml new file mode 100644 index 000000000..85902bef3 --- /dev/null +++ b/src/docbkx/reference/neo4j-server.xml @@ -0,0 +1,8 @@ + + + + Neo4j Server + + ... + + diff --git a/src/docbkx/reference/performance.xml b/src/docbkx/reference/performance.xml new file mode 100644 index 000000000..9c592fc9c --- /dev/null +++ b/src/docbkx/reference/performance.xml @@ -0,0 +1,14 @@ + + + + Performance considerations + + ... + +
+ When to use SDG? + + ... + +
+ diff --git a/src/docbkx/reference/spring-data.xml b/src/docbkx/reference/spring-data.xml new file mode 100644 index 000000000..d19535910 --- /dev/null +++ b/src/docbkx/reference/spring-data.xml @@ -0,0 +1,8 @@ + + + + Spring Data + + ... + + diff --git a/src/docbkx/reference/template.xml b/src/docbkx/reference/template.xml new file mode 100644 index 000000000..566b09507 --- /dev/null +++ b/src/docbkx/reference/template.xml @@ -0,0 +1,38 @@ + + + + Neo4jTemplate + + ... + +
+ Transaction handling/management + + ... + +
+
+ Basic operations + + ... + +
+
+ Indexing + + ... + +
+
+ Traversal + + ... + +
+
+ PathMapper + + ... path as general return type? + +
+ From 90e54119da51d17dcfabd41c83871912277754a6 Mon Sep 17 00:00:00 2001 From: Michael Hunger Date: Mon, 14 Mar 2011 10:48:05 +0100 Subject: [PATCH 4/4] jai-core dependency fixed --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index ffcb0339f..1bb6e3e97 100644 --- a/pom.xml +++ b/pom.xml @@ -172,7 +172,7 @@ javax.media - jai-core + jai_core 1.1.3 runtime