rsyntaxtree 1.0.6 → 1.0.8

data/README.md

@@ -1,15 +1,67 @@
-# 🌲 RSyntaxTree
+<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>.
 
+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
+
+See [RSyntaxTree Example Gallery](https://yohasebe.github.io/rsyntaxtree/examples) page for syntax tree samples for
+
+- Generative Grammar
+- Combinatory Categorial Grammar (Experimental)
+- Head-Driven Phrase Structure Grammar (Experimental)
+- Cognitive Grammar (Experimental)
+
+
+**Input text**
+
+```text
+[S
+  [NP |R|<>SyntaxTree]
+  [VP
+    [V generates]
+    [NP
+      [Adj #\+multilingual\
+            \+beautiful]
+      [NP syntax\
+          trees]
+    ]
+  ]
+]
+```
+
+**Output (PNG or SVG)**
+
+<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' />
+
+---
+
 ### Installation
 
 `# gem install rsyntaxtree`
 
+---
+
 ### Usage
 
 For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
@@ -17,7 +69,7 @@ For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
 For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
 
 ```text
-SyntaxTree, (linguistic) syntax tree generator written in Ruby.
+RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
 
 Usage:
        rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
@@ -38,41 +90,22 @@ where [options] are:
   -h, --help               Show this message```
 ```
 
-See [the documentation](https://yohasebe.com/rsyntaxtree/#documentation) for more detailed info about the syntax.
-
-### Example
+See the [documentation](https://yohasebe.github.io/rsyntaxtree/documentation) for more detailed info about the syntax.
 
-**Input text**
-
-```text
-[S
-  [NP |R|<>SyntaxTree]
-  [VP
-    [V generates]
-    [NP
-      [Adj #\+multilingual\
-            \+beautiful]
-      [NP syntax\
-          trees]
-    ]
-  ]
-]
-```
-
-**Output (PNG or SVG)**
-
-<img src='https://github.com/yohasebe/rsyntaxtree/blob/master/img/sample.png?raw=true' width='600' />
-
-See [RSyntaxTree Examples](https://yohasebe.notion.site/yohasebe/RSyntaxTree-Examples-006baf3ac6e84e7193b538a5bf02ad07) for more examples
+---
 
 ### Development
 
 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

@@ -79,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"

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*
+  ]
+]
+```

data/docs/_examples/013.md

@@ -0,0 +1,62 @@
+---
+name: "013"
+colorization: "off"
+category: "Head-Driven Phrase Structure Grammar (Experimental)"
+polyline: "off"
+symmetrization: "off"
+connector: "bar"
+font: "Noto Serif"
+reference:
+---
+```
+[#HEAD<>___|1|___\
+  ---\
+  SPR<>〈<>〉\
+  COMPS<>〈<>〉
+  [#HEAD<>___|2|___\
+    ---\
+    *noun*\
+    ---\
+    SPR<>〈<>〉\
+    COMPS〈<>〉
+    Kim
+  ]
+  [#HEAD<>___|1|___\
+    ---\
+    SPR<>〈<>___|2|___<>〉\
+    COMPS<>〈<>〉
+    [#HEAD<>___|1|___\
+      ---\
+      *verb*\
+      ---\
+      SPR<>〈<>___|2|___<>NP〉\
+      COMPS<>〈<>___|3|___<>PP\[*on*\]〉
+      relies
+    ]
+    [#<6>___|3|___\
+      ---\
+      HEAD<>|___4___|\
+      ---\
+      SPR<>〈<>〉\
+      COMPS<>〈<>〉
+      [#HEAD<>|___4___|\
+       ---\
+      *prep*\
+       FORM<>*on*\
+       ---\
+       SPR<>〈<>〉\
+       COMPS<>〈<>|___5___|<>〉
+       on
+      ]
+      [#HEAD<>|___5___|\
+       ---\
+       *noun*\
+       ---\
+       SPR<>〈<>〉\
+       COMPS<>〈<>〉
+       Sandy
+      ]
+    ]
+  ]
+]
+```