Merge branch 'master' of https://github.com/jingtaozf/s-graphviz

Author: jingtaozf

README.org

@@ -1,5 +1,5 @@
 # -*- Mode: POLY-ORG ;-*- ---
-#+Title: a S-expression presentation of GraphViz DOT language
+#+Title: an S-expression presentation of GraphViz DOT language
 #+OPTIONS: tex:t toc:2 \n:nil @:t ::t |:t ^:nil -:t f:t *:t <:t
 #+STARTUP: latexpreview
 #+STARTUP: noindent
@@ -19,9 +19,9 @@
   - [[#add-compass-point-value-in-a-node-id][add compass point value in a node id]]
 
 * Introduction
-This is a S-expression presentation of [[http://www.graphviz.org/][AT&T GraphViz]].
+This is an S-expression presentation of [[http://www.graphviz.org/][AT&T GraphViz]].
 The original idea is from http://www.martin-loetzsch.de/S-DOT, but with a full compatiblity of original
-DOT syntax by following its [[https://www.graphviz.org/doc/info/lang.html][lang definition]].
+DOT syntax by following its [[https://www.graphviz.org/doc/info/lang.html][language definition]].
 
 * The S-Graphviz Language
 We have a similar presentation with the original [[https://graphviz.gitlab.io/_pages/doc/info/lang.html][DOT Language]], but in a single list.
@@ -40,14 +40,14 @@ We have a similar presentation with the original [[https://graphviz.gitlab.io/_p
   |---------------+------------------------------------+-----------------------------------------+--------------------------------------------|
   | first element | statement type                     | syntax                                  | Example                                    |
   |---------------+------------------------------------+-----------------------------------------+--------------------------------------------|
-  | =             | a assignment of a single attribute | (= key value)                           | (= :rank :same)                            |
+  | =             | an assignment of a single attribute | (= key value)                           | (= :rank :same)                            |
   | :->           | a directed edge                    | (:-> attribute-list node1 node2 ...)    | (:-> ((:arrowsize 2)) a b c)               |
-  | :--           | a undirected edge                  | (:-- attribute-list node1 node2 ...)    | (:-- ((:arrowsize 2)) a b c)               |
+  | :--           | an undirected edge                 | (:-- attribute-list node1 node2 ...)    | (:-- ((:arrowsize 2)) a b c)               |
   | :graph        | attributes for a graph             | (:graph . attribute-list)               | (:graph (:shape :circle) (:style :filled)) |
   | :node         | attributes for a node              | (:node . attribute-list)                | (:node (:shape :circle) (:style :filled))  |
-  | :edge         | attributes for a edge              | (:edge . attribute-list)                | (:edge (:shape :circle) (:style :filled))  |
+  | :edge         | attributes for an edge             | (:edge . attribute-list)                | (:edge (:shape :circle) (:style :filled))  |
   | :{}           | a new statement list               | (:{} . graph-statement-list)            | (:{} (= :rank :same) (b) (d))              |
-  | :subgraph     | a subgraph                         | (:subgraph ID . subgraph-statement-list | (:subgraph cluster_1 (:-> () node1 node2)) |
+  | :subgraph     | a sub graph                        | (:subgraph ID . subgraph-statement-list | (:subgraph cluster_1 (:-> () node1 node2)) |
   | other atom    | a node statement                   | (node-id . attribute-list)              | (node1 (:label "nice node") (:shape :box)) |
   |---------------+------------------------------------+-----------------------------------------+--------------------------------------------|
 
@@ -59,10 +59,10 @@ generated DOT file.
 This library created a new package named as ~:dot~, and it exports the following functions to
 convert the S-Graphviz expression to a file can be read as the DOT Language.
 ** format-graph
-This function accepts a S-expression and a keyword ~:stream~.
+This function accepts an S-expression and a keyword ~:stream~.
 - The S-expression has the syntax of the S-Graphviz Language.
 - The stream is nil by default which means it will return a string which can be read as the DOT Language.
-  if the stream is not nil, then the target string will be written into this stream directly.
+  If the stream is not nil, then the target string will be written into this stream directly.
 
   For example, the following lisp expression
 #+BEGIN_SRC lisp :load no
@@ -80,14 +80,14 @@ digraph {
 }
 #+end_src
 ** render-graph
-This function is used to render a S-Graphviz expression to a image type,it accepts the following arguments.
-- a ~file-name~ for the target image,it can be a string or a pathname.
-- a ~S-expression~ for the graph
+This function is used to render an S-Graphviz expression to an image type, it accepts the following arguments.
+- a ~file-name~ for the target image, it can be a string or a path name.
+- an ~S-expression~ for the graph
 - a keyword ~format~ to indicate the image type, it is the file type of ~file-name~ by default.
 - a keyword ~dot-exe~ for the target dot application, it is ~dot~ by default.
 - a keyword ~dot-arguments~ for the additional dot arguments, it is null by default.
 
-For example to render a S-Graphviz expression to a image file, we can run the following lisp expression.
+For example to render an S-Graphviz expression to an image file, we can run the following lisp expression.
 #+BEGIN_SRC lisp :load no
 (graphviz:render-graph "/tmp/test1.png"
                   '(:digraph ()

s-graphviz.org

@@ -1,5 +1,5 @@
 # -*- Mode: POLY-ORG ;-*- ---
-#+Title: a S-expression presentation of GraphViz DOT language
+#+Title: an S-expression presentation of GraphViz DOT language
 #+OPTIONS: tex:t toc:2 \n:nil @:t ::t |:t ^:nil -:t f:t *:t <:t
 #+STARTUP: latexpreview
 #+STARTUP: noindent
@@ -11,10 +11,10 @@
 - [[#preparation][Preparation]]
 - [[#language-presentation][Language presentation]]
   - [[#global-variables][global variables]]
-    - [[#the-encode-stream][the encode stream]]
+    - [[#the-encoded-stream][the encoded stream]]
     - [[#the-indent-level][the indent level]]
     - [[#the-default-size-for-indent-tab][the default size for indent tab]]
-  - [[#how-to-render-a-s-graphviz-s-expression][how to render a S-GRAPHVIZ S-expression]]
+  - [[#how-to-render-an-s-graphviz-s-expression][how to render an S-GRAPHVIZ S-expression]]
   - [[#graph][graph]]
   - [[#stmt-list][stmt-list]]
   - [[#stmt][stmt]]
@@ -68,24 +68,24 @@ subgraph	:	[ subgraph [ ID ] ] '{' stmt_list '}'
 compass_pt	:	(n | ne | e | se | s | sw | w | nw | c | _)
 #+end_src
 ** global variables
-*** the encode stream
+*** the encoded stream
 The encoded DOT expressions will print to this stream.
 #+BEGIN_SRC lisp
 (defvar *dot-stream*)
 #+END_SRC
 *** the indent level
-How many whitespaces will be written before printing current DOT expression.
+How many white spaces will be written before printing current DOT expression.
 #+BEGIN_SRC lisp
 (defvar *indent-spaces* 0)
 #+END_SRC
 *** the default size for indent tab
 #+BEGIN_SRC lisp
 (defvar *indent-tab-size* 2)
 #+END_SRC
-** how to render a S-GRAPHVIZ S-expression
+** how to render an S-GRAPHVIZ S-expression
 Renders a s-graphviz graph into a graphic file.
-~file-name~ should be a pathname.
-If the file-name is ~/foo/bar.png~ , the DOT file ~/foo/bar.dot~ is created
+~file-name~ should be a path name.
+If the file-name is ~/foo/bar.png~, the DOT file ~/foo/bar.dot~ is created
 and then rendered.
 Format should be one out of http://www.graphviz.org/doc/info/output.html,
 for example svg,  ps, gif, png, or jpg.
@@ -107,7 +107,7 @@ for example svg,  ps, gif, png, or jpg.
                       :ignore-error-status t)))
 #+END_SRC
 
-We will provide a helpful routine to render a S-GRAPHVIZ S-expression and open it in Emacs.
+We will provide a helpful routine to render an S-GRAPHVIZ S-expression and open it in Emacs.
 #+BEGIN_SRC lisp :load dev
 (defmacro render-and-open-s-graphviz (file-name &rest left-args)
   (let ((real-file-name (gensym "file-name")))
@@ -156,7 +156,7 @@ We will provide a helpful routine to render a S-GRAPHVIZ S-expression and open i
 
 ** stmt-list
 a graph is established by a stmt_list.
-We can also apply some global configuration in a ~stmt_list~ to limit their affection scope,for example:
+We can also apply some global configuration in a ~stmt_list~ to limit their affection scope, for example:
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
  (merge-pathnames
@@ -193,7 +193,7 @@ We can also apply some global configuration in a ~stmt_list~ to limit their affe
 #+END_SRC
 
 ** stmt
-There are many different kinds of statements,let's recognize them one by one.
+There are many kinds of statements, let's recognize them one by one.
 
 #+BEGIN_SRC lisp
 (defun format-stmt (stmt)
@@ -208,7 +208,7 @@ There are many different kinds of statements,let's recognize them one by one.
 
 ** node statement
 
-If a statement starts without a known keyword, then it's a node statement,for example
+If a statement starts without a known keyword, then it's a node statement, for example
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
  (merge-pathnames
@@ -230,7 +230,7 @@ If a statement starts without a known keyword, then it's a node statement,for ex
 #+begin_src bnf
 node_id	:	ID [ port ]
 #+end_src
-In a S-expression, it can be a single id or a list contains both id and port.
+In an S-expression, it can be a single id or a list contains both id and port.
 #+BEGIN_SRC lisp
 (defun format-node-id (id-port)
   (if (atom id-port)
@@ -246,7 +246,7 @@ In a S-expression, it can be a single id or a list contains both id and port.
 edge_stmt	:	(node_id | subgraph) edgeRHS [ attr_list ]
 edgeRHS	:	edgeop (node_id | subgraph) [ edgeRHS ]
 #+end_src
-In a S-expression, it's a list that starts with an ~edgeop~ and an ~attr_list~ and
+In an S-expression, it's a list that starts with an ~edgeop~ and an ~attr_list~ and
 the rest are a list of ~node id~, for example
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
@@ -282,7 +282,7 @@ the rest are a list of ~node id~, for example
 #+begin_src bnf
 attr_stmt	:	(graph | node | edge) attr_list
 #+end_src
-In a S-GRAPHVIZ S-expression, it starts with keyword ~:graph~, ~:node~, ~:edge~ , and the rest items
+In an S-GRAPHVIZ S-expression, it starts with keyword ~:graph~, ~:node~, ~:edge~ , and the rest items
 in the list is the ~attr_list~(ref:attr-list),for example:
 #+begin_src lisp :load no
 (render-and-open-s-graphviz
@@ -307,7 +307,7 @@ in the list is the ~attr_list~(ref:attr-list),for example:
 #+END_SRC
 ** attribute
 a single attribute can be applied to global environment in a statement,
-in a S-GRAPHVIZ S-expression, it looks like this:
+in an S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
  (merge-pathnames
@@ -329,7 +329,7 @@ in a S-GRAPHVIZ S-expression, it looks like this:
 #+END_SRC
 ** subgraph
 It a subgraph's name starts with "cluster", then it has a special meaning.
-in a S-GRAPHVIZ S-expression, it looks like this:
+in an S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
  (merge-pathnames
@@ -375,7 +375,7 @@ port	:	':' ID [ ':' compass_pt ]
        |	':' compass_pt
 compass_pt	:	(n | ne | e | se | s | sw | w | nw | c | _)
 #+end_src
-In a S-GRAPHVIZ S-expression, it looks like this:
+In an S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
 (render-and-open-s-graphviz
  (merge-pathnames
@@ -405,7 +405,7 @@ label:attr-list
 attr_list	:	'[' [ a_list ] ']' [ attr_list ]
 a_list	:	ID '=' ID [ (';' | ',') ] [ a_list ]
 #+end_src
-In a S-expression, it is an association list like this:
+In an S-expression, it is an association list like this:
 #+BEGIN_SRC lisp :load no
 ((:label "a label") (:shape :box))
 #+END_SRC