naoa
null+****@clear*****
Fri May 23 21:57:05 JST 2014
naoa 2014-05-23 21:57:05 +0900 (Fri, 23 May 2014) New Revision: b02a1389757499c934b39e27d41298221a44ddd2 https://github.com/groonga/groonga/commit/b02a1389757499c934b39e27d41298221a44ddd2 Merged 839dca8: Merge pull request #171 from naoa/add-proc-get-type Message: doc:add tokenizer list command and normalizer_list command TODO: Translate it in doc/locale/ja/LC_MESSAGES/reference.po Translate it in doc/locale/en/LC_MESSAGES/reference.po Added files: doc/source/example/reference/commands/normalizer_list/simple_example.log doc/source/example/reference/commands/tokenizer_list/simple_example.log doc/source/reference/commands/normalizer_list.rst doc/source/reference/commands/tokenizer_list.rst Modified files: doc/files.am Modified: doc/files.am (+10 -0) =================================================================== --- doc/files.am 2014-05-23 21:56:06 +0900 (60199a4) +++ doc/files.am 2014-05-23 21:57:05 +0900 (c99d8b7) @@ -42,6 +42,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/delete/cascade.log \ $(top_srcdir)/doc/source/example/reference/commands/delete/status.log \ $(top_srcdir)/doc/source/example/reference/commands/normalize/normalizer_auto_ascii.log \ + $(top_srcdir)/doc/source/example/reference/commands/normalizer_list/simple_example.log \ $(top_srcdir)/doc/source/example/reference/commands/register/query_expanders_tsv.log \ $(top_srcdir)/doc/source/example/reference/commands/ruby_eval/calc.log \ $(top_srcdir)/doc/source/example/reference/commands/ruby_load/load.log \ @@ -101,6 +102,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/example/reference/commands/tokenize/simple_example.log \ $(top_srcdir)/doc/source/example/reference/commands/tokenize/string_include_spaces.log \ $(top_srcdir)/doc/source/example/reference/commands/tokenize/tokenizer_token_trigram.log \ + $(top_srcdir)/doc/source/example/reference/commands/tokenizer_list/simple_example.log \ $(top_srcdir)/doc/source/example/reference/commands/truncate/truncate.log \ $(top_srcdir)/doc/source/example/reference/executables/groonga-httpd.log \ $(top_srcdir)/doc/source/example/reference/functions/between/usage_age.log \ @@ -427,6 +429,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/commands/log_put.rst \ $(top_srcdir)/doc/source/reference/commands/log_reopen.rst \ $(top_srcdir)/doc/source/reference/commands/normalize.rst \ + $(top_srcdir)/doc/source/reference/commands/normalizer_list.rst \ $(top_srcdir)/doc/source/reference/commands/quit.rst \ $(top_srcdir)/doc/source/reference/commands/register.rst \ $(top_srcdir)/doc/source/reference/commands/ruby_eval.rst \ @@ -439,6 +442,7 @@ absolute_source_files = \ $(top_srcdir)/doc/source/reference/commands/table_list.rst \ $(top_srcdir)/doc/source/reference/commands/table_remove.rst \ $(top_srcdir)/doc/source/reference/commands/tokenize.rst \ + $(top_srcdir)/doc/source/reference/commands/tokenizer_list.rst \ $(top_srcdir)/doc/source/reference/commands/truncate.rst \ $(top_srcdir)/doc/source/reference/example/reference/executables/groonga-suggest-httpd-launch.log \ $(top_srcdir)/doc/source/reference/example/reference/executables/groonga-suggest-httpd-setup.log \ @@ -951,6 +955,7 @@ source_files_relative_from_doc_dir = \ source/reference/commands/log_put.rst \ source/reference/commands/log_reopen.rst \ source/reference/commands/normalize.rst \ + source/reference/commands/normalizer_list.rst \ source/reference/commands/quit.rst \ source/reference/commands/register.rst \ source/reference/commands/ruby_eval.rst \ @@ -963,6 +968,7 @@ source_files_relative_from_doc_dir = \ source/reference/commands/table_list.rst \ source/reference/commands/table_remove.rst \ source/reference/commands/tokenize.rst \ + source/reference/commands/tokenizer_list.rst \ source/reference/commands/truncate.rst \ source/reference/example/reference/executables/groonga-suggest-httpd-launch.log \ source/reference/example/reference/executables/groonga-suggest-httpd-setup.log \ @@ -1246,6 +1252,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/log_put.rst \ html/_sources/reference/commands/log_reopen.rst \ html/_sources/reference/commands/normalize.rst \ + html/_sources/reference/commands/normalizer_list.rst \ html/_sources/reference/commands/quit.rst \ html/_sources/reference/commands/register.rst \ html/_sources/reference/commands/ruby_eval.rst \ @@ -1258,6 +1265,7 @@ html_files_relative_from_locale_dir = \ html/_sources/reference/commands/table_list.rst \ html/_sources/reference/commands/table_remove.rst \ html/_sources/reference/commands/tokenize.rst \ + html/_sources/reference/commands/tokenizer_list.rst \ html/_sources/reference/commands/truncate.rst \ html/_sources/reference/executables.rst \ html/_sources/reference/executables/grnslap.rst \ @@ -1434,6 +1442,7 @@ html_files_relative_from_locale_dir = \ html/reference/commands/log_put.html \ html/reference/commands/log_reopen.html \ html/reference/commands/normalize.html \ + html/reference/commands/normalizer_list.html \ html/reference/commands/quit.html \ html/reference/commands/register.html \ html/reference/commands/ruby_eval.html \ @@ -1446,6 +1455,7 @@ html_files_relative_from_locale_dir = \ html/reference/commands/table_list.html \ html/reference/commands/table_remove.html \ html/reference/commands/tokenize.html \ + html/reference/commands/tokenizer_list.html \ html/reference/commands/truncate.html \ html/reference/executables.html \ html/reference/executables/grnslap.html \ Added: doc/source/example/reference/commands/normalizer_list/simple_example.log (+18 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/normalizer_list/simple_example.log 2014-05-23 21:57:05 +0900 (b08bd37) @@ -0,0 +1,18 @@ +Execution example:: + + normalzer_list + # [ + # [ + # 0, + # 0.0, + # 0.0 + # ], + # [ + # { + # "name": "NormalizerAuto" + # }, + # { + # "name": "NormalizerNFKC51" + # } + # ] + # ] Added: doc/source/example/reference/commands/tokenizer_list/simple_example.log (+51 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/tokenizer_list/simple_example.log 2014-05-23 21:57:05 +0900 (1226f00) @@ -0,0 +1,51 @@ +Execution example:: + + tokenizer_list + # [ + # [ + # 0, + # 0.0, + # 0.0 + # ], + # [ + # { + # "name": "TokenMecab" + # }, + # { + # "name": "TokenDelimit" + # }, + # { + # "name": "TokenUnigram" + # }, + # { + # "name": "TokenBigram" + # }, + # { + # "name": "TokenTrigram" + # }, + # { + # "name": "TokenBigramSplitSymbol" + # }, + # { + # "name": "TokenBigramSplitSymbolAlpha" + # }, + # { + # "name": "TokenBigramSplitSymbolAlphaDigit" + # }, + # { + # "name": "TokenBigramIgnoreBlank" + # }, + # { + # "name": "TokenBigramIgnoreBlankSplitSymbol" + # }, + # { + # "name": "TokenBigramIgnoreBlankSplitSymbolAlpha" + # }, + # { + # "name": "TokenBigramIgnoreBlankSplitSymbolAlphaDigit" + # }, + # { + # "name": "TokenDelimitNull" + # } + # ] + # ] Added: doc/source/reference/commands/normalizer_list.rst (+65 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/normalizer_list.rst 2014-05-23 21:57:05 +0900 (3c02838) @@ -0,0 +1,65 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: commands_normalizer_list + +``normalizer_list`` +============ + +Summary +------- + +``normalizer_list`` command lists normalizers in a database. + + +Syntax +------ + +``normalizer_list`` command takes no parameter. +:: + + normalizer_list + +Usage +----- + +Here is a simple example. + +.. groonga-command +.. include:: ../../example/reference/commands/normalizer_list/simple_example.log +.. normalizer_list + +It returns normalizers in a database. + +Return value +------------ + +``normalizer_list`` command returns normalizers. Each normalizers has an attribute +that contains the name. The attribute will be increased in the feature:: + + [HEADER, normalizer] + +``HEADER`` + + See :doc:`/reference/command/output_format` about ``HEADER``. + +``normalizer`` + + ``normalizer`` is an array of normalizer. Normalizer is an object that has the following + attributes. + + .. list-table:: + :header-rows: 1 + + * - Name + - Description + * - ``name`` + - Normalizer name. + +See also +-------- + +* :doc:`/reference/normalizers` +* :doc:`/reference/commands/normalize` Added: doc/source/reference/commands/tokenizer_list.rst (+65 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/tokenizer_list.rst 2014-05-23 21:57:05 +0900 (eb6a8dc) @@ -0,0 +1,65 @@ +.. -*- rst -*- + +.. highlightlang:: none + +.. groonga-command +.. database: commands_tokenizer_list + +``tokenizer_list`` +============ + +Summary +------- + +``tokenizer_list`` command lists tokenizers in a database. + + +Syntax +------ + +``tokenizer_list`` command takes no parameter. +:: + + tokenizer_list + +Usage +----- + +Here is a simple example. + +.. groonga-command +.. include:: ../../example/reference/commands/tokenizer_list/simple_example.log +.. tokenizer_list + +It returns tokenizers in a database. + +Return value +------------ + +``tokenizer_list`` command returns tokenizers. Each tokenizers has an attribute +that contains the name. The attribute will be increased in the feature:: + + [HEADER, tokenizer] + +``HEADER`` + + See :doc:`/reference/command/output_format` about ``HEADER``. + +``tokenizer`` + + ``tokenizer`` is an array of tokenizer. Tokenizer is an object that has the following + attributes. + + .. list-table:: + :header-rows: 1 + + * - Name + - Description + * - ``name`` + - Tokenizer name. + +See also +-------- + +* :doc:`/reference/tokenizers` +* :doc:`/reference/commands/tokenize` -------------- next part -------------- HTML����������������������������...Download