rmmseg 0.0.1

data/lib/rmmseg.rb

@@ -0,0 +1,15 @@
+$KCODE = 'u'
+require 'jcode'
+
+require 'rmmseg/config'
+require 'rmmseg/simple_algorithm'
+require 'rmmseg/complex_algorithm'
+
+module RMMSeg
+  VERSION = '0.0.1'
+  
+  # Segment +text+ using the algorithm configured.
+  def segment(text)
+    Config.algorithm_instance(text).segment
+  end
+end

data/misc/homepage.erb

@@ -0,0 +1,93 @@
+<%
+  $title = "RMMSeg Homepage"
+  $authors = { 'pluskid' => 'http://pluskid.lifegoo.com' }
+
+  $unindent = '  '
+%>
+
+<% chapter "Introduction" do %> 
+
+  RMMSeg is an implementation of
+  "MMSEG":http://technology.chtsai.org/mmseg/ Chinese word
+  segmentation algorithm. It is based on two variants of maximum
+  matching algorithms. Two algorithms are available for using:
+  
+  * simple algorithm that uses only forward maximum matching.
+  * complex algorithm that uses three-word chunk maximum matching and 3
+    aditonal rules to solve ambiguities.
+
+  For more information about the algorithm, please refer to the
+  following essays:
+
+  * http://technology.chtsai.org/mmseg/
+  * http://pluskid.lifegoo.com/?p=261
+
+  RMMSeg can be used as either a stand alone program or an Analyser of
+  "Ferret":http://ferret.davebalmain.com/trac.
+
+<% end %>
+
+<% chapter "Setup" do %>
+  <% section "Requirements" do %>
+
+    Your system needs the following software to run RMMSeg.
+
+    |_. Software                  |_. Notes                   |
+    | "Ruby":http://ruby-lang.org | Version 1.8.x is required |
+    | "hoe":http://seattlerb.rubyforge.org/hoe/ | If you want to build the gem manually |
+    | "Rake":http://rake.rubyforge.org/ | If you want to build the gem manually |
+    | "rspec":http://rspec.rubyforge.org/ | If you want to run the testcases |
+
+  <% end %>
+
+  <% section "Installation" do %>
+    <% section "Using RubyGems" do %>
+      To install the gem remotely from "RubyForge":http://rubyforge.org :
+
+        sudo gem install rmmseg
+
+      Or you can download the gem file manually from RubyForge and install it locally:
+
+        sudo gem install --local rmmseg-x.y.z.gem
+
+    <% end %>
+
+    <% section "From Subversion" do %>
+      From subversion repository hosted at "RubyForge":http://rmmseg.rubyforge.org/svn/, you can always get the latest source code.
+      <% note "The latest code might be unstable" do %>
+        Some new features may only be available in the latest code in subversion, but the code might be broken in some cases. So it is recommended to use the released gem package for production.
+      <% end %>
+      To check out the code from Rubyforge, you need to install subversion, then:
+
+        svn checkout http://rmmseg.rubyforge.org/svn/trunk/ rmmseg
+
+      Then you can run
+
+        rake gem
+
+      to build the gem file.
+    <% end %>
+  <% end %>
+<% end %>
+
+<% chapter "Usage" do %>
+   
+  <% section "Stand Alone rmmseg" do %>
+    RMMSeg comes with a script @rmmseg@. To get the basic usage, just execute it with @-h@ option:
+      
+      rmmseg -h
+
+    It reads from STDIN and print result to STDOUT.
+  <% end %>
+
+<% end %>
+
+<% chapter "Resources" do %>
+  * "Project Home":http://rmmseg.rubyforge.org/: The Project page at RubyForge.
+  * "Implementation Details":http://pluskid.lifegoo.com/?p=261: My blog post about the implementation details of RMMSeg.
+  * "Ferret Homepage":http://ferret.davebalmain.com/trac: The homepage of Ferret project.
+<% end %>
+
+<% footer do %>
+  "[Validate]":http://validator.w3.org/check/referer
+<% end %>