rsyntaxtree 1.0.5 → 1.0.7

data/README.md

@@ -1,71 +1,111 @@
-# 🌲 RSyntaxTree: yet another syntax tree generator in Ruby
+<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/rsyntaxtree.png?raw=true' style='width: 256px;' />
 
-**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language inspired by [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/). 
+**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language. 
+
+---
+
+### Documentation
+
+Documentation is currently available in the following languages:
+
+- [English](https://yohasebe.github.io/rsyntaxtree/documentation)
+- [日本語](https://yohasebe.github.io/rsyntaxtree/documentation_ja)
+
+---
 
 ### Web Interface
 
+<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/rsyntaxtree-web-screenshot.png?raw=true' width='700px'/>
+
 See updates and a working web interface available at <https://yohasebe.com/rsyntaxtree>.
 
-### Installation
+You can run RSyntaxTree's web interface on your local machine using Docker Desktop. See [RSyntaxTree Web UI](https://github.com/yohasebe/rsyntaxtree_web)
 
-`# gem install rsyntaxtree`
+---
 
-### Usage
+### Examples
 
-For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
+See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples) page for syntax tree samples for
 
-For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
+- Generative Grammar
+- Combinatory Categorial Grammar (Experimental)
+- Head-Driven Phrase Structure Grammar (Experimental)
+- Cognitive Grammar (Experimental)
 
-```text
-RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
 
-Usage:
-       rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
-where [options] are:
-      -o, --outdir=<s>        Output directory (default: ./)
-      -f, --format=<s>        Output format: png, pdf, or svg (default: png)
-      -l, --leafstyle=<s>     visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
-      -n, --fontstyle=<s>     Font style: sans, serif, cjk, math (default: sans)
-      -t, --font=<s>          Path to a ttf font used to generate tree (optional)
-      -s, --fontsize=<i>      Size: 8-26 (default: 16)
-      -c, --color=<s>         Color text and bars: on or off (default: on)
-      -y, --symmetrize=<s>    Generate symmetrical, balanced tree: on or off (default: on)
-      -m, --margin=<i>        Margin: 0-120 (default: 0)
-      -v, --vheight=<f>       Connector Height: 0.5-2.0 (default: 1.0)
-      -e, --version           Print version and exit
-      -h, --help              Show this message
+**Input text**
+
+```text
+[S
+  [NP |R|<>SyntaxTree]
+  [VP
+    [V generates]
+    [NP
+      [Adj #\+multilingual\
+            \+beautiful]
+      [NP syntax\
+          trees]
+    ]
+  ]
+]
 ```
 
-### Tips
+**Output (PNG or SVG)**
+
+<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' />
+
+---
 
-Every branch or leaf of a tree must belong to a node. To create a node, place a label right next to the opening bracket. Arbitrary number of branches can follow with a preceding space.
+### Installation
 
-There are several modes in which the connectors between terminal nodes and their leaves are drawn differently (auto, triangle, bar, and nothing). In auto mode, a triangle is used if the leaf contains one or more spaces inside (i.e. if it&#8217;s a phrase), but if it contains no spaces (i.e. if it is just a word), a straight bar will be drawn instead (unless the leaf contains a "^" symbol at the end which makes it a single-word phrase).
+`# gem install rsyntaxtree`
 
-You can put a subscript to any node by putting the _ character between the main label and the subscript. For example, NP_TOP will be rendered as NP<sub>TOP</sub>. Or you can select the &#8220;Auto subscript&#8221; option so that nodes of the same label will be automatically numbered. (e.g. NP<sub>1</sub>, NP<sub>2</sub>)</p>
+---
 
-See https://yohasebe.com/rsyntaxtree for more detailed info about the syntax.
+### Usage
 
-### Example
+For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
 
-Bracket notation (auto-subscript-on):
+For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
 
 ```text
-[S [NP RSyntaxTree^][VP [V generates][NP [Adj multilingual] [NP syntax trees]]]]
+RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
+
+Usage:
+       rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
+where [options] are:
+  -o, --outdir=<s>         Output directory (default: ./)
+  -f, --format=<s>         Output format: png, gif, jpg, pdf, or svg (default: png)
+  -l, --leafstyle=<s>      visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
+  -n, --fontstyle=<s>      Font style (available when ttf font is specified): sans, serif, cjk (default: sans)
+  -t, --font=<s>           Path to a ttf font used to generate tree (optional)
+  -s, --fontsize=<i>       Size: 8-26 (default: 16)
+  -m, --margin=<i>         Margin: 0-10 (default: 1)
+  -v, --vheight=<f>        Connector Height: 0.5-5.0 (default: 2.0)
+  -c, --color=<s>          Color text and bars: on or off (default: on)
+  -y, --symmetrize=<s>     Generate radically symmetrical, balanced tree: on or off (default: off)
+  -r, --transparent=<s>    Make background transparent: on or off (default: off)
+  -p, --polyline=<s>       draw polyline connectors: on or off (default: off)
+  -e, --version            Print version and exit
+  -h, --help               Show this message```
 ```
 
-Resulting PNG
+See the [documentation](https://yohasebe.github.io/rsyntaxtree/documentation) for more detailed info about the syntax.
 
-![RSyntaxTree generates multilingual syntax trees](https://i.gyazo.com/6bb68b0bdb35d7a10c4a11d5788d484f.png)
+---
 
 ### Development
 
-For the latest updates and downloads please visit http://github.com/yohasebe/rsyntaxtree
+For the latest updates and downloads please visit <http://github.com/yohasebe/rsyntaxtree>
+
+---
 
 ### Author
 
 Yoichiro Hasebe <yohasebe@gmail.com>
 
+---
+
 ### License
 
 RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

data/bin/rsyntaxtree

@@ -38,6 +38,8 @@ EOS
       :default => "off"
   opt :transparent, "Make background transparent: on or off",
       :default => "off"
+  opt :polyline, "draw polyline connectors: on or off",
+      :default => "off"
 end
 
 Optimist::die :outdir, "must be an exsting directory path" unless FileTest::directory?(opts[:outdir])
@@ -51,6 +53,7 @@ Optimist::die :symmetrize, "must be either on or off" unless /\A(on|off|true|fal
 Optimist::die :margin, "must be in the range of 0-10" if opts[:margin] < 0 || opts[:margin] > 10
 Optimist::die :vheight, "must be in the range of 0.5-5.0" if opts[:vheight] < 0.5 || opts[:vheight] > 5.0
 Optimist::die :transparent, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:transparent]
+Optimist::die :polyline, "must be either on or off" unless /\A(on|off|true|false)\z/ =~ opts[:polyline]
 
 string_opts = {}
 opts.each do |key, value|
@@ -76,7 +79,6 @@ begin
     rsg.draw_tree.write(filepath)
   when "png"
     outfile = File.new(filepath, "wb")
-    # outfile.write rsg.draw_png
     outfile.write rsg.draw_tree
     outfile.close
   when "svg"
@@ -88,6 +90,7 @@ rescue RSTError => e
   puts e
   exit
 rescue => e
+  p e
   puts "Error: something unexpected occurred"
   exit
 end

data/docs/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/docs/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.2.1"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+gem "webrick"

data/docs/_config.yml

@@ -0,0 +1,77 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you: 
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: RSyntaxTree
+email: yohasebe@gmail.com
+description: Syntax tree generator made with Ruby
+baseurl: "/rsyntaxtree/"
+domain: "yohasebe.github.io"
+url: "https://yohasebe.github.io"
+twitter_username: yohasebe
+github_username:  yohasebe
+
+# Build settings
+remote_theme: pages-themes/cayman@v0.2.0
+plugins:
+- jekyll-remote-theme # add this line to the plugins list if you already have one:
+
+
+markdown: kramdown
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+exclude:
+- Gemfile
+- Gemfile.lock
+#  - .sass-cache/
+#  - .jekyll-cache/
+#  - gemfiles/
+
+github:
+  - repository_url: https://github.com/yohasebe/rsyntaxtree
+
+collections:
+  - examples
+
+social-media:
+  email:
+    id: 'yohasebe@gmail.com'
+    href: 'mailto:'
+    title: 'Email'
+    fa-icon: 'fa-envelope'
+    category: 'fa'
+  twitter:
+    id: 'yohasebe'
+    href: 'https://www.twitter.com/'
+    title: 'Twitter'
+    fa-icon: 'fa-twitter'
+    category: 'fab'
+  github:
+    id: 'yohasebe'
+    href: 'https://github.com/'
+    title: 'GitHub'
+    fa-icon: 'fa-github'
+    category: 'fab'

data/docs/_examples/001.md

@@ -0,0 +1,22 @@
+---
+name: "001"
+colorization: "on"
+category: "General"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference: 
+---
+```
+[A
+  [B
+    [D]
+    [E]
+  ]
+  [C
+    [F]
+    [G]
+  ]
+]
+```

data/docs/_examples/002.md

@@ -0,0 +1,31 @@
+---
+name: "002"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference: "Chomsky 1995: 50"
+---
+```
+[CP
+  [John]
+  [TP
+    [T
+      [V
+        [cause]
+        [V fall]
+      ]
+      [T]
+    ]
+    [VP
+      [V *t*_c_]
+      [CP
+        [books]
+        [*t*_f_]
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/003.md

@@ -0,0 +1,25 @@
+---
+name: "003"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference: "Chomsky 1995: 62"
+---
+```
+[VP
+  [John]
+  [V'
+    [V *e*]
+    [VP
+      [NP a book]
+      [V'
+        [V gave]
+        [to\-Bill]
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/004.md

@@ -0,0 +1,25 @@
+---
+name: "004"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference: "Chomsky 1995: 180"
+---
+```
+[VP_1_
+  [NP_1_ John]
+  [V'_1_
+    [V_1_ *e*]
+    [VP_2_
+      [NP_2_ the book]
+      [V'_2_
+        [V_2_ put]
+        [ZP on the shelf]
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/005.md

@@ -0,0 +1,22 @@
+---
+name: "005"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference: "Chomsky 1995: 355"
+---
+```
+[X__max__
+  [\[Y\−X\]]
+  [YP
+    [Spec_1_]
+    [Y'
+      [*t*]
+      [ZP]
+    ]
+  ]
+]
+```

data/docs/_examples/006.md

@@ -0,0 +1,25 @@
+---
+name: "006"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference: "Chomsky 1995: 369"
+---
+```
+[𝑣P
+  [Spec_2_]
+  [𝑣'
+    [Subj]
+    [𝑣'
+      [Vb]
+      [VP
+        [*t*_v_]
+        [Obj]
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/007.md

@@ -0,0 +1,26 @@
+---
+name: "007"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference:
+---
+```
+[XP
+  [W Specifier\
+     指定部]
+  [X'
+    [X'
+      [X Head\
+         主要部]
+      [Y Complement\
+         補部]
+    ]
+    [Z Modifier\
+       付加部]
+  ]
+]
+```

data/docs/_examples/008.md

@@ -0,0 +1,28 @@
+---
+name: "008"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference:
+---
+```
+[𝑣P
+  [NP 太郎が]
+  [𝑣'
+    [VP
+      [𝑣P
+        [NP ^泥棒に]
+        [𝑣'
+          [VP ^財布を盗む]
+          [𝑣]
+        ]
+      ]
+      [V られ]
+    ]
+    [𝑣]
+  ]
+]
+```

data/docs/_examples/009.md

@@ -0,0 +1,24 @@
+---
+name: "009"
+colorization: "off"
+category: "Generative Grammar"
+polyline: "off"
+symmetrization: "off"
+connector: "auto"
+font: "Noto Serif"
+reference:
+---
+```
+[S__＊__
+  [NP α_1_]
+  [INFL (AGR)]
+  [VP
+    [V]
+    [NP α_2_]
+    [PP
+      [P]
+      [NP α_3_]
+    ]
+  ]
+]
+```

data/docs/_examples/010.md

@@ -0,0 +1,48 @@
+---
+name: "010"
+category: "Generative Grammar"
+polyline: "off"
+colorization: "on"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference: "Radford 2004"
+---
+```
+[CP
+  [C
+   ø]
+  [TP
+    [PRN
+    **They**+>2
+    ]
+    [T'
+      [T
+       Will
+      ]
+      [vP
+        [PRN
+         ~**they**~+2
+        ] 
+        [v'
+          [v
+           ø<>\+<>*get*+>1
+          ]
+          [VP
+            [DP
+             the<>teacher]
+            [V'
+              [V
+               ~*get*~+1
+              ]
+              [QP
+               a<>present
+              ]
+            ]
+          ]
+        ]  
+      ]
+    ]
+  ]
+]
+```

data/docs/_examples/011.md

@@ -0,0 +1,37 @@
+---
+name: "011"
+colorization: "off"
+category: "Combinatory Categorial Grammar (Experimental)"
+polyline: "off"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference:
+---
+```
+[S\
+ \<
+  [NP\
+   \>
+    [NP/N\
+    ---\
+     *the*
+    ]
+    [N\
+    ---\
+     *dog*
+    ]
+  ]
+  [S\\NP\
+    \>
+    [(S\\NP)\\NP\
+    ---\
+     *bit*
+    ]
+    [NP\
+    ---\
+     *John*
+    ]
+  ]
+]
+```

data/docs/_examples/012.md

@@ -0,0 +1,40 @@
+---
+name: "012"
+colorization: "off"
+category: "Combinatory Categorial Grammar (Experimental)"
+polyline: "off"
+symmetrization: "off"
+connector: "none"
+font: "Noto Serif"
+reference:
+---
+```
+[S\
+    \>
+  [S/NP\
+   B_\>_
+    [S/(S\\NP)\
+     T_\>_
+      [NP\
+         \>
+        [NP/N\
+         ---\
+         *the*
+        ]
+        [N\
+         ---\
+         *dog*
+        ]
+      ]
+    ]
+    [(S\\NP)/NP\
+     ---\
+     *bit*
+    ]    
+  ]
+  [NP\
+   ---\
+   *John*
+  ]
+]
+```