Navigation Menu

Skip to content

Commit

Permalink
Update Groonga documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@kou
kou committed Oct 6, 2015
1 parent 249d2ac commit 48a8d6d
Show file tree
Hide file tree
Showing 8 changed files with 290 additions and 38 deletions.
18 changes: 9 additions & 9 deletions docs/reference/query_expanders/tsv.html
View file
Expand Up @@ -100,15 +100,15 @@ <h2>7.10.1.1. Summary<a class="headerlink" href="#summary" title="Permalink to t
<h2>7.10.1.2. Install<a class="headerlink" href="#install" title="Permalink to this headline"></a></h2>
<p>You need to register <code class="docutils literal"><span class="pre">query_expanders/tsv</span></code> as a plugin before you
use <code class="docutils literal"><span class="pre">QueryExpanderTSV</span></code>:</p>
<div class="highlight-none"><div class="highlight"><pre>register query_expanders/tsv
<div class="highlight-none"><div class="highlight"><pre>plugin_register query_expanders/tsv
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>7.10.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>You just add <code class="docutils literal"><span class="pre">--query_expansion</span> <span class="pre">QueryExpanderTSV</span></code> parameter to
<p>You just add <code class="docutils literal"><span class="pre">--query_expander</span> <span class="pre">QueryExpanderTSV</span></code> parameter to
<code class="docutils literal"><span class="pre">select</span></code> command:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;QUERY&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;QUERY&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>If <code class="docutils literal"><span class="pre">QUERY</span></code> has registered synonyms, they are expanded. For example,
Expand Down Expand Up @@ -141,20 +141,20 @@ <h2>7.10.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this
<code class="docutils literal"><span class="pre">groonga</span></code>. And <code class="docutils literal"><span class="pre">mroonga</span></code> and <code class="docutils literal"><span class="pre">groonga</span> <span class="pre">MySQL</span></code> are synonyms of
<code class="docutils literal"><span class="pre">mroonga</span></code>.</p>
<p>Here is an example of query expnasion that uses <code class="docutils literal"><span class="pre">groonga</span></code> as query:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>The above command equals to the following command:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga OR Senna&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga OR Senna&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>Here is another example of query expnasion that uses <code class="docutils literal"><span class="pre">mroonga</span>
<span class="pre">search</span></code> as query:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;mroonga search&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;mroonga search&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>The above command equals to the following command:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;(mroonga OR (groonga MySQL)) search&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;(mroonga OR (groonga MySQL)) search&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>It is important that registered words (<code class="docutils literal"><span class="pre">groonga</span></code> and <code class="docutils literal"><span class="pre">mroonga</span></code>)
Expand Down Expand Up @@ -187,11 +187,11 @@ <h2>7.10.1.3. Usage<a class="headerlink" href="#usage" title="Permalink to this
<p><code class="docutils literal"><span class="pre">gronga</span></code> in <code class="docutils literal"><span class="pre">word</span></code> has a typo. A <code class="docutils literal"><span class="pre">o</span></code> is missing. <code class="docutils literal"><span class="pre">groonga</span></code> in
<code class="docutils literal"><span class="pre">synonym</span></code> is the correct word.</p>
<p>Here is an example of using query expnasion as spelling correction:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;gronga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;gronga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>The above command equals to the following command:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>The former command has a typo in <code class="docutils literal"><span class="pre">--query</span></code> value but the latter
Expand Down
18 changes: 9 additions & 9 deletions docs/sources/reference/query_expanders/tsv.txt
View file
Expand Up @@ -22,15 +22,15 @@ Install
You need to register ``query_expanders/tsv`` as a plugin before you
use ``QueryExpanderTSV``::

register query_expanders/tsv
plugin_register query_expanders/tsv

Usage
-----

You just add ``--query_expansion QueryExpanderTSV`` parameter to
You just add ``--query_expander QueryExpanderTSV`` parameter to
``select`` command::

select --query "QUERY" --query_expansion QueryExpanderTSV
select --query "QUERY" --query_expander QueryExpanderTSV

If ``QUERY`` has registered synonyms, they are expanded. For example,
there are the following synonyms.
Expand All @@ -50,20 +50,20 @@ The table means that ``synonym 1`` and ``synonym 2`` are synonyms of

Here is an example of query expnasion that uses ``groonga`` as query::

select --query "groonga" --query_expansion QueryExpanderTSV
select --query "groonga" --query_expander QueryExpanderTSV

The above command equals to the following command::

select --query "groonga OR Senna" --query_expansion QueryExpanderTSV
select --query "groonga OR Senna" --query_expander QueryExpanderTSV

Here is another example of query expnasion that uses ``mroonga
search`` as query::

select --query "mroonga search" --query_expansion QueryExpanderTSV
select --query "mroonga search" --query_expander QueryExpanderTSV

The above command equals to the following command::

select --query "(mroonga OR (groonga MySQL)) search" --query_expansion QueryExpanderTSV
select --query "(mroonga OR (groonga MySQL)) search" --query_expander QueryExpanderTSV

