RubyGems - rroonga - Versions diffs - 3.0.8-x86-mingw32 → 3.0.9-x86-mingw32 - Mend

rroonga 3.0.8-x86-mingw32 → 3.0.9-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (449) hide show

data/vendor/local/share/doc/groonga/en/html/reference/commands/normalize.html CHANGED

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.3.19. normalize &mdash; groonga v3.0.8 documentation</title>
+    <title>8.3.19. normalize &mdash; Groonga v3.0.9 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="../../index.html" />
     <link rel="up" title="8.3. Command" href="../command.html" />
     <link rel="next" title="8.3.20. quit" href="quit.html" />
     <link rel="prev" title="8.3.18. log_reopen" href="log_reopen.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="log_reopen.html" title="8.3.18. log_reopen"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
       </ul>
@@ -86,9 +86,11 @@ It is usefull for you to check the results of normalizer.</p>
 </div>
 <div class="section" id="syntax">
 <h2>8.3.19.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">normalize</span></tt> commands takes two parameters - <tt class="docutils literal"><span class="pre">normalizer</span></tt> and <tt class="docutils literal"><span class="pre">string</span></tt>.
-Both of them are required.</p>
-<div class="highlight-none"><div class="highlight"><pre>normalize normalizer string
+<p><tt class="docutils literal"><span class="pre">normalize</span></tt> commands has two required parameters. They are
+<tt class="docutils literal"><span class="pre">normalizer</span></tt> and <tt class="docutils literal"><span class="pre">string</span></tt>.</p>
+<div class="highlight-none"><div class="highlight"><pre>normalize normalizer
+          string
+          [flags=NONE]
 </pre></div>
 </div>
 </div>
@@ -119,28 +121,103 @@ Both of them are required.</p>
 <p>There are required parameters, <tt class="docutils literal"><span class="pre">normalizer</span></tt> and <tt class="docutils literal"><span class="pre">string</span></tt>.</p>
 <div class="section" id="normalizer">
 <h4>8.3.19.4.1.1. <tt class="docutils literal"><span class="pre">normalizer</span></tt><a class="headerlink" href="#normalizer" title="Permalink to this headline">¶</a></h4>
-<p>It specifies the name of normalizer.
-Currently, <tt class="docutils literal"><span class="pre">normalize</span></tt> command accepts <tt class="docutils literal"><span class="pre">NormalizerAuto</span></tt> or <tt class="docutils literal"><span class="pre">NormalizerNFKC51</span></tt> as built-in normalizer.
-If you want to try another normalizer, you need to register additional normalizer plugin by <tt class="docutils literal"><span class="pre">register</span></tt> command.</p>
+<p>It specifies the normalizer name. <tt class="docutils literal"><span class="pre">normalize</span></tt> command uses the
+normalizer that is named <tt class="docutils literal"><span class="pre">normalizer</span></tt>.</p>
+<p>See <a class="reference internal" href="../normalizers.html"><em>Normalizers</em></a> about built-in normalizers.</p>
+<p>Here is an example to use built-in <tt class="docutils literal"><span class="pre">NormalizerAuto</span></tt> normalizer.</p>
+<p>TODO</p>
+<p>If you want to use other normalizers, you need to register additional
+normalizer plugin by <a class="reference internal" href="register.html"><em>register</em></a> command. For example, you can use
+MySQL compatible normalizer by registering <a class="reference external" href="https://github.com/groonga/groonga-normalizer-mysql">groonga-normalizer-mysql</a>.</p>
 </div>
 <div class="section" id="string">
 <h4>8.3.19.4.1.2. <tt class="docutils literal"><span class="pre">string</span></tt><a class="headerlink" href="#string" title="Permalink to this headline">¶</a></h4>
 <p>It specifies any string which you want to normalize.</p>
