rsyntaxtree 1.1.1 → 1.1.2

data/README.md

@@ -2,18 +2,15 @@
 
 **RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language. 
 
----
-
-### Documentation
+## Documentation
 
 Documentation is currently available in the following languages:
 
-- [English](https://yohasebe.github.io/rsyntaxtree/documentation)
-- [日本語](https://yohasebe.github.io/rsyntaxtree/documentation_ja)
-
----
+- [Documentation in English](https://yohasebe.github.io/rsyntaxtree/documentation)
+- [日本語ドキュメント](https://yohasebe.github.io/rsyntaxtree/documentation_ja)
 
-### Web Interface
+- [Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples)
+## Web Interface
 
 <img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/rsyntaxtree-web-screenshot.png?raw=true' width='700px'/>
 
@@ -21,9 +18,7 @@ See updates and a working web interface available at <https://yohasebe.com/rsynt
 
 You can run RSyntaxTree's web interface on your local machine using Docker Desktop. See [RSyntaxTree Web UI](https://github.com/yohasebe/rsyntaxtree_web)
 
----
-
-### Examples
+## Examples
 
 See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples) page for syntax tree samples for
 
@@ -54,15 +49,11 @@ See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/example
 
 <img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' />
 
----
-
-### Installation
+## Installation
 
 `# gem install rsyntaxtree`
 
----
-
-### Usage
+## Usage
 
 For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
 
@@ -93,21 +84,28 @@ where [options] are:
 
 See the [documentation](https://yohasebe.github.io/rsyntaxtree/documentation) for more detailed info about the syntax.
 
----
+## References
 
-### Development
+Please use the following BibTeX entry when referring to RSyntaxTree.
 
-For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree>
+```
+@misc{rsyntaxtree_2023,
+  author = {Yoichiro Hasebe},
+  title = {RSyntaxTree: A graphical syntax tree image generator}
+  url = {https://yohasebe.com/rsyntaxtree},
+  year = {2023}
+}
+```
 
----
+## Development
 
-### Author
+For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree>
 
-Yoichiro Hasebe <yohasebe@gmail.com>
+## Author
 
----
+Yoichiro Hasebe <yohasebe@gmail.com>
 
-### License
+## License
 
 RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
 

data/Rakefile

@@ -2,6 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "yaml"
+require_relative 'lib/rsyntaxtree'
+require_relative 'lib/rsyntaxtree/utils'
 
 # task default: "test"
 
@@ -9,3 +12,71 @@ Rake::TestTask.new do |task|
   task.pattern = "test/*_test.rb"
   task.warning = false
 end
+
+desc "Generate SVG and PNG example images"
+task :generate do
+  examples_dir = File.expand_path(File.join(__dir__, "docs", "_examples"))
+  svg_dir = File.expand_path(File.join(__dir__, "docs", "assets", "svg"))
+  png_dir = File.expand_path(File.join(__dir__, "docs", "assets", "img"))
+  Dir.glob("*.md", base: examples_dir).map do |md|
+    md = File.join(examples_dir, md)
+    config = YAML.load_file(md)
+    rst = File.read(md).scan(/```([^`]+)```/m).last.first
+
+    opts = {
+      format: "png",
+      leafstyle: "auto",
+      fontstyle: "sans",
+      fontsize: 16,
+      margin: 1,
+      vheight: 2.0,
+      color: "on",
+      symmetrize: "on",
+      transparent: "off",
+      polyline: "off"
+    }
+    name = nil
+    config.each do |key, value|
+      next if value.to_s == ""
+
+      case key
+      when "name"
+        name = value
+        opts[:name] = name
+      when "colorization"
+        opts[:color] = value
+      when "polyline"
+        opts[:polyline] = value
+      when "symmetrization"
+        opts[:symmetrize] = value
+      when "connector"
+        opts[:leafstyle] = value
+      when "font"
+        opts[:fontstyle] = case value
+                           when /sans/i
+                             "sans"
+                           when /serif/i
+                             "serif"
+                           when /wqy/i
+                             "cjk"
+                           else
+                             "sans"
+                           end
+      end
+    end
+    opts[:data] = rst
+    rsg = RSyntaxTree::RSGenerator.new(opts)
+
+    File.open(File.join(svg_dir, "#{name}.svg"), "w") do |f|
+      puts "Creating svg file: #{name}.svg"
+      svg = rsg.draw_svg
+      f.write(svg)
+    end
+
+    File.open(File.join(png_dir, "#{name}.png"), "w") do |f|
+      puts "Creating png file: #{name}.png"
+      png = rsg.draw_png
+      f.write(png)
+    end
+  end
+end

data/docs/_examples/001.md

@@ -1,5 +1,6 @@
 ---
 name: "001"
+caption: "Basic binary tree"
 colorization: "on"
 category: "General"
 polyline: "off"

data/docs/_examples/002.md

@@ -1,5 +1,6 @@
 ---
 name: "002"
+caption: "Minimalistic syntree"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/003.md

@@ -1,5 +1,6 @@
 ---
 name: "003"
+caption: "Minimalistic syntree"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/004.md

@@ -1,5 +1,6 @@
 ---
 name: "004"
+caption: "Minimalistic syntree"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/005.md

@@ -1,5 +1,6 @@
 ---
 name: "005"
+caption: "Minimalistic syntree"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/006.md

@@ -1,5 +1,6 @@
 ---
 name: "006"
+caption: "Minimalistic syntree"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/007.md

@@ -1,5 +1,6 @@
 ---
 name: "007"
+caption: "X-bar model (with Japanese labels)"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/008.md

@@ -1,5 +1,6 @@
 ---
 name: "008"
+caption: "vP-shell (Japanese)"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/009.md

@@ -1,5 +1,6 @@
 ---
 name: "009"
+caption: "Non-binary tree sample"
 colorization: "off"
 category: "Generative Grammar"
 polyline: "off"

data/docs/_examples/010.md

@@ -1,5 +1,6 @@
 ---
 name: "010"
+caption: "Path drawing sample"
 category: "Generative Grammar"
 polyline: "off"
 colorization: "on"

data/docs/_examples/011.md

@@ -1,5 +1,6 @@
 ---
 name: "011"
+caption: "CCG sample"
 colorization: "off"
 category: "Combinatory Categorial Grammar (Experimental)"
 polyline: "off"

data/docs/_examples/012.md

@@ -1,5 +1,6 @@
 ---
 name: "012"
+caption: "CCG sample"
 colorization: "off"
 category: "Combinatory Categorial Grammar (Experimental)"
 polyline: "off"

data/docs/_examples/013.md

@@ -1,5 +1,6 @@
 ---
 name: "013"
+caption: "HPSG sample"
 colorization: "off"
 category: "Head-Driven Phrase Structure Grammar (Experimental)"
 polyline: "off"

data/docs/_examples/014.md

@@ -1,5 +1,6 @@
 ---
 name: "014"
+caption: "Cognitive Grammar sample"
 colorization: "off"
 category: "Cognitive Grammar (Experimental)"
 polyline: "off"

data/docs/_examples/015.md

@@ -1,5 +1,6 @@
 ---
 name: "015"
+caption: "Phonology sample"
 colorization: "on"
 category: "Phonology"
 polyline: "off"

data/docs/_examples/016.md

@@ -1,7 +1,8 @@
 ---
 name: "016"
+caption: "Tick-tac-toe"
 colorization: "off"
-category: "Tic-Tac-Toe"
+category: "Miscellaneous"
 polyline: "off"
 symmetrization: "off"
 connector: "bar"

data/docs/_examples/017.md

@@ -1,5 +1,6 @@
 ---
 name: "017"
+caption: "Basic polyline sample"
 colorization: "on"
 category: "General"
 polyline: "on"

data/docs/_examples/018.md

@@ -1,5 +1,6 @@
 ---
 name: "018"
+caption: "Tree with text labels in bold"
 category: "Generative Grammar"
 polyline: "off"
 colorization: "on"

data/docs/_examples/019.md

@@ -1,5 +1,6 @@
 ---
 name: "019"
+caption: "Programming language parser"
 colorization: "off"
 category: "Computer Science"
 polyline: "on"
@@ -56,4 +57,4 @@ reference: "Stuart 2014"
     [##<>\}<>]
   ]
 ]
-```
+```

data/docs/_examples/020.md

@@ -1,5 +1,6 @@
 ---
 name: "020"
+caption: "From phoneme to sentence"
 colorization: "on"
 category: "General"
 polyline: "off"

data/docs/_examples/021.md

@@ -0,0 +1,43 @@
+---
+name: "021"
+caption: "Types of meaning"
+colorization: "off"
+category: "Pragmatics"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference: "Zufferey, Moeschler, and Reboul 2014"
+---
+```
+[Types<>of<>meaning
+  [conventional
+    [semantic
+      [entailment]
+      [presupposition]
+    ]
+    [pragmatic
+      [conventional\
+       implicature]
+    ]
+  ]
+  [non\-conventional
+    [explicit
+      [explicature]
+    ]
+    [implicit
+      [conventional
+        [generalized\
+         implicature]
+        [particularized\
+         implicature]
+      ]
+      [non\-\
+       conventional
+        [pragmatic\
+         presupposition]
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/022.md

@@ -0,0 +1,58 @@
+---
+name: "022"
+caption: "Arithmetic parser"
+colorization: "off"
+category: "Computer Science"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference: ""
+---
+```
+[\<expression\>
+  [\<term\>
+    [\<term\>
+      [\<factor\>
+        \(
+        [\<expression\>
+          [\<expression\>
+            [\<term\>
+              [\<factor\>
+                {A}
+              ]
+            ]
+          ]
+          [{＋}]
+          [\<term\>
+            [\<factor\>
+              {B}
+            ]
+          ]
+        ]
+        \)
+      ]
+    ]
+    [{＊}]
+    [\<factor\>
+      \(
+      [\<expression\>
+        [\<expression\>
+          [\<term\>
+            [\<factor\>
+              {C}
+            ]
+          ]
+        ]
+        [{＋}]
+        [\<term\>
+          [\<factor\>
+            {D}
+          ]
+        ]
+      ]
+      \)
+    ]
+  ]
+]
+```

data/docs/_examples/023.md

@@ -0,0 +1,23 @@
+---
+name: "023"
+caption: "Tournament"
+colorization: "off"
+category: "Miscellaneous"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Sans"
+reference: ""
+---
+```
+[{**D**}
+  [{**D**}
+    [A [{A}] [B]]
+    [{**D**} [C] [{**D**}]]
+  ]
+  [G
+    [F [E] [{F}]]
+    [{G} [{G}] [H]]
+  ]
+]
+```

data/docs/_examples/024.md

@@ -0,0 +1,23 @@
+---
+name: "024"
+caption: "X-bar model"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference:
+---
+```
+[XP
+  [W Specifier]
+  [X'
+    [X'
+      [X Head]
+      [Y Complement]
+    ]
+    [Z Modifier]
+  ]
+]
+```

data/docs/_examples/025.md

@@ -0,0 +1,87 @@
+---
+name: "025"
+caption: "Network of non-prototypical sentence constructions"
+colorization: "off"
+category: "Construction Grammar"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference: "Goldberg 2006: 177"
+---
+```
+[#**Non\-prototypical<>sentence**\
+  ---\
+  NON\-POSITIVE,\
+  non\-predicate<>focus,\
+  non\-assertive,\
+  dependent,\
+  non\-declarative
+  [#**Y/N<>questions**\
+    ---\
+    NON\-POSITIVE,\
+    non\-declarative\
+    ---\
+    *Did<>she<>go?*
+    [#**Wh\-Questions**\
+      ---\
+      non\-declarative\
+      ---\
+      *Where<>did<>she<>go?*
+    ]
+    [#**Exclamatives**\
+      ---\
+      non\-assertive\
+      ---\
+      *Boy<>did<>she<>go!*
+    ]
+  ]
+  [#**Counterfactual<>conditionals**\
+    ---\
+    NON\-POSITIVE\
+    dependent,<>non\-asserted\
+    ---\
+    *Had<>he<>found<>a<>solution,<>he*\
+    *would<>take<>time<>off<>and<>relax.*
+  ]
+  [#**Initial<>negative**\
+    **adverb<>clauses**\
+    ---\
+    NON\-POSITIVE\
+    ---\
+    *Not<>until<>yesterday<>did*\
+    *he<>take<>a<>break.*\
+  ]
+  [#**Negative<>rejoinder**\
+    ---\
+    NON\-POSITIVE,\
+    dependent\
+    ---\
+    *Neither<>is<>this<>construction*\
+    *unexpected.*
+    [#**Positive<>conjunct<>clauses**\
+      ---\
+      non\-predicate<>focus,\
+      dependent\
+      ---\
+      *So<>was<>I.*
+    ]
+  ]
+  [#**Comparatives**\
+    ---\
+    non\-topic\-comment,\
+    dependent\
+    ---\
+    *He<>was<>faster<>at<>it*\
+    *than<>was<>she.*
+  ]
+  [#**Wishes,<>curses**\
+    ---\
+    NON\-POSITIVE,\
+    non\-declarative\
+    ---\
+    *May<>a<>million<>flies*\
+    *infest<>his<>armpits!*
+  ]
+]
+```

data/docs/_examples/026.md

@@ -0,0 +1,27 @@
+---
+name: "026"
+caption: "Types of reference"
+colorization: "off"
+category: "Pragmatics"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference: "Halliday and Hasan 1976: 33"
+---
+```
+[Reference:
+  [\[situational\]\
+     exophora
+  ]
+  [\[textual\]\
+     endophora
+    [\[to<>preceding<>text\]\
+     anaphora
+    ]
+    [\[to<>following<>text\]\
+     cataphora
+    ]
+  ]
+]
+```

data/docs/_examples/027.md

@@ -0,0 +1,54 @@
+---
+name: "027"
+caption: "Types of rejoinder"
+colorization: "off"
+category: "Pragmatics"
+polyline: "on"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference: "Halliday and Hasan 1976: 207"
+---
+```
+[REJOINDER\
+ (any<>cohesive<>sequel<>by<>different<>speaker)
+  [(following<>a<>question)\
+    RESPONSE
+    [(answering)\
+     DIRECT\
+     RESPONSE
+    ]
+    [(not<>answering)\
+     INDIRECT<>RESPONSE
+      [(attitude<>to<>answer)\
+       COMMENTARY
+      ]
+      [(evading<>answer)\
+       DISCLAIMER
+      ]
+      [(implying<>answer)\
+       SUPPLEMENTARY\
+       RESPONSE
+      ]
+    ]
+  ]
+  [(not<>following<>a<>question)\
+   \[other<>rejoinders\]
+    [(following<>a<>statement)
+      [ASSENT]
+      [CONTRADICTION]
+    ]
+    [(following<>a\
+     statement<>or\
+     command)\
+     QUESTION\
+     REJOINDER
+    ]
+    [(following<>\
+     a<>command)
+      [CONSENT]
+      [REFUSAL]
+    ]
+  ]
+]
+```

data/docs/_examples/028.md

@@ -0,0 +1,20 @@
+---
+name: "028"
+caption: "Basic tree with triangles"
+colorization: "on"
+category: "General"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference: 
+---
+```
+[NP
+  [NP a picture]
+  [PP
+    [P of]
+    [NP ^cats]
+  ]
+]
+```