It is important that registered words (``groonga`` and ``mroonga``)
are only expanded to synonyms and not registered words (``search``)
Expand All @@ -89,11 +89,11 @@ synonyms.

Here is an example of using query expnasion as spelling correction::

select --query "gronga" --query_expansion QueryExpanderTSV
select --query "gronga" --query_expander QueryExpanderTSV

The above command equals to the following command::

select --query "groonga" --query_expansion QueryExpanderTSV
select --query "groonga" --query_expander QueryExpanderTSV

The former command has a typo in ``--query`` value but the latter
command doesn't have any typos.
Expand Down
126 changes: 126 additions & 0 deletions docs/static/groonga.css
View file
Expand Up @@ -19,6 +19,15 @@ body
padding: 0px;
}

@media screen and (max-width: 640px)
{
html,
body
{
margin: 0;
}
}

body
{
font-family: sans-serif;
Expand All @@ -41,6 +50,16 @@ div.header h1.title
margin: 20px;
}

@media screen and (max-width: 640px)
{
div.header h1.title
{
margin: 0;
margin-top: 5px;
margint-left: 5px;
}
}

div.header h1.title a,
div.header h1.title a:link,
div.header h1.title a:visited
Expand All @@ -64,6 +83,15 @@ div.header h1.title a
border: 1px solid #FFF;
}

@media screen and (max-width: 640px)
{
div.header h1.title a
{
height: auto;
margin-bottom: 5px;
}
}

div.header h1.title span
{
}
Expand All @@ -81,6 +109,17 @@ div.header h1.title span.description
margin: 35px 0 0 240px;
}

@media screen and (max-width: 640px)
{
div.header h1.title span.description
{
margin-top: 75px;
margin-bottom: 0;
margin-left: 5px;
margin-right: 5px;
}
}

div.header div.facebook-buttons
{
position: absolute;
Expand All @@ -98,6 +137,14 @@ div.header div.facebook-buttons
overflow: hidden;
}

@media screen and (max-width: 640px)
{
div.header div.facebook-buttons
{
display: none;
}
}

div.header div.other-language-links
{
position: absolute;
Expand All @@ -106,6 +153,14 @@ div.header div.other-language-links
font-size: small;
}

@media screen and (max-width: 640px)
{
div.header div.other-language-links
{
right: 5px;
}
}

div.header div.other-language-links ul,
div.header div.other-language-links li
{
Expand Down Expand Up @@ -139,6 +194,15 @@ div.documentwrapper
width: 100%;
}

@media screen and (max-width: 640px)
{
div.documentwrapper
{
float: none;
width: auto;
}
}

div.bodywrapper
{
background-color: #FAFAFA;
Expand All @@ -150,6 +214,16 @@ div.bodywrapper
margin-bottom: 10px;
}

@media screen and (max-width: 640px)
{
div.bodywrapper
{
border-width: 0;
padding: 0;
margin: 0;
}
}

div.body
{
background-color: #ffffff;
Expand All @@ -158,6 +232,16 @@ div.body
padding-top: 10px;
}

@media screen and (max-width: 640px)
{
div.body
{
padding: 0;
padding-left: 5px;
padding-right: 5px;
}
}

div.body h1,
div.body h2,
div.body h3,
Expand Down Expand Up @@ -187,6 +271,15 @@ div.body h1
margin-top: 0;
}

@media screen and (max-width: 640px)
{
div.body h1
{
margin: 0;
padding-left: 10px;
}
}

div.body h2
{
font-size: large;
Expand Down Expand Up @@ -286,6 +379,23 @@ div.related li
margin-left:20px;
}

@media screen and (max-width: 640px)
{
div.related ul
{
padding-top: 5px;
padding-bottom: 5px;
padding-left: 5px;
padding-right: 5px;
line-height: 1.5em;
}

div.related li
{
margin-left: 0;
}
}

div.related a,
div.related a:link,
div.related a:visited,
Expand Down Expand Up @@ -339,6 +449,14 @@ div.sphinxsidebar
float: right;
}

@media screen and (max-width: 640px)
{
div.sphinxsidebar
{
display: none;
}
}

div.sphinxsidebar h3
{
font-family: sans-serif;
Expand Down Expand Up @@ -465,6 +583,14 @@ pre
word-wrap: normal;
}

@media screen and (max-width: 640px)
{
pre
{
padding: 5px;
}
}

