HAYASHI Kentaro
null+****@clear*****
Mon Jan 28 18:11:33 JST 2013
HAYASHI Kentaro 2013-01-28 18:11:33 +0900 (Mon, 28 Jan 2013) New Revision: 700eb7d287cd96e1d3bb7728279174148f693fed https://github.com/groonga/groonga/commit/700eb7d287cd96e1d3bb7728279174148f693fed Log: doc en: update to newer documentation style Added files: doc/source/example/reference/commands/normalize/normalizer_auto_ascii.log Modified files: doc/source/reference/commands/normalize.txt Added: doc/source/example/reference/commands/normalize/normalizer_auto_ascii.log (+4 -0) 100644 =================================================================== --- /dev/null +++ doc/source/example/reference/commands/normalize/normalizer_auto_ascii.log 2013-01-28 18:11:33 +0900 (537f52c) @@ -0,0 +1,4 @@ +Execution example:: + + normalize NormalizerAuto "aBcDe 123" + # [[0, 1337566253.89858, 0.000355720520019531], "abcde 123"] Modified: doc/source/reference/commands/normalize.txt (+35 -22) =================================================================== --- doc/source/reference/commands/normalize.txt 2013-01-28 17:09:29 +0900 (fa81972) +++ doc/source/reference/commands/normalize.txt 2013-01-28 18:11:33 +0900 (0bfadd7) @@ -2,45 +2,66 @@ .. highlightlang:: none -normalize -========= +.. groonga-command +.. database: commands_normalize + +``normalize`` +============= .. Caution:: ``normalize`` command is the experimental feature. This command may be changed in the future. -Name ----- +Summary +------- + +``normalize`` command normalizes text by the specified normalizer. -normalize - normalizes the given string by the specified normalizer +There is no need to create table to use ``normalize`` command. +It is usefull for you to check the results of normalizer. Syntax -------- + +``normalize`` commands takes two parameters - ``normalizer`` and ``string``. +Both of them are required. + :: normalize normalizer string -Summary -------- -``normalize`` command normalizes text. +Usage +----- + +Here is a simple example of ``normalize`` command. -There is no need to create table to use ``normalize`` command. -It is usefull for you to check the results of normalizer. +.. groonga-command +.. include:: ../../example/reference/commands/normalize/normalizer_auto_ascii.log +.. normalize NormalizerAuto "aBcDe 123" Parameters ---------- +This section describes parameters of ``normalizer``. + +Required parameter +^^^^^^^^^^^^^^^^^^ + +There are required parameters, ``normalizer`` and ``string``. + ``normalizer`` +"""""""""""""" - It specifies the name of normalizer. - Currently, ``normalize`` command accepts ``NormalizerAuto`` or ``NormalizerNFKC51`` as built-in normalizer. - If you want to try another normalizer, you need to regist additional normalizer plugin by ``register`` command. +It specifies the name of normalizer. +Currently, ``normalize`` command accepts ``NormalizerAuto`` or ``NormalizerNFKC51`` as built-in normalizer. +If you want to try another normalizer, you need to register additional normalizer plugin by ``register`` command. ``string`` +"""""""""" - It specifies any string which you want to normalize. +It specifies any string which you want to normalize. Return value ------------ @@ -58,14 +79,6 @@ Return value normalized is the normalized text by the specified normalizer. -Usage ------ - -:: - - normalize NormalizerAuto "aBcDe 123" - [[0,1359354969.61772,0.000174522399902344],"abcde 123"] - See also -------- -------------- next part -------------- HTML����������������������������...Download