[Groonga-commit] groonga/groonga [master] [doc][suggest] add a document about introduction.

Back to archive index

null+****@clear***** null+****@clear*****
2011年 8月 9日 (火) 17:47:27 JST


Kouhei Sutou	2011-08-09 08:47:27 +0000 (Tue, 09 Aug 2011)

  New Revision: 24e8287b4a9d35fde0a27307c08bd0eaf39f474a

  Log:
    [doc][suggest] add a document about introduction.

  Added files:
    doc/source/suggest.txt
    doc/source/suggest/introduction.txt
  Modified files:
    doc/source/index.txt

  Modified: doc/source/index.txt (+1 -0)
===================================================================
--- doc/source/index.txt    2011-08-09 03:47:20 +0000 (63e872a)
+++ doc/source/index.txt    2011-08-09 08:47:27 +0000 (7940ff1)
@@ -18,6 +18,7 @@ groonga ドキュメント
    install
    community
    tutorial
+   suggest
    reference
    spec
    limitations

  Added: doc/source/suggest.txt (+14 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/suggest.txt    2011-08-09 08:47:27 +0000 (30da213)
@@ -0,0 +1,14 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Suggest
+=======
+
+Groonga has suggest feature. This section describes how to use it and how it works.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   suggest/introduction.txt

  Added: doc/source/suggest/introduction.txt (+86 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/suggest/introduction.txt    2011-08-09 08:47:27 +0000 (788aef3)
@@ -0,0 +1,86 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Introduction
+============
+
+The suggest feature in groonga provides the following features:
+
+  * Completion
+  * Correction
+  * Suggestion
+
+Completion
+----------
+
+Completion helps user input. If user inputs a partial word,
+groonga can return complete words from registered
+words.
+
+For example, there are registered words:
+
+  * "groonga"
+  * "complete"
+  * "correction"
+  * "suggest"
+
+An user inputs "co" and groonga returns "complete" and
+"correction" because they starts with "co".
+
+An user inputs "sug" and groonga returns "suggest" because
+"suggest" starts with "sug".
+
+An user inputs "ab" and groonga returns nothing because no
+word starts with "ab".
+
+Correction
+----------
+
+Correction also helps user input. If user inputs a wrong
+word, groonga can return correct words from registered
+correction pairs.
+
+For example, there are registered correction pairs:
+
+| wrong word | correct word |
+| grroonga   | groonga      |
+| gronga     | groonga      |
+| gronnga    | groonga      |
+
+An user inputs "gronga" and groonga returns "groonga" because
+"gronga" is in wrong word and corresponding correct word is
+"groonga".
+
+An user inputs "roonga" and groonga returns nothing because
+"roonga" isn't in wrong word.
+
+Suggest
+-------
+
+Suggest helps that user filters many found documents. If
+user inputs a query, groonga can return new queries that has
+more additional keywords from registered related query
+pairs.
+
+For example, there are registered related query pairs:
+
+| keyword | related query         |
+| groonga | groonga search engine |
+| search  | Google search         |
+| speed   | groonga speed         |
+
+An user inputs "groonga" and groonga returns "groonga search
+engine" because "groonga" is in keyword and related query
+is "groonga search engine".
+
+An user inputs "MySQL" and groonga returns nothing because
+"MySQL" isn't in keyword
+
+Leaning
+-------
+
+The suggest feature requires registered data before using
+the feature. Those data can be registered from user inputs.
+Gronnga-suggest-httpd and groonga-suggest-leaner commands
+are provided for the propose.




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