tt
{
background-color: #ecf0f3;
Expand Down
2 changes: 1 addition & 1 deletion ja/docs/news.html
View file
Expand Up @@ -130,7 +130,7 @@ <h3>改良<a class="headerlink" href="#improvements" title="このヘッドラ
</li>
<li><p class="first">[<code class="docutils literal"><span class="pre">grn_obj_cast()</span></code>] 公開しました。</p>
</li>
<li><p class="first">[実験的][<code class="docutils literal"><span class="pre">grn_ii_cursor</span></code>] 公開ました。</p>
<li><p class="first">[実験的][<code class="docutils literal"><span class="pre">grn_ii_cursor</span></code>] 公開しました。</p>
</li>
<li><p class="first">[実験的][<code class="docutils literal"><span class="pre">grn_ii_cursor_open()</span></code>] 公開しました。</p>
</li>
Expand Down
18 changes: 9 additions & 9 deletions ja/docs/reference/query_expanders/tsv.html
View file
Expand Up @@ -94,14 +94,14 @@ <h2>7.10.1.1. 概要<a class="headerlink" href="#summary" title="このヘッド
<div class="section" id="install">
<h2>7.10.1.2. インストール<a class="headerlink" href="#install" title="このヘッドラインへのパーマリンク"></a></h2>
<p><code class="docutils literal"><span class="pre">QueryExpanderTSV</span></code> を使う前に <code class="docutils literal"><span class="pre">query_expanders/tsv</span></code> をプラグインとして登録します:</p>
<div class="highlight-none"><div class="highlight"><pre>register query_expanders/tsv
<div class="highlight-none"><div class="highlight"><pre>plugin_register query_expanders/tsv
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>7.10.1.3. 使い方<a class="headerlink" href="#usage" title="このヘッドラインへのパーマリンク"></a></h2>
<p><code class="docutils literal"><span class="pre">select</span></code> コマンドに <code class="docutils literal"><span class="pre">--query_expansion</span> <span class="pre">QueryExpanderTSV</span></code> パラメーターを追加します:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;QUERY&quot; --query_expansion QueryExpanderTSV
<p><code class="docutils literal"><span class="pre">select</span></code> コマンドに <code class="docutils literal"><span class="pre">--query_expander</span> <span class="pre">QueryExpanderTSV</span></code> パラメーターを追加します:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;QUERY&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">QUERY</span></code> 内に登録済みの同義語がある場合はそれらが展開されます。例えば、以下の同義語があるとします。</p>
Expand Down Expand Up @@ -133,19 +133,19 @@ <h2>7.10.1.3. 使い方<a class="headerlink" href="#usage" title="このヘッ
</table>
<p>この表は、 <code class="docutils literal"><span class="pre">単語</span></code> の同義語は <code class="docutils literal"><span class="pre">同義語1</span></code> と <code class="docutils literal"><span class="pre">同義語2</span></code> という意味です。例えば、 <code class="docutils literal"><span class="pre">groonga</span></code> の同義語は <code class="docutils literal"><span class="pre">groonga</span></code> と <code class="docutils literal"><span class="pre">Senna</span></code> です。また、 <code class="docutils literal"><span class="pre">mroonga</span></code> の同義語は <code class="docutils literal"><span class="pre">mroonga</span></code> と <code class="docutils literal"><span class="pre">groonga</span> <span class="pre">MySQL</span></code> です。</p>
<p>クエリーが <code class="docutils literal"><span class="pre">groonga</span></code> のときのクエリー展開の例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga OR Senna&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga OR Senna&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>クエリーが <code class="docutils literal"><span class="pre">mroonga</span> <span class="pre">search</span></code> のときのクエリー展開の例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;mroonga search&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;mroonga search&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;(mroonga OR (groonga MySQL)) search&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;(mroonga OR (groonga MySQL)) search&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>登録されている単語だけ（ここでは <code class="docutils literal"><span class="pre">groonga</span></code> と <code class="docutils literal"><span class="pre">mroonga</span></code> ）クエリー展開されて、登録されていない単語（ここでは <code class="docutils literal"><span class="pre">search</span></code> ）はクエリー展開されていないことが大事なポイントです。また、再帰的にクエリー展開しません。クエリー展開した結果の <code class="docutils literal"><span class="pre">(mroonga</span> <span class="pre">OR</span> <span class="pre">(groonga</span> <span class="pre">MySQL))</span></code> の中に <code class="docutils literal"><span class="pre">groonga</span></code> がありますが、これは展開されません。</p>
Expand All @@ -170,11 +170,11 @@ <h2>7.10.1.3. 使い方<a class="headerlink" href="#usage" title="このヘッ
</table>
<p><code class="docutils literal"><span class="pre">単語</span></code> の <code class="docutils literal"><span class="pre">gronga</span></code> には誤字があります。 <code class="docutils literal"><span class="pre">o</span></code> がひとつ足りません。 <code class="docutils literal"><span class="pre">同義語</span></code> の <code class="docutils literal"><span class="pre">groonga</span></code> が正しい単語です。</p>
<p>スペル訂正機能としてクエリー展開機能を使う例です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;gronga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;gronga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>上記のコマンドは以下のコマンドと同じ意味です:</p>
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expansion QueryExpanderTSV
<div class="highlight-none"><div class="highlight"><pre>select --query &quot;groonga&quot; --query_expander QueryExpanderTSV
</pre></div>
</div>
<p>前者のコマンドは <code class="docutils literal"><span class="pre">--query</span></code> の値に誤字がありますが、後者のコマンドは誤字がありません。</p>
Expand Down
2 changes: 1 addition & 1 deletion ja/docs/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 48a8d6d

Please sign in to comment.