From 7f19e50403cd0d7453dca2ee435b6cb4fce5c19c Mon Sep 17 00:00:00 2001
From: Nikolay Rozhkov <nironame@gmail.com>
Date: Sun, 18 Jun 2023 01:32:45 +0300
Subject: [PATCH] Desired sankey syntax

---
 .../{desired syntax => desired_syntax.md}     | 51 ++++++++++++++++---
 1 file changed, 44 insertions(+), 7 deletions(-)
 rename packages/mermaid/src/sankey/parser/{desired syntax => desired_syntax.md} (52%)

diff --git a/packages/mermaid/src/sankey/parser/desired syntax b/packages/mermaid/src/sankey/parser/desired_syntax.md
similarity index 52%
rename from packages/mermaid/src/sankey/parser/desired syntax
rename to packages/mermaid/src/sankey/parser/desired_syntax.md
index b2b998748..61543c266 100644
--- a/packages/mermaid/src/sankey/parser/desired syntax	
+++ b/packages/mermaid/src/sankey/parser/desired_syntax.md
@@ -1,6 +1,9 @@
-This is example of data for Sakey diagrams from d3 author:
-circular graph not supported
+# Sankey diagrams syntax proposal
 
+Circular graphs are not supported by d3. There are some alternatives for that.
+This is example of data for Sakey diagrams from d3 author (simple csv):
+
+```csv
 Berlin,Job Applications,102
 Barcelona,Job Applications,39
 Madrid,Job Applications,35
@@ -19,19 +22,53 @@ Responded,Interviewed,11,orange
 Interviewed,No Offer,8
 Interviewed,Declined Offer,2
 Interviewed,Accepted Offer,1,orange
+```
 
-Attributes for
+We also need graph and node attributes like this:
 
+```
 .nodeSort(null)
 .linkSort(null)
 .nodeWidth(4)
 .nodePadding(20)
 .extent([[0, 5], [width, height - 5]]) // margin?
+```
 
-berlin [label="asdf" color="red"] #node
+Also needed:
+* coloring strategy (source, target, transition)
+* graph alignment (left, right, width)
+
+Proposed syntax:
+```
+a -> 30 -> b
+a -> 40 -> c
+
+a -> {
+    30 -> b
+    40 -> c
+}
+
+{
+    a -> 30
+    b -> 40
+} -> c
 
 
-Berlin,Job,
-JobApplications[label="Job Applications"]
+a -> {
+    30
+    40
+} -> b
 
-madrid=35 ->
\ No newline at end of file
+a -> 30 -> {
+    b
+    c
+}
+
+a -> {
+    30
+    40
+} -> {
+    b
+    c
+}
+```