[Groonga-commit] groonga/groonga [master] [doc][suggest] update to the latest information.

Back to archive index

null+****@clear***** null+****@clear*****
2011年 8月 17日 (水) 13:23:36 JST


Kouhei Sutou	2011-08-17 04:23:36 +0000 (Wed, 17 Aug 2011)

  New Revision: ef7ff2525f8a80cd7fcf4169c64e02c7332988ad

  Log:
    [doc][suggest] update to the latest information.

  Modified files:
    doc/source/commands/suggest.txt
    doc/source/suggest.txt

  Modified: doc/source/commands/suggest.txt (+67 -27)
===================================================================
--- doc/source/commands/suggest.txt    2011-08-17 00:34:51 +0000 (7bab85d)
+++ doc/source/commands/suggest.txt    2011-08-17 04:23:36 +0000 (bb8aa72)
@@ -5,62 +5,102 @@
 suggest
 =======
 
-** 未だ仕様は確定しておりません。利用のためには特定のデータを持つテーブルが必要となります。 **
+.. note::
 
-名前
+   The suggest feature specification isn't stable. The
+   specification may be changed.
+
+NAME
 ----
 
-suggest - 指定したクエリに対する補完・修正・提案を行う。
+suggest - returns completion, correction and/or suggestion for a query.
 
-書式
-----
+SYNOPSIS
+--------
 ::
 
- suggest types table column query
+ suggest types table column query [sortby [output_columns [offset [limit [threshold [prefix_search]]]]]]
 
-説明
-----
+DESCRIPTION
+-----------
 
-suggestコマンドは、指定したクエリに対して補完・修正・提案を行います。
+The suggest command returns completion, correction and/or
+suggestion for a specified query.
 
-補完とは、クエリの未入力・未変換部分を補うことです。修正とは、クエリ内のミスタイプや誤変換を修正することです。提案とは、さらなる絞込みを行うための候補となるクエリを提案することです。
+See :doc:`/suggest/introduction` about completion,
+correction and suggestion.
 
-引数
-----
+OPTIONS
+-------
 
 ``types``
+  It specifies what types are returned by the suggest
+  command.
+
+  Here are available types:
+
+    ``complete``
+      The suggest command does completion.
+
+    ``correct``
+      The suggest command does correction.
+
+    ``suggest``
+      The suggest command does suggestion.
 
-  補完・修正・提案のいずれを行うかを、パイプ('|')で組み合わせたシンボル名で指定します(例: correct|suggest)
+  You can specify one or more types separated by ``|``.
+  Here are examples:
 
-  ``complete``
+    It returns correction::
 
-    補完を行います。
+      correct
 
-  ``correct``
+    It returns correction and suggestion::
 
-    修正を行います。
+      correct|suggest
 
-  ``suggest``
+    It returns complete, correction and suggestion::
 
-    提案を行います。
+      complete|correct|suggest
 
 ``table``
+  It specifies table name that has ``item_${DATA_SET_NAME}` format.
+  For example, ``item_shops`` is a table name if you created
+  dataset by the following command::
 
-  基礎となるデータが格納されているテーブル名を指定します。
+    groonga-suggest-create-dataset /tmp/db-path shops
 
 ``column``
-
-  基礎となるデータが格納されているテーブルにおいて、「ヨミガナ」が格納されているカラム名を指定します。
+  It specifies a column name that has furigana in
+  Katakana in ``table`` table.
 
 ``query``
+  It specifies query for completion, correction and/or
+  suggestion.
 
-  補完・修正・提案の対象となるクエリを指定します。
+``sortby``
+  TODO
 
-返値
-----
+``output_columns``
+  TODO
+
+``offset``
+  TODO
+
+``limit``
+  TODO
+
+``threshold``
+  TODO
+
+``prefix_search``
+  TODO
+
+RETURN VALUE
+------------
 
-json形式
-^^^^^^^^
+JSON Format
+^^^^^^^^^^^
 
 ::
 

  Modified: doc/source/suggest.txt (+5 -0)
===================================================================
--- doc/source/suggest.txt    2011-08-17 00:34:51 +0000 (ca7406c)
+++ doc/source/suggest.txt    2011-08-17 04:23:36 +0000 (80a513b)
@@ -5,6 +5,11 @@
 Suggest
 =======
 
+.. note::
+
+   The suggest feature specification isn't stable. The
+   specification may be changed.
+
 Groonga has the suggest feature. This section describes how to use it and how it works.
 
 .. toctree::




Groonga-commit メーリングリストの案内
Back to archive index