diff --git a/src/docbkx/index.xml b/src/docbkx/index.xml index ee9c34967..439468353 100644 --- a/src/docbkx/index.xml +++ b/src/docbkx/index.xml @@ -2,93 +2,11 @@ - - Good Relationships - The Spring Data Graph Guidebook - &version; - - - - Michael - Hunger - - - David - Montag - - - Mark - Pollack - - - Thomas - Risberg - - - - - - - - - - - - - Copies of this document may be made for your own use and for distribution - to others, provided that you do not charge any fee for such copies and - further provided that each copy contains this Copyright Notice, whether - distributed in print or electronically. - - - + - - - - About this Guide Book - - Welcome to the Spring Data Graph Guide Book. Thank you for taking the time to get an in depth look into the - usage and workings of the Spring Data Graph Library. Spring Data Graph is part of the Spring Data project which - aims to provide the convenient programming model of the Spring Framework to the big field modern datastores - (mostly NoSQL). Spring Data Graph in particular currently provides integration for the Neo4j Graph Database. - - It was written by developers for developers. So hopefully we created a documentation that is well received by - our peers. - - If you have any feedback to the Spring Data Graph Library or this book, please provide it via SpringSource JIRA, - the SpringSource NoSQL Forum, github comments or issues or the Neo4j mailing list. - - This book is presented as a duplex book, a term coined by Martin Fowler. A duplex book consists of at least two - parts. The first part is an easily accessible narrative, that gives the reader an overview of the topics contained - in the book. It contains lots of examples and more general discussion topics. This should be the only part of - the book that is required to be read cover-to-cover. - - We chose a tutorial describing the creation of a web applicaton (cineasts.net) that allows movie enthusiasts to - find the favorites, rate them, connect with each other and enjoy social features. The application is running on - Neo4j using Spring Data Graph and the well known Spring Web Stack. - - The second part is the classic reference documentation containing the detailed information about the library. - It discusses the programming model, the underlying assumptions, used toolset (like aspectj) as well as the APIs - for the object-graph mapping and the template approach. The reference docs should be mainly used to look up - concrete bits of information or to dig deeper into certain topics. - - + Tutorial diff --git a/src/docbkx/introduction/bookinfo.xml b/src/docbkx/introduction/bookinfo.xml new file mode 100644 index 000000000..08ad0c4dd --- /dev/null +++ b/src/docbkx/introduction/bookinfo.xml @@ -0,0 +1,41 @@ + + + + + Good Relationships + The Spring Data Graph Guidebook + &version; + + + + + Michael + Hunger + + + David + Montag + + + Mark + Pollack + + + Thomas + Risberg + + + + + + + + Copies of this document may be made for your own use and for distribution + to others, provided that you do not charge any fee for such copies and + further provided that each copy contains this Copyright Notice, whether + distributed in print or electronically. + + + + diff --git a/src/docbkx/introduction/get-started.xml b/src/docbkx/introduction/get-started.xml index 9d077e489..5d7f430c2 100644 --- a/src/docbkx/introduction/get-started.xml +++ b/src/docbkx/introduction/get-started.xml @@ -1,5 +1,5 @@ - Getting Started diff --git a/src/docbkx/introduction/introduction.xml b/src/docbkx/introduction/introduction.xml index 993c602a5..b08608af8 100644 --- a/src/docbkx/introduction/introduction.xml +++ b/src/docbkx/introduction/introduction.xml @@ -1,5 +1,5 @@ - diff --git a/src/docbkx/introduction/preface.xml b/src/docbkx/introduction/preface.xml new file mode 100644 index 000000000..77b483dd9 --- /dev/null +++ b/src/docbkx/introduction/preface.xml @@ -0,0 +1,49 @@ + + + + + + + + About this Guide Book + + Welcome to the Spring Data Graph Guide Book. Thank you for taking the time to get an in depth look into the + usage and workings of the Spring Data Graph Library. Spring Data Graph is part of the Spring Data project which + aims to provide the convenient programming model of the Spring Framework to the big field modern datastores + (mostly NoSQL). Spring Data Graph in particular currently provides integration for the Neo4j Graph Database. + + It was written by developers for developers. So hopefully we created a documentation that is well received by + our peers. + + If you have any feedback to the Spring Data Graph Library or this book, please provide it via SpringSource JIRA, + the SpringSource NoSQL Forum, github comments or issues or the Neo4j mailing list. + + This book is presented as a duplex book, a term coined by Martin Fowler. A duplex book consists of at least two + parts. The first part is an easily accessible narrative, that gives the reader an overview of the topics contained + in the book. It contains lots of examples and more general discussion topics. This should be the only part of + the book that is required to be read cover-to-cover. + + We chose a tutorial describing the creation of a web applicaton (cineasts.net) that allows movie enthusiasts to + find the favorites, rate them, connect with each other and enjoy social features. The application is running on + Neo4j using Spring Data Graph and the well known Spring Web Stack. + + The second part is the classic reference documentation containing the detailed information about the library. + It discusses the programming model, the underlying assumptions, used toolset (like aspectj) as well as the APIs + for the object-graph mapping and the template approach. The reference docs should be mainly used to look up + concrete bits of information or to dig deeper into certain topics. + + diff --git a/src/docbkx/introduction/requirements.xml b/src/docbkx/introduction/requirements.xml index 8db5706ff..267835e9a 100644 --- a/src/docbkx/introduction/requirements.xml +++ b/src/docbkx/introduction/requirements.xml @@ -1,3 +1,6 @@ + + Requirements diff --git a/src/docbkx/resources/images/springdatagraph.png b/src/docbkx/introduction/springdatagraph.png similarity index 100% rename from src/docbkx/resources/images/springdatagraph.png rename to src/docbkx/introduction/springdatagraph.png diff --git a/src/docbkx/introduction/why-sd-graph.xml b/src/docbkx/introduction/why-sd-graph.xml index 83121e473..ea5573d50 100644 --- a/src/docbkx/introduction/why-sd-graph.xml +++ b/src/docbkx/introduction/why-sd-graph.xml @@ -1,5 +1,5 @@ - Why Spring Data Graph? diff --git a/src/docbkx/reference/annotations.xml b/src/docbkx/reference/annotations.xml index 4ecb461be..4eb3e85b6 100644 --- a/src/docbkx/reference/annotations.xml +++ b/src/docbkx/reference/annotations.xml @@ -1,6 +1,6 @@ - + Annotation-driven persistence ... diff --git a/src/docbkx/reference/aspectj-intro.xml b/src/docbkx/reference/aspectj-intro.xml index 475d54519..c4d689ca5 100644 --- a/src/docbkx/reference/aspectj-intro.xml +++ b/src/docbkx/reference/aspectj-intro.xml @@ -1,6 +1,6 @@ - + AspectJ introduction ... diff --git a/src/docbkx/resources/images/helloworlds.png b/src/docbkx/reference/helloworlds.png similarity index 100% rename from src/docbkx/resources/images/helloworlds.png rename to src/docbkx/reference/helloworlds.png diff --git a/src/docbkx/resources/images/imdb.png b/src/docbkx/reference/imdb.png similarity index 100% rename from src/docbkx/resources/images/imdb.png rename to src/docbkx/reference/imdb.png diff --git a/src/docbkx/reference/neo4j-intro.xml b/src/docbkx/reference/neo4j-intro.xml index a0251f00b..255de0dd9 100644 --- a/src/docbkx/reference/neo4j-intro.xml +++ b/src/docbkx/reference/neo4j-intro.xml @@ -1,6 +1,6 @@ - + Neo4j introduction ... diff --git a/src/docbkx/reference/neo4j-server.xml b/src/docbkx/reference/neo4j-server.xml index 85902bef3..7eeffa06d 100644 --- a/src/docbkx/reference/neo4j-server.xml +++ b/src/docbkx/reference/neo4j-server.xml @@ -1,6 +1,6 @@ - + Neo4j Server ... diff --git a/src/docbkx/reference/performance.xml b/src/docbkx/reference/performance.xml index 9c592fc9c..e1832cfd9 100644 --- a/src/docbkx/reference/performance.xml +++ b/src/docbkx/reference/performance.xml @@ -1,6 +1,6 @@ - + Performance considerations ... diff --git a/src/docbkx/reference/programming-model/indexing.xml b/src/docbkx/reference/programming-model/indexing.xml index 826c02288..4b47b962c 100644 --- a/src/docbkx/reference/programming-model/indexing.xml +++ b/src/docbkx/reference/programming-model/indexing.xml @@ -1,6 +1,6 @@ -
+
Indexing The Neo4j graph database can use different index providers for exact lookups and fulltext searches. Lucene is diff --git a/src/docbkx/reference/programming-model/neo4jtemplate.xml b/src/docbkx/reference/programming-model/neo4jtemplate.xml index 7dde28a54..5684ecd20 100644 --- a/src/docbkx/reference/programming-model/neo4jtemplate.xml +++ b/src/docbkx/reference/programming-model/neo4jtemplate.xml @@ -1,6 +1,6 @@ -
+
Neo4jTemplate The Neo4jTemplate offers the convenient API of Spring templates for the Neo4j graph database. diff --git a/src/docbkx/reference/samples.xml b/src/docbkx/reference/samples.xml index 6e656c767..68717b6d4 100644 --- a/src/docbkx/reference/samples.xml +++ b/src/docbkx/reference/samples.xml @@ -4,7 +4,7 @@ Samples -
+
Introduction Spring Data Graph comes with a number of samples. @@ -14,7 +14,7 @@
-
+
Hello Worlds sample The Hello Worlds sample application is a simple console application with unit tests, that creates some Worlds (entities / nodes) and Rocket Routes (relationships) in a Galaxy (graph) @@ -29,7 +29,7 @@
-
+
IMDB sample A web application that imports datasets from the Internet Movie Database (IMDB) into the @@ -53,7 +53,7 @@
- 1 + 1