Skip to content

Commit 939b6a0

Browse files
committed
Punctuation, spelling, grammar, consistency
1 parent 6f32902 commit 939b6a0

16 files changed

+2114
-2134
lines changed

book/Practical-Gremlin.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,4 @@ include::Section-Introducing-Gremlin-Server.adoc[]
5656

5757
include::Section-Common-Serialization-Formats.adoc[]
5858

59-
include::Section-Further-Reading.adoc[]
60-
61-
// vim: set tw=85 cc=+1 wrap spell redrawtime=20000:
59+
include::Section-Further-Reading.adoc[]

book/README.md

Lines changed: 55 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,60 @@
11
![map](https://github.com/krlawrence/graph/raw/main/images/PRACTICAL-GREMLIN-2nd-edition.png?raw=true, "Book cover art")
22

33
## About the files in this folder
4-
This folder contains the AsciiDoc source files used to produce the HTML, XML (DOCBOOK), EPUB, MOBI and PDF output.
54

6-
The `Practical-Gremlin.adoc` file contains links to the different sections of the book. The names of the other AsciiDoc format files follow the naming convention : __*Section-\*.adoc*__. You can browse `Practical-Gremlin.adoc` and the various 'Section-\*.adoc' files directly from within GitHub, but you will not get the full color coding, chapter numbering, and other niceties that are present in the HTML and PDF versions; as they have been run through an AsciiDoc processor and had various style sheets and code pretty printers applied. Your mileage may vary, but I find the HTML and PDF versions to be the most pleasing to read. The PDF version includes page numbers, the HTML version is one continuous document.
5+
This folder contains the AsciiDoc source files used to produce the HTML, XML
6+
(DOCBOOK), EPUB, MOBI, and PDF output.
77

8-
The '.adoc' files in this folder represent the most recent updates and may not have been published elsewhere yet, even in preview form. The other formats (HTML,DocBook,PDF, ePub and MOBI) will be generated once there are enough updates to make it worthwhile creating a full release.
8+
The `Practical-Gremlin.adoc` file contains links to the different sections of the
9+
book. The names of the other AsciiDoc format files follow the naming convention:
10+
__*Section-\*.adoc*__. You can browse `Practical-Gremlin.adoc` and the various
11+
'Section-\*.adoc' files directly from within GitHub, but you will not get the full
12+
color coding, chapter numbering, and other niceties that are present in the HTML and
13+
PDF versions; as they have been run through an AsciiDoc processor and had various
14+
style sheets and code pretty printers applied. Your mileage may vary, but I find the
15+
HTML and PDF versions to be the most pleasing to read. The PDF version includes page
16+
numbers, the HTML version is one continuous document.
17+
18+
The '.adoc' files in this folder represent the most recent updates and may not have
19+
been published elsewhere yet, even in preview form. The other formats (HTML, DocBook,
20+
PDF, ePub, and MOBI) will be generated once there are enough updates to make it
21+
worthwhile creating a full release.
922

1023
## Building the book
11-
If you want to build the output format files yourself they can be generated by running the `make-book.sh` script. The script assumes you have Asciidoctor installed (which is a Ruby Gem) as well as Pygments.rb (another Ruby Gem). The tools can be installed using various package managers and are available on most, commonly used, desktop operating system platforms.
1224

13-
To do the conversion to MOBI and EPUB the script assumes that Calibre and Pandoc are installed. I have successfully built the book on several Linux distros including Ubuntu, CentOS and Red Hat. I have successfully used Asciidoctor on Mac OS as well, but I always use Linux to produce the EPUB abd MOBI versions.
25+
If you want to build the output format files yourself, they can be generated by
26+
running the `make-book.sh` script. The script assumes you have Asciidoctor installed
27+
(which is a Ruby Gem) as well as Pygments.rb (another Ruby Gem). The tools can be
28+
installed using various package managers and are available on most, commonly used,
29+
desktop operating system platforms.
30+
31+
To do the conversion to MOBI and EPUB, the script assumes that Calibre and Pandoc are
32+
installed. I have successfully built the book on several Linux distros, including
33+
Ubuntu, CentOS, and Red Hat. I have successfully used Asciidoctor on macOS as well,
34+
but I always use Linux to produce the EPUB and MOBI versions.
1435

1536
### Building the HTML version
16-
```
37+
38+
```shell
1739
asciidoctor Practical-Gremlin.adoc
1840
```
1941

2042
### Building the PDF version
21-
```
43+
44+
```shell
2245
asciidoctor-pdf Practical-Gremlin.adoc
2346
```
2447

2548
### Building additional versions
26-
The XML (DOCBOOK) file is generated using Asciidoctor and can be viewed on Linux using the Yelp tool among many others or used to produce other formats. The EPUB and MOBI files can be viewed using most popular e-book readers and some browsers.
2749

28-
Please note that the DOCBOOK, EPUB and MOBI format files currently do not have all of the nice source code highlighting and colors that the HTML and PDF versions have.
50+
The XML (DOCBOOK) file is generated using Asciidoctor and can be viewed on Linux
51+
using the Yelp tool among many others or used to produce other formats. The EPUB and
52+
MOBI files can be viewed using most popular e-book readers and some browsers.
2953

30-
```
54+
Please note that the DOCBOOK, EPUB, and MOBI format files currently do not have all
55+
the nice source code highlighting and colors that the HTML and PDF versions have.
56+
57+
```shell
3158
# Docbook / XML
3259
asciidoctor -n -b docbook -d book Practical-Gremlin.adoc -o krltemp.xml
3360
sed -e s/language=\"groovy\"/language=\"java\"/ krltemp.xml > Practical-Gremlin.xml
@@ -38,50 +65,49 @@ pandoc -f docbook -t epub -N --number-sections --top-level-division=chapter --to
3865

3966
# MOBI
4067
ebook-convert Practical-Gremlin.epub Practical-Gremlin.mobi
41-
4268
```
4369

4470
## Preview releases
4571

4672
Preview versions of the book in HTML are automatically published [here](https://krlawrence.github.io/graph/) as changes arrive to the `main` branch of the repository.
4773

4874
## How the book is organized
49-
This is the current layout of the second edition. As work progresses additional chapters
50-
may be added and the layout further refined.
5175

52-
**Chapter 1 - INTRODUCTION**
76+
This is the current layout of the second edition. As work progresses, additional
77+
chapters may be added and the layout further refined.
78+
79+
**Chapter 1 – INTRODUCTION**
5380
- We start our journey with a brief introduction to Apache Tinkerpop and a quick look
5481
at why Graph databases are of interest to us. We also discuss how the book is
55-
organized and where to find additional materials; such as sample code and data
82+
organized and where to find additional materials, such as sample code and data
5683
sets.
5784

58-
**Chapter 2 - GETTING STARTED**
85+
**Chapter 2 GETTING STARTED**
5986
- Many of the examples throughout the book use the Gremlin Console and TinkerGraph,
6087
and both are introduced in this chapter. We also introduce the air-routes example
61-
graph - `air-routes.graphml` - used throughout the book.
88+
graph - `air-routes.graphml` - used throughout the book.
6289

6390
**Chapter 3 - WRITING GREMLIN QUERIES**
6491
- Now that the basics have been covered, things start to get a lot more interesting!
65-
It's time to start writing Gremlin queries. We
66-
briefly explore how we could have built the 'air-routes' graph using a
67-
relational database, and then look at how SQL and Gremlin are both similar in some
68-
way,s and very different in others. We then introduce several of the key Gremlin
69-
query language '"steps"'. We focus on exploring the graph rather than changing it
70-
in this chapter.
92+
It's time to start writing Gremlin queries. We briefly explore how we could have
93+
built the 'air-routes' graph using a relational database, and then look at how SQL
94+
and Gremlin are both similar in some ways and very different in others. We then
95+
introduce several of the key Gremlin query language '"steps"'. We focus on
96+
exploring the graph rather than changing it in this chapter.
7197

7298
**Chapter 4 - BEYOND BASIC QUERIES**
7399
- Having now introduced Gremlin in some detail, we introduce the Gremlin steps that
74-
can be used to create, modify and delete, data. We present a selection of best
100+
can be used to create, modify, and delete, data. We present a selection of best
75101
practices and start to explore some more advanced query writing.
76102

77-
**Chapter 5 - MISCELLANEOUS QUERIES AND THE RESULTS THEY GENERATE**
103+
**Chapter 5 MISCELLANEOUS QUERIES AND THE RESULTS THEY GENERATE**
78104
- Using the Gremlin steps introduced in Chapters 3 and 4, we are now ready to use
79105
what we have learned so far and write queries that analyze the air-routes graph in
80106
more depth and answer more complicated questions. The material presented includes
81107
a discussion of analyzing distances, route distribution, and writing geospatial
82108
queries.
83109

84-
**Chapter 6 - MOVING BEYOND THE GREMLIN CONSOLE**
110+
**Chapter 6 MOVING BEYOND THE GREMLIN CONSOLE**
85111
- The next step in our journey is to move beyond the Gremlin console and take a look
86112
at interacting with a TinkerGraph using Java and Groovy applications.
87113

@@ -91,15 +117,15 @@ may be added and the layout further refined.
91117
remotely hosted graphs.
92118

93119
**Chapter 8 - COMMON GRAPH SERIALIZATION FORMATS**
94-
- Having introduced Gremlin Server we take a look at some common Graph serialization
120+
- Having introduced Gremlin Server, we take a look at some common Graph serialization
95121
file formats along with coverage of how to use them in the context of TinkerPop
96122
enabled graphs. We take a close look at the TinkerPop GraphSON (JSON) format which
97123
is used extensively when using Gremlin queries in conjunction with a Gremlin
98124
Server.
99125

100-
**Chapter 9 - FURTHER READING**
126+
**Chapter 9 FURTHER READING**
101127
- Our journey to explore Apache TinkerPop and Gremlin concludes with a look at
102-
useful sources of further reading. We present l links to useful web sites where you
128+
useful sources of further reading. We present l links to useful websites where you
103129
can find tools and documentation for many of the topics and technologies covered in
104130
this book.
105131

0 commit comments

Comments
 (0)