HAYASHI Kentaro
null+****@clear*****
Mon Jan 28 15:58:59 JST 2013
HAYASHI Kentaro 2013-01-28 15:58:59 +0900 (Mon, 28 Jan 2013) New Revision: a27581e8e404c74c44238c5d468f5a1e412d3bf9 https://github.com/groonga/groonga/commit/a27581e8e404c74c44238c5d468f5a1e412d3bf9 Log: doc en: add documentation about normalize command Added files: doc/source/reference/commands/normalize.txt Added: doc/source/reference/commands/normalize.txt (+72 -0) 100644 =================================================================== --- /dev/null +++ doc/source/reference/commands/normalize.txt 2013-01-28 15:58:59 +0900 (c7304ac) @@ -0,0 +1,72 @@ +.. -*- rst -*- + +.. highlightlang:: none + +normalize +========= + +.. Caution:: + + ``normalize`` command is the experimental feature. + This command may be changed in the future. + +Name +---- + +normalize - normalizes the given string by the specified normalizer + +Syntax +-------- +:: + + normalize normalizer string + +Summary +------- + +``normalize`` command normalizes text. + +There is no need to create table to use ``normalize`` command. +It is usefull for you to check the results of normalizer. + +Parameters +---------- + +``normalizer`` + + It specifies the name of normalizer. + Currently, ``normalize`` command accepts ``NormalizerAuto`` or ``NormalizerNFC`` as built-in normalizer. + If you want to try another normalizer, you need to regist additional normalizer plugin by ``register`` command. + +``string`` + + It specifies any string which you want to normalize. + +Return value +------------ + +:: + + [HEADER, normalized] + +``HEADER`` + + The format of HEADER is [0, UNIX_TIME_WHEN_COMMAND_IS_STARTED, ELAPSED_TIME]. + See :doc:`/reference/command/output_format` about HEADER. + +``normalized`` + + normalized is the normalized text by the specified normalizer. + +Usage +----- + +:: + + normalize NormalizerAuto "aBcDe 123" + [[0,1359354969.61772,0.000174522399902344],"abcde 123"] + +See also +-------- + +* :doc:`/reference/normalizers` -------------- next part -------------- HTML����������������������������...Download
