jupysketch-doc/docs/yamlsketcher.md

@@ -7,14 +7,28 @@ Content
 
 ## YAML sketcher file grammar
 
-This is the wireframe grammar:
+Sketcher file EBNF Grammar is
+
+```EBNF
+Sketch::= Sketch_Name Parts
+Sketch_Name::= "-" " " "name: " Identifier Comment? "\n"
+Parts::= "-" " " "parts:\n" Comment? Part+
+Part::= Part_Name Shapes
+Part_Name::= INDENT "-" " " "name: " Identifier Comment? "\n" DEDENT
+Shapes::= INDENT " " " " "shapes:\n" Comment? Shape+ DEDENT
+Shape::= Simple | DoAction | SketchObject
+Simple::= INDENT Identifier ":" PyRightHandExpression Comment? "\n" DEDENT
+DoAction::= INDENT Identifier ":" Comment? "\n" Action DEDENT
+Action::= INDENT "action:" PyExpression Comment? "\n" DEDENT 
+Identifier::= [A-Za-z][_A-Za-z0-9]+
+Comment::= "#" STRING
+```
+
+Here is the railroad grammar diagram:
 
-* starts with S
-* each time you see two "embedded" rectangles, this is the text to write
-* follow the arrows and iterate as needed
-* end with E
+[Yaml Sketcher railroad diagram](resources/yamlpysketchergrammar.xhtml)
 
-![Yaml Sketcher Definition](reference/yamlpysketchergrammar.svg)
+<small><a href="https://bottlecaps.de/rr/ui"target="_blank">[Built thanks]</a></small>
 
 ## Libraries, Pysketcher Object creation, Styles, Transform
 

jupysketch-doc/site/yamlsketcher/index.html

@@ -433,14 +433,24 @@
 <li><a href="#code-to-read-or-write-a-yaml-sketcher-file">Code to read or write a yaml sketcher file</a></li>
 </ul>
 <h2 id="yaml-sketcher-file-grammar">YAML sketcher file grammar</h2>
-<p>This is the wireframe grammar:</p>
-<ul>
-<li>starts with S</li>
-<li>each time you see two "embedded" rectangles, this is the text to write</li>
-<li>follow the arrows and iterate as needed</li>
-<li>end with E</li>
-</ul>
-<p><img alt="Yaml Sketcher Definition" src="../reference/yamlpysketchergrammar.svg" /></p>
+<p>Sketcher file EBNF Grammar is</p>
+<pre><code class="EBNF">Sketch::= Sketch_Name Parts
+Sketch_Name::= &quot;-&quot; &quot; &quot; &quot;name: &quot; Identifier Comment? &quot;\n&quot;
+Parts::= &quot;-&quot; &quot; &quot; &quot;parts:\n&quot; Comment? Part+
+Part::= Part_Name Shapes
+Part_Name::= INDENT &quot;-&quot; &quot; &quot; &quot;name: &quot; Identifier Comment? &quot;\n&quot; DEDENT
+Shapes::= INDENT &quot; &quot; &quot; &quot; &quot;shapes:\n&quot; Comment? Shape+ DEDENT
+Shape::= Simple | DoAction | SketchObject
+Simple::= INDENT Identifier &quot;:&quot; PyRightHandExpression Comment? &quot;\n&quot; DEDENT
+DoAction::= INDENT Identifier &quot;:&quot; Comment? &quot;\n&quot; Action DEDENT
+Action::= INDENT &quot;action:&quot; PyExpression Comment? &quot;\n&quot; DEDENT 
+Identifier::= [A-Za-z][_A-Za-z0-9]+
+Comment::= &quot;#&quot; STRING
+</code></pre>
+
+<p>Here is the railroad grammar diagram:</p>
+<p><a href="../resources/yamlpysketchergrammar.xhtml">Yaml Sketcher railroad diagram</a></p>
+<p><small><a href="https://bottlecaps.de/rr/ui"target="_blank">[Built thanks]</a></small></p>
 <h2 id="libraries-pysketcher-object-creation-styles-transform">Libraries, Pysketcher Object creation, Styles, Transform</h2>
 <h3 id="libraries">Libraries</h3>
 <p>The libraries token defined in the grammar is</p>