Kouhei Sutou
null+****@clear*****
Tue Nov 24 18:37:03 JST 2015
Kouhei Sutou 2015-11-24 18:37:03 +0900 (Tue, 24 Nov 2015) New Revision: 9950aa9e77d89988d0f9ce6fa41543bdfb18bd15 https://github.com/groonga/groonga/commit/9950aa9e77d89988d0f9ce6fa41543bdfb18bd15 Message: doc: add document about prefix RK search Added files: doc/source/reference/operations/prefix_rk_search.rst Modified files: doc/source/reference/operations.rst doc/source/reference/suggest/completion.rst Modified: doc/source/reference/operations.rst (+3 -2) =================================================================== --- doc/source/reference/operations.rst 2015-11-24 17:51:58 +0900 (5874fb6) +++ doc/source/reference/operations.rst 2015-11-24 18:37:03 +0900 (147729e) @@ -10,6 +10,7 @@ Groonga has the multiple search operations. This section describes about search operations. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :glob: - operations/geolocation_search + operations/* Added: doc/source/reference/operations/prefix_rk_search.rst (+50 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/operations/prefix_rk_search.rst 2015-11-24 18:37:03 +0900 (8f34ecb) @@ -0,0 +1,50 @@ +.. -*- rst -*- + +.. highlightlang:: none + +Prefix RK search +================ + +Summary +------- + +Groonga supports prefix RK search. RK means Romaji and Kana. +Prefix RK search can find registered text in katakana by query in +romaji, hiragana or katakana. Found registered texts are started with +query. + +Prefix RK search is useful for completing Japanese text. Because +romaji is widely used to input Japanese on computer. See also +`Japanese input methods on Wikipedia +<https://en.wikipedia.org/wiki/Japanese_input_methods>`_. + +If users can search Japanese text in romaji, users doesn't need to +convert romaji to hiragana, katakana or kanji by themselves. For +example, if you register a reading for "日本" as "ニホン", users can +find "日本" by "ni", "に" or "二". + +The feature is helpful because it reduces one or more operations of +users. + +This feature is used in :doc:`/reference/suggest/complete`. + +You can use this feature in :ref:`select-filter` by +:doc:`/reference/functions/prefix_rk_search`. + +How to convert romaji to kana +----------------------------- + +Prefix RK search is based on JIS X 4063:2000 specification. + +The specification was obsoleted. See `ローマ字入力 on Japanese +Wikipedia +<https://ja.wikipedia.org/wiki/%E3%83%AD%E3%83%BC%E3%83%9E%E5%AD%97%E5%85%A5%E5%8A%9B>`_ +for JIS X 4063:2000. + +Normally, you can get converted results as expected. + +See also +-------- + + * :doc:`/reference/suggest/complete` + * :doc:`/reference/functions/prefix_rk_search` Modified: doc/source/reference/suggest/completion.rst (+2 -7) =================================================================== --- doc/source/reference/suggest/completion.rst 2015-11-24 17:51:58 +0900 (9e0d126) +++ doc/source/reference/suggest/completion.rst 2015-11-24 18:37:03 +0900 (5eb60cb) @@ -29,13 +29,8 @@ completed words: Prefix RK search ^^^^^^^^^^^^^^^^ -RK means Romaji and Katakana. Prefix RK search can find -registered words that start with user's input by romaji, -katakana or hiragana. It's useful for searching in Japanese. - -For example, there is a registered word "日本". And "ニホン" -(it must be katakana) is registered as its reading. An user -can find "日本" by "ni", "二" or "に". +See :doc:`/reference/operations/prefix_rk_search` for prefix RK +search. If you create dataset which is named as ``example`` by :doc:`/reference/executables/groonga-suggest-create-dataset` -------------- next part -------------- HTML����������������������������...Télécharger