+<p>If you want to include spaces in <tt class="docutils literal"><span class="pre">string</span></tt>, you need to quote
+<tt class="docutils literal"><span class="pre">string</span></tt> by single quotation (<tt class="docutils literal"><span class="pre">'</span></tt>) or double quotation (<tt class="docutils literal"><span class="pre">&quot;</span></tt>).</p>
+<p>Here is an example to use spaces in <tt class="docutils literal"><span class="pre">string</span></tt>.</p>
+<p>TODO</p>
+</div>
+</div>
+<div class="section" id="optional-parameters">
+<h3>8.3.19.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There are optional parameters.</p>
+<div class="section" id="flags">
+<h4>8.3.19.4.2.1. <tt class="docutils literal"><span class="pre">flags</span></tt><a class="headerlink" href="#flags" title="Permalink to this headline">¶</a></h4>
+<p>It specifies a normalization customize options. You can specify
+multiple options separated by &quot;<tt class="docutils literal"><span class="pre">|</span></tt>&quot;. For example,
+<tt class="docutils literal"><span class="pre">REMOVE_BLANK|WITH_TYPES</span></tt>.</p>
+<p>Here are available flags.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Flag</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">NONE</span></tt></td>
+<td>Just ignored.</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">REMOVE_BLANK</span></tt></td>
+<td>TODO</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">WITH_TYPES</span></tt></td>
+<td>TODO</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">WITH_CHECKS</span></tt></td>
+<td>TODO</td>
+</tr>
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">REMOVE_TOKENIZED_DELIMITER</span></tt></td>
+<td>TODO</td>
+</tr>
+</tbody>
+</table>
+<p>Here is an example that uses <tt class="docutils literal"><span class="pre">REMOVE_BLANK</span></tt>.</p>
+<p>TODO</p>
+<p>Here is an example that uses <tt class="docutils literal"><span class="pre">WITH_TYPES</span></tt>.</p>
+<p>TODO</p>
+<p>Here is an example that uses <tt class="docutils literal"><span class="pre">REMOVE_TOKENIZED_DELIMITER</span></tt>.</p>
+<p>TODO</p>
 </div>
 </div>
 </div>
 <div class="section" id="return-value">
 <h2>8.3.19.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-none"><div class="highlight"><pre>[HEADER, normalized]
+<div class="highlight-none"><div class="highlight"><pre>[HEADER, normalized_text]
 </pre></div>
 </div>
 <p><tt class="docutils literal"><span class="pre">HEADER</span></tt></p>
 <blockquote>
 <div>The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME].
 See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> about HEADER.</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">normalized</span></tt></p>
+<p><tt class="docutils literal"><span class="pre">normalized_text</span></tt></p>
 <blockquote>
-<div>normalized is the normalized text by the specified normalizer.</div></blockquote>
+<div><p><tt class="docutils literal"><span class="pre">normalized_text</span></tt> is an object that has the following attributes.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><tt class="docutils literal"><span class="pre">normalized</span></tt></td>
+<td>The normalized text.</td>
+</tr>
+<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">types</span></tt></td>
+<td>An array of types of the normalized text. The N-th <tt class="docutils literal"><span class="pre">types</span></tt> shows
+the type of the N-th character in <tt class="docutils literal"><span class="pre">normalized</span></tt>.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
 </div>
 <div class="section" id="see-also">
 <h2>8.3.19.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
@@ -168,6 +245,10 @@ See <a class="reference internal" href="../command/output_format.html"><em>Outpu
 <li><a class="reference internal" href="#string">8.3.19.4.1.2. <tt class="docutils literal"><span class="pre">string</span></tt></a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#optional-parameters">8.3.19.4.2. Optional parameters</a><ul>
+<li><a class="reference internal" href="#flags">8.3.19.4.2.1. <tt class="docutils literal"><span class="pre">flags</span></tt></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li><a class="reference internal" href="#return-value">8.3.19.5. Return value</a></li>
@@ -216,7 +297,7 @@ See <a class="reference internal" href="../command/output_format.html"><em>Outpu
         <li class="right" >
           <a href="log_reopen.html" title="8.3.18. log_reopen"
              >previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/commands/quit.html CHANGED

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.3.20. quit &mdash; groonga v3.0.8 documentation</title>
+    <title>8.3.20. quit &mdash; Groonga v3.0.9 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="../../index.html" />
     <link rel="up" title="8.3. Command" href="../command.html" />
     <link rel="next" title="8.3.21. register" href="register.html" />
     <link rel="prev" title="8.3.19. normalize" href="normalize.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="normalize.html" title="8.3.19. normalize"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
       </ul>
@@ -163,7 +163,7 @@
         <li class="right" >
           <a href="normalize.html" title="8.3.19. normalize"
              >previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/commands/register.html CHANGED

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.3.21. register &mdash; groonga v3.0.8 documentation</title>
+    <title>8.3.21. register &mdash; Groonga v3.0.9 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,7 +25,7 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="../../index.html" />
     <link rel="up" title="8.3. Command" href="../command.html" />
     <link rel="next" title="8.3.22. ruby_eval" href="ruby_eval.html" />
     <link rel="prev" title="8.3.20. quit" href="quit.html" />
@@ -60,7 +60,7 @@
         <li class="right" >
           <a href="quit.html" title="8.3.20. quit"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
       </ul>
@@ -176,7 +176,7 @@ They are completed automatically.</p>
         <li class="right" >
           <a href="quit.html" title="8.3.20. quit"
              >previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/commands/ruby_eval.html CHANGED

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>8.3.22. ruby_eval &mdash; groonga v3.0.8 documentation</title>
+    <title>8.3.22. ruby_eval &mdash; Groonga v3.0.9 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '3.0.8',
+        VERSION:     '3.0.9',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,9 +25,9 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="groonga v3.0.8 documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v3.0.9 documentation" href="../../index.html" />
     <link rel="up" title="8.3. Command" href="../command.html" />
-    <link rel="next" title="8.3.23. select" href="select.html" />
+    <link rel="next" title="8.3.23. ruby_load" href="ruby_load.html" />
     <link rel="prev" title="8.3.21. register" href="register.html" />
   </head>
   <body>
@@ -55,12 +55,12 @@
           <a href="../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="select.html" title="8.3.23. select"
+          <a href="ruby_load.html" title="8.3.23. ruby_load"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="register.html" title="8.3.21. register"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
       </ul>
@@ -75,19 +75,19 @@
 <h1>8.3.22. <tt class="docutils literal"><span class="pre">ruby_eval</span></tt><a class="headerlink" href="#ruby-eval" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
 <h2>8.3.22.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> command evaluates ruby script and returns the result.</p>
+<p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> command evaluates Ruby script and returns the result.</p>
 </div>
 <div class="section" id="syntax">
 <h2>8.3.22.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
 <p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> has one required parameter:</p>
-<div class="highlight-none"><div class="highlight"><pre>ruby_eval ruby_script
+<div class="highlight-none"><div class="highlight"><pre>ruby_eval script
 </pre></div>
 </div>
 </div>
 <div class="section" id="usage">
 <h2>8.3.22.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <p>You can execute any scripts which mruby supports by calling <tt class="docutils literal"><span class="pre">ruby_eval</span></tt>.</p>
-<p>Here is an example that just calculate <tt class="docutils literal"><span class="pre">1</span> <span class="pre">+</span> <span class="pre">2</span></tt> by mruby plugin.</p>
+<p>Here is an example that just calculate <tt class="docutils literal"><span class="pre">1</span> <span class="pre">+</span> <span class="pre">2</span></tt> as Ruby script.</p>
 <p>Execution example:</p>
 <div class="highlight-none"><div class="highlight"><pre>register ruby/eval
 # [[0, 1337566253.89858, 0.000355720520019531], true]
@@ -102,42 +102,26 @@ and the specification may be changed in the future.</p>
 <div class="section" id="parameters">
 <h2>8.3.22.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
 <p>This section describes all parameters.</p>
-<div class="section" id="ruby-script">
-<h3>8.3.22.4.1. <tt class="docutils literal"><span class="pre">ruby_script</span></tt><a class="headerlink" href="#ruby-script" title="Permalink to this headline">¶</a></h3>
-<p>It specifies the ruby script which you want to evaluate.</p>
+<div class="section" id="script">
+<h3>8.3.22.4.1. <tt class="docutils literal"><span class="pre">script</span></tt><a class="headerlink" href="#script" title="Permalink to this headline">¶</a></h3>
+<p>It specifies the Ruby script which you want to evaluate.</p>
 </div>
 </div>
 <div class="section" id="return-value">
 <h2>8.3.22.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> returns the evaluated result which key is &quot;value&quot; as json format:</p>
-<div class="highlight-none"><div class="highlight"><pre>[[HEADER, EVALUATED]]
+<p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> returns the evaluated result with metadata such as
+exception information (Including metadata isn't implemented yet):</p>
+<div class="highlight-none"><div class="highlight"><pre>[HEADER, {&quot;value&quot;: EVALUATED_VALUE}]
 </pre></div>
 </div>
 <p><tt class="docutils literal"><span class="pre">HEADER</span></tt></p>
 <blockquote>
 <div>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> about <tt class="docutils literal"><span class="pre">HEADER</span></tt>.</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">EVALUATED</span></tt></p>
+<p><tt class="docutils literal"><span class="pre">EVALUATED_VALUE</span></tt></p>
 <blockquote>
-<div><p><tt class="docutils literal"><span class="pre">EVALUATED</span></tt> consists of pair of key and value in forms of {key:value}.</p>
-<table border="1" class="docutils">
-<colgroup>
-<col width="50%" />
-<col width="50%" />
-</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Name</th>
-<th class="head">Description</th>
-</tr>
-</thead>
-<tbody valign="top">
-<tr class="row-even"><td><tt class="docutils literal"><span class="pre">key</span></tt></td>
-<td>reserved word 'value'.</td>
-</tr>
-<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">value</span></tt></td>
-<td>the value of evaluated script. It must be a number.</td>
-</tr>
-</tbody>
-</table>
+<div><p><tt class="docutils literal"><span class="pre">EVALUATED_VALUE</span></tt> is the evaludated value of <tt class="docutils literal"><span class="pre">ruby_script</span></tt>.</p>
+<p><tt class="docutils literal"><span class="pre">ruby_eval</span></tt> supports only a number for evaluated value for now.
+Supported types will be increased in the future.</p>
 </div></blockquote>
 </div>
 <div class="section" id="see-also">
@@ -158,7 +142,7 @@ and the specification may be changed in the future.</p>
 <li><a class="reference internal" href="#syntax">8.3.22.2. Syntax</a></li>
 <li><a class="reference internal" href="#usage">8.3.22.3. Usage</a></li>
 <li><a class="reference internal" href="#parameters">8.3.22.4. Parameters</a><ul>
-<li><a class="reference internal" href="#ruby-script">8.3.22.4.1. <tt class="docutils literal"><span class="pre">ruby_script</span></tt></a></li>
+<li><a class="reference internal" href="#script">8.3.22.4.1. <tt class="docutils literal"><span class="pre">script</span></tt></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#return-value">8.3.22.5. Return value</a></li>
@@ -171,8 +155,8 @@ and the specification may be changed in the future.</p>
   <p class="topless"><a href="register.html"
                         title="previous chapter">8.3.21. register</a></p>
   <h4>Next topic</h4>
-  <p class="topless"><a href="select.html"
-                        title="next chapter">8.3.23. <tt class="docutils literal"><span class="pre">select</span></tt></a></p>
+  <p class="topless"><a href="ruby_load.html"
+                        title="next chapter">8.3.23. <tt class="docutils literal"><span class="pre">ruby_load</span></tt></a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
     <li><a href="../../_sources/reference/commands/ruby_eval.txt"
@@ -202,12 +186,12 @@ and the specification may be changed in the future.</p>
           <a href="../../genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="select.html" title="8.3.23. select"
+          <a href="ruby_load.html" title="8.3.23. ruby_load"
              >next</a> |</li>
         <li class="right" >
           <a href="register.html" title="8.3.21. register"
              >previous</a> |</li>
-        <li><a href="../../index.html">groonga v3.0.8 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
           <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
           <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
       </ul>

data/vendor/local/share/doc/groonga/en/html/reference/commands/ruby_load.html ADDED

@@ -0,0 +1,196 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>8.3.23. ruby_load &mdash; Groonga v3.0.9 documentation</title>
+    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '3.0.9',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+    <link rel="top" title="Groonga v3.0.9 documentation" href="../../index.html" />
+    <link rel="up" title="8.3. Command" href="../command.html" />
+    <link rel="next" title="8.3.24. select" href="select.html" />
+    <link rel="prev" title="8.3.22. ruby_eval" href="ruby_eval.html" />
+  </head>
+  <body>
+<div class="header">
+  <h1 class="title">
+    <a id="top-link" href="../../index.html">
+      <span class="project">groonga</span>
+      <span class="separator">-</span>
+      <span class="description">An open-source fulltext search engine and column store.</span>
+    </a>
+  </h1>
+  <div class="other-language-links">
+    <ul>
+      <li><a href="../../../../ja/html/reference/commands/ruby_load.html"><img src="../../_static/jp.png" alt="日本語">日本語版はこちら</a></li>
+    </ul>
+  </div>
+</div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="select.html" title="8.3.24. select"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="ruby_eval.html" title="8.3.22. ruby_eval"
+             accesskey="P">previous</a> |</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" accesskey="U">8.3. Command</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+  <div class="section" id="ruby-load">
+<h1>8.3.23. <tt class="docutils literal"><span class="pre">ruby_load</span></tt><a class="headerlink" href="#ruby-load" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="summary">
+<h2>8.3.23.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">ruby_load</span></tt> command loads specified Ruby script.</p>
+</div>
+<div class="section" id="syntax">
+<h2>8.3.23.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">ruby_load</span></tt> has one required parameter:</p>
+<div class="highlight-none"><div class="highlight"><pre>ruby_load path
+</pre></div>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>8.3.23.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>You can load any script file which mruby supports by calling <tt class="docutils literal"><span class="pre">ruby_load</span></tt>.</p>
+<p>Here is an example that just load <tt class="docutils literal"><span class="pre">expression.rb</span></tt> as Ruby script.</p>
+<p>Register <tt class="docutils literal"><span class="pre">ruby/load</span></tt> plugin to use <tt class="docutils literal"><span class="pre">ruby_load</span></tt> command in advance.</p>
+<p>Note that <tt class="docutils literal"><span class="pre">ruby_load</span></tt> is implemented as an experimental plugin,
+and the specification may be changed in the future.</p>
+</div>
+<div class="section" id="parameters">
+<h2>8.3.23.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<p>This section describes all parameters.</p>
+<div class="section" id="path">
+<h3>8.3.23.4.1. <tt class="docutils literal"><span class="pre">path</span></tt><a class="headerlink" href="#path" title="Permalink to this headline">¶</a></h3>
+<p>It specifies the Ruby script path which you want to load.</p>
+</div>
+</div>
+<div class="section" id="return-value">
+<h2>8.3.23.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<p><tt class="docutils literal"><span class="pre">ruby_load</span></tt> returns the loaded result with metadata such as
+exception information (Including metadata isn't implemented yet):</p>
+<div class="highlight-none"><div class="highlight"><pre>[HEADER, {&quot;value&quot;: LOADED_VALUE}]
+</pre></div>
+</div>
+<p><tt class="docutils literal"><span class="pre">HEADER</span></tt></p>
+<blockquote>
+<div>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> about <tt class="docutils literal"><span class="pre">HEADER</span></tt>.</div></blockquote>
+<p><tt class="docutils literal"><span class="pre">LOADED_VALUE</span></tt></p>
+<blockquote>
+<div><p><tt class="docutils literal"><span class="pre">LOADED_VALUE</span></tt> is the loaded value of ruby script.</p>
+<p><tt class="docutils literal"><span class="pre">ruby_load</span></tt> just return <tt class="docutils literal"><span class="pre">null</span></tt> as <tt class="docutils literal"><span class="pre">LOADED_VALUE</span></tt> for now, it will be supported in the future.</p>
+</div></blockquote>
+</div>
+<div class="section" id="see-also">
+<h2>8.3.23.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference internal" href="ruby_eval.html"><em>ruby_eval</em></a></p>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">8.3.23. <tt class="docutils literal"><span class="pre">ruby_load</span></tt></a><ul>
+<li><a class="reference internal" href="#summary">8.3.23.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">8.3.23.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">8.3.23.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">8.3.23.4. Parameters</a><ul>
+<li><a class="reference internal" href="#path">8.3.23.4.1. <tt class="docutils literal"><span class="pre">path</span></tt></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#return-value">8.3.23.5. Return value</a></li>
+<li><a class="reference internal" href="#see-also">8.3.23.6. See also</a></li>
+</ul>
+</li>
+</ul>
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="ruby_eval.html"
+                        title="previous chapter">8.3.22. <tt class="docutils literal docutils literal docutils literal docutils literal"><span class="pre">ruby_eval</span></tt></a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="select.html"
+                        title="next chapter">8.3.24. <tt class="docutils literal"><span class="pre">select</span></tt></a></p>
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="../../_sources/reference/commands/ruby_load.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="select.html" title="8.3.24. select"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="ruby_eval.html" title="8.3.22. ruby_eval"
+             >previous</a> |</li>
+        <li><a href="../../index.html">Groonga v3.0.9 documentation</a> &raquo;</li>
+          <li><a href="../../reference.html" >8. リファレンスマニュアル</a> &raquo;</li>
+          <li><a href="../command.html" >8.3. Command</a> &raquo;</li>
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2009-2013, Brazil, Inc.
+    </div>
+  </body>
+</html>