Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > e450e7f3d6075c4a54de19e68d38177f > files > 262

groonga-doc-3.0.5-1.fc18.x86_64.rpm


<!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.19. normalize &mdash; groonga v3.0.5 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.5',
        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.5 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" /> 
  </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/normalize.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="quit.html" title="8.3.20. quit"
             accesskey="N">next</a> |</li>
        <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.5 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="normalize">
<h1>8.3.19. <tt class="docutils literal"><span class="pre">normalize</span></tt><a class="headerlink" href="#normalize" title="Permalink to this headline">¶</a></h1>
<div class="admonition caution">
<p class="first admonition-title">Caution</p>
<p class="last"><tt class="docutils literal"><span class="pre">normalize</span></tt> command is the experimental feature.
This command may be changed in the future.</p>
</div>
<div class="section" id="summary">
<h2>8.3.19.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">normalize</span></tt> command normalizes text by the specified normalizer.</p>
<p>There is no need to create table to use <tt class="docutils literal"><span class="pre">normalize</span></tt> command.
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
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>8.3.19.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Here is a simple example of <tt class="docutils literal"><span class="pre">normalize</span></tt> command.</p>
<p>Execution example:</p>
<div class="highlight-none"><div class="highlight"><pre>normalize NormalizerAuto &quot;aBcDe 123&quot;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   {
#     &quot;normalized&quot;: &quot;abcde 123&quot;,
#     &quot;types&quot;: []
#   }
# ]
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h2>8.3.19.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>This section describes parameters of <tt class="docutils literal"><span class="pre">normalizer</span></tt>.</p>
<div class="section" id="required-parameter">
<h3>8.3.19.4.1. Required parameter<a class="headerlink" href="#required-parameter" title="Permalink to this headline">¶</a></h3>
<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>
</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>
</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]
</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>
<blockquote>
<div>normalized is the normalized text by the specified normalizer.</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>
<ul class="simple">
<li><a class="reference internal" href="../normalizers.html"><em>Normalizers</em></a></li>
</ul>
</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.19. <tt class="docutils literal"><span class="pre">normalize</span></tt></a><ul>
<li><a class="reference internal" href="#summary">8.3.19.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">8.3.19.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">8.3.19.3. Usage</a></li>
<li><a class="reference internal" href="#parameters">8.3.19.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameter">8.3.19.4.1. Required parameter</a><ul>
<li><a class="reference internal" href="#normalizer">8.3.19.4.1.1. <tt class="docutils literal"><span class="pre">normalizer</span></tt></a></li>
<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>
</ul>
</li>
<li><a class="reference internal" href="#return-value">8.3.19.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">8.3.19.6. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="log_reopen.html"
                        title="previous chapter">8.3.18. log_reopen</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="quit.html"
                        title="next chapter">8.3.20. quit</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/reference/commands/normalize.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="quit.html" title="8.3.20. quit"
             >next</a> |</li>
        <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.5 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>