rsyntaxtree 0.5.0 → 0.5.1

data/README.md

@@ -4,7 +4,7 @@ RSyntaxTree is a graphical syntax tree generator written in the Ruby programming
 
 While phpSyntaxTree does not accept **multi-byte characters** as those in Chinese, Japanese, and Korean, RSyntaxTree handles text of any language as long as encoded in UTF-8 and fonts have been installed. Additionally, RSyntaxTree can output **symmetrized** tree diagrams, a functionality that is not implemented in phpSyntaxTree.
 
-RSyntaxTree consists of an easy-to-use command-line app and a web-based interfaces made with  [Sinatra](http://www.sinatrarb.com) web framework.
+RSyntaxTree consists of an easy-to-use command-line app and a web-based interface made with  [Sinatra](http://www.sinatrarb.com) web framework.
 
 ### Web Interface
 
@@ -23,10 +23,10 @@ For the command-line interface, type `$rsyntaxtree -h` after installation. Here'
     RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
     
     Usage:
-           rsyntaxtree [options] "[NP [N bracket] [NP notation]]]"
+           rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
     where [options] are:
           --outdir, -o <s>:   Output directory (default: present working directory) (default: ./)
-          --format, -f <s>:   Output format: png or svg (default: png)
+          --format, -f <s>:   Output format: png, pdf, or svg (default: png)
        --leafstyle, -l <s>:   visual style of tree leaves: triangle, bar, or nothing (default: triangle)
        --fontstyle, -n <s>:   Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk (default: cjk)
             --font, -t <s>:   Path to a ttf font used to generate tree
@@ -37,6 +37,22 @@ For the command-line interface, type `$rsyntaxtree -h` after installation. Here'
              --version, -v:   Print version and exit
                 --help, -h:   Show this message
 
+### Tips
+
+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. When a node has one and only one leaf and the leaf contains more than one space characters, the node is treated as a phrase and a triangle (not just a vertical bar) will be between the node label and the leaf).
+
+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>
+
+### Example
+
+Bracket notation (auto-subscript-on):
+
+    [NP [NP [ART a] [N table]] [PP [P near] [NP [ART the] [N door]]]]
+
+Resulting PNG
+
+![a table near the door](http://yohasebe.com/img/rsyntaxtree_example.png)
+
 ### Development
 
 For the latest updates and downloads please visit http://github.com/yohasebe/rsyntaxtree

data/app.rb

@@ -9,6 +9,8 @@ require './lib/rsyntaxtree'
 
 include Helpers
 
+set :public_folder, File.dirname(__FILE__) + '/public'
+
 configure do
   enable :sessions
 end

data/bin/rsyntaxtree

@@ -16,15 +16,15 @@ Usage:
 where [options] are:
 EOS
 
-  opt :outdir, "Output directory (default: present working directory)",
+  opt :outdir, "Output directory",
       :default => "./"
   opt :format, "Output format: png, pdf, or svg",
       :default => "png"
   opt :leafstyle, "visual style of tree leaves: triangle, bar, or nothing", 
       :default => "triangle"
-  opt :fontstyle, "Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk",
+  opt :fontstyle, "Font style (available when ttf font is specified): sans-serif, serif, jp-gothic, jp-mincho, cjk",
       :default => "cjk"
-  opt :font, "Path to a ttf font used to generate tree", :type => String
+  opt :font, "Path to a ttf font used to generate tree (optional)", :type => String
   opt :fontsize, "Font size: 8-20",
       :default => 16
   opt :color, "Color text and bars: on or off",

data/lib/rsyntaxtree/version.rb

@@ -1,4 +1,4 @@
 module RSyntaxTree
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end
 

data/public/js/rsyntaxtree.js

@@ -19,7 +19,7 @@ $(function(){
   function draw_graph(data){
     $("#result").html("<img id='tree_image'>");
 	$.ajax({
-	    url: '/draw_png',
+	    url: 'draw_png',
 	    type: 'POST',
 	    data: make_params(data),
 	    success: function (png) {
@@ -28,15 +28,6 @@ $(function(){
     });
   }
 
-  // function draw_graph(data){
-  //   $("#result").html("<img id='tree_image' src='/draw_png?" + make_params(data)  + "'>");    
-  // }
-  
-  function download_svg(data){
-    var params = make_params(data)
-    $.post('/svg', params);
-  }
-  
   function escape_chrs(data){
     data = data.replace(/\&/g, "-AMP-").replace(/\'/g, "-PRIME-").replace(/\;/g, "-SCOLON");
     data = $('<div/>').text(data).html();
@@ -44,7 +35,7 @@ $(function(){
   }
 
   function postForm(data, format){
-    $('<form/>', {action: '/download_' + format, method: 'POST'})
+    $('<form/>', {action: 'download_' + format, method: 'POST'})
       .append($('<input/>', {type: 'hidden', name: 'data', value: data}))
       .append($('<input/>', {type: 'hidden', name: 'format', value: $("select[name=format]").val()}))
       .append($('<input/>', {type: 'hidden', name: 'leafstyle', value: $("select[name=leafstyle]").val()}))
@@ -63,7 +54,7 @@ $(function(){
     data = escape_chrs(data);
     $.ajax({
        type: "POST",
-       url:"/check",
+       url:"check",
        data:"data=" + data,
        success: function(msg){
          if(msg != "true"){
@@ -81,7 +72,7 @@ $(function(){
     data = escape_chrs(data);
     $.ajax({
        type: "POST",
-       url:"/check",
+       url:"check",
        data:"data=" + data,
        success: function(msg){
          if(msg != "true"){
@@ -100,7 +91,7 @@ $(function(){
     data = escape_chrs(data);
     $.ajax({
        type: "POST",
-       url:"/check",
+       url:"check",
        data:"data=" + data,
        success: function(msg){
          if(msg != "true"){
@@ -116,7 +107,7 @@ $(function(){
   $("#check").click(function(){    
     $.ajax({
        type: "POST",
-       url:"/check",
+       url:"check",
        data:"data=" + escape_chrs($("#data").val()),
        success: function(msg){
          if(msg == "true"){

data/rsyntaxtree.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = RSyntaxTree::VERSION
   s.authors     = ["Yoichiro Hasebe"]
   s.email       = ["yohasebe@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/yohasebe/rsyntaxtree"
   s.summary     = %q{RSyntaxTree is a graphical syntax tree generator written in Ruby}
   s.description = %q{Yet another syntax tree generator made with Ruby and RMagick}
 

data/views/index.haml

@@ -20,7 +20,7 @@
         %option{:value => "bar"}Bar
         %option{:value => "nothing"}Nothing
     .span2
-      %h4 Fontstyle
+      %h4 Font-style
       %select{:name => "fontstyle", :style => "width:110px;"}
         %option{:value => "sans-serif"}San-Serif
         %option{:value => "serif"}Serif
@@ -28,7 +28,7 @@
         %option{:value => "jp-mincho"}JP-Mincho
         %option{:value => "cjk"}CJK
     .span2
-      %h4 Fontsize 
+      %h4 Font-size 
       %select{:name => "fontsize", :style => "width:60px;"}
         %option{:value => "8"}8
         %option{:value => "10"}10
@@ -93,7 +93,7 @@
         %a{:href =>'http://github.com/yohasebe/rsyntaxtree'}http://github.com/yohasebe/rsyntaxtree .
       %p
         RSyntaxTree is distributed under
-        %a{:href => 'http://www.gnu.org/copyleft/gpl.html'}the GNU Public License.
+        %a{:href => 'http://www.opensource.org/licenses/mit-license.php'}the MIT License.
 
     .span6
       %h2
@@ -117,13 +117,12 @@
         label will be automatically numbered. (e.g. NP<sub>1</sub>, NP<sub>2</sub>)</p>
 
       %p
-        RSyntaxTree is capable of generating PNG and SVG files. The latter is very convenient 
+        RSyntaxTree is not capable of generating PNG, PDF and SVG files. SVG is very convenient 
         for those who want to modify output images on third party vector graphic software 
-        (such as Adobe Illustrator and Microsoft Visio). Just click on the link that appears 
-        below the (non SVG) syntax tree image.
+        (such as Adobe Illustrator and Microsoft Visio).
 
       %p
-        Options &#8220;Font&#8221;, &#8220;Fontsize&#8221;, and &#8220;Color&#8221; would be 
+        Options &#8220;Font-style&#8221;, &#8220;Font-size&#8221;, and &#8220;Color&#8221; would be 
         self-explanatory. You can change the appearance of the resulting image to suit your purpose.
     
   %hr

data/views/layout.haml

@@ -6,7 +6,7 @@
     %meta{:name => "description", :content => ""}
     %meta{:name => "author", :content => ""}
 
-    %link{ :href => "/bootstrap/css/bootstrap.css", :type => "text/css", :rel => "stylesheet" }
+    %link{ :href => "bootstrap/css/bootstrap.css", :type => "text/css", :rel => "stylesheet" }
 
     :plain
       <style type="text/css">
@@ -16,8 +16,8 @@
         }
       </style>
 
-    %link{ :href => "/bootstrap/css/bootstrap-responsive.css", :type => "text/css", :rel => "stylesheet" }
-    %link{ :href => "/css/rsyntaxtree.css", :type => "text/css", :rel => "stylesheet" }
+    %link{ :href => "bootstrap/css/bootstrap-responsive.css", :type => "text/css", :rel => "stylesheet" }
+    %link{ :href => "css/rsyntaxtree.css", :type => "text/css", :rel => "stylesheet" }
 
     :plain
       <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
@@ -26,17 +26,16 @@
       <![endif]-->    
 
     / Le fav and touch icons 
-    %link{ rel: "apple-touch-icon", href: "/bootstrap/images/apple-touch-icon.png"}
-    %link{ rel: "shortcut icon", href: "/bootstrap/images/favicon.ico"}
-    %link{ rel: "apple-touch-icon", sizes: "72x72", href: "/bootstrap/images/apple-touch-icon-72x72.png"}
-    %link{ rel: "apple-touch-icon", sizes: "114x114", href: "/bootstrap/images/apple-touch-icon-114x114.png"}
+    %link{ rel: "apple-touch-icon", href: "bootstrap/images/apple-touch-icon.png"}
+    %link{ rel: "shortcut icon", href: "bootstrap/images/favicon.ico"}
+    %link{ rel: "apple-touch-icon", sizes: "72x72", href: "bootstrap/images/apple-touch-icon-72x72.png"}
+    %link{ rel: "apple-touch-icon", sizes: "114x114", href: "bootstrap/images/apple-touch-icon-114x114.png"}
 
   %body    
     %div= haml :navbar
     %div= yield
 
     / Placed at the end of the document so the pages load faster
-    %script{ :type => "text/javascript", :src =>"/bootstrap/js/jquery.js"}
-    %script{ :type => "text/javascript", :src =>"/bootstrap/js/bootstrap.js"}
-    %script{ :type => "text/javascript", :src =>"/js/rsyntaxtree.js"}
-    
+    %script{ :type => "text/javascript", :src =>"bootstrap/js/jquery.js"}
+    %script{ :type => "text/javascript", :src =>"bootstrap/js/bootstrap.js"}
+    %script{ :type => "text/javascript", :src =>"js/rsyntaxtree.js"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsyntaxtree
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &70327959540840 !ruby/object:Gem::Requirement
+  requirement: &70171855522580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327959540840
+  version_requirements: *70171855522580
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70327959539320 !ruby/object:Gem::Requirement
+  requirement: &70171855521840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327959539320
+  version_requirements: *70171855521840
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70327959538420 !ruby/object:Gem::Requirement
+  requirement: &70171855521120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327959538420
+  version_requirements: *70171855521120
 - !ruby/object:Gem::Dependency
   name: shotgun
-  requirement: &70327959537800 !ruby/object:Gem::Requirement
+  requirement: &70171855520620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327959537800
+  version_requirements: *70171855520620
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70327959536820 !ruby/object:Gem::Requirement
+  requirement: &70171855520160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327959536820
+  version_requirements: *70171855520160
 description: Yet another syntax tree generator made with Ruby and RMagick
 email:
 - yohasebe@gmail.com
@@ -112,7 +112,7 @@ files:
 - views/index.haml
 - views/layout.haml
 - views/navbar.haml
-homepage: ''
+homepage: http://github.com/yohasebe/rsyntaxtree
 licenses: []
 post_install_message: 
 rdoc_options: []