doc: separate NormalizerNFKC51 into other pages

groonga · Jan 18, 2019 · bb11967 · bb11967
1 parent f3684ca
commit bb11967
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 96 deletions.
diff --git a/doc/locale/ja/LC_MESSAGES/reference.po b/doc/locale/ja/LC_MESSAGES/reference.po
@@ -23902,10 +23902,18 @@ msgstr "組み込みノーマライザー"
 msgid "Here is a list of built-in normalizers:"
 msgstr "以下は組み込みのノーマライザーのリストです。"
 
-msgid "``NormalizerAuto``"
+msgid "Additional normalizers"
+msgstr "追加のノーマライザー一覧"
+
+msgid "There are additional normalizers:"
+msgstr "いくつか追加のノーマライザーがあります。"
+
+msgid ""
+"`groonga-normalizer-mysql <https://github.com/groonga/groonga-normalizer-"
+"mysql>`_"
 msgstr ""
 
-msgid "``NormalizerNFKC51``"
+msgid "``NormalizerAuto``"
 msgstr ""
 
 msgid ""
@@ -23931,51 +23939,6 @@ msgstr ""
 "正規化をします。これらの独自の正規化の結果はNFKCでの結果と似たものになりま"
 "す。"
 
-msgid ""
-"For example, half-width katakana (such as U+FF76 HALFWIDTH KATAKANA LETTER "
-"KA) + half-width katakana voiced sound mark (U+FF9E HALFWIDTH KATAKANA "
-"VOICED SOUND MARK) is normalized to full-width katakana with voiced sound "
-"mark (U+30AC KATAKANA LETTER GA). The former is two characters but the "
-"latter is one character."
-msgstr ""
-"例えば、半角カタカナ（例えば「ｶ」: U+FF76 HALFWIDTH KATAKANA LETTER KA） + 半"
-"角カタカナの濁点（「ﾞ」: U+FF9E HALFWIDTH KATAKANA VOICED SOUND MARK）は濁点"
-"付きの全角カタカナ（「ガ」: U+30AC KATAKANA LETTER GA）に正規化されます。前者"
-"は2文字ですが、後者は1文字です。"
-
-msgid "Here is an example that uses ``NormalizerAuto`` normalizer:"
-msgstr "以下は ``NormalizerAuto`` ノーマライザーを使う例です。"
-
-msgid ""
-"``NormalizerNFKC51`` normalizes texts by Unicode NFKC (Normalization Form "
-"Compatibility Composition) for Unicode version 5.1. It supports only UTF-8 "
-"encoding."
-msgstr ""
-"``NormalizerNFKC51`` はUnicode 5.1用のUnicode NFKC（Normalization Form "
-"Compatibility Composition）を使ってテキストを正規化します。UTF-8エンコーディ"
-"ングのみをサポートしています。"
-
-msgid ""
-"Normally you don't need to use ``NormalizerNFKC51`` explicitly. You can use "
-"``NormalizerAuto`` instead."
-msgstr ""
-"通常、 ``NormalizerNFKC51`` を明示的に使う必要はありません。代わりに "
-"``NormalizerAuto`` を使ってください。"
-
-msgid "Here is an example that uses ``NormalizerNFKC51`` normalizer:"
-msgstr "以下は ``NormalizerNFKC51`` ノーマライザーを使う例です。"
-
-msgid "Additional normalizers"
-msgstr "追加のノーマライザー一覧"
-
-msgid "There are additional normalizers:"
-msgstr "いくつか追加のノーマライザーがあります。"
-
-msgid ""
-"`groonga-normalizer-mysql <https://github.com/groonga/groonga-normalizer-"
-"mysql>`_"
-msgstr ""
-
 msgid "``NormalizerAuto`` hasn't parameter::"
 msgstr "``NormalizerAuto`` には引数はありません。::"
 
@@ -23991,6 +23954,9 @@ msgstr ""
 "SOUND MARK）を濁点付きの全角カタカナ（「ガ」: U+30AC KATAKANA LETTER GA）に正"
 "規化します。前者は2文字ですが、後者は1文字です。"
 
+msgid "Here is an example that uses ``NormalizerAuto`` normalizer:"
+msgstr "以下は ``NormalizerAuto`` ノーマライザーを使う例です。"
+
 msgid ":doc:`../commands/normalize`"
 msgstr ""
 
@@ -24336,6 +24302,31 @@ msgstr ""
 msgid "This option enables normalize hiragana and katakana to romaji."
 msgstr "このオプションは、ひらがなとカタカナをローマ字に正規化します。"
 
+msgid "``NormalizerNFKC51``"
+msgstr ""
+
+msgid ""
+"``NormalizerNFKC51`` normalizes texts by Unicode NFKC (Normalization Form "
+"Compatibility Composition) for Unicode version 5.1. It supports only UTF-8 "
+"encoding."
+msgstr ""
+"``NormalizerNFKC51`` はUnicode 5.1用のUnicode NFKC（Normalization Form "
+"Compatibility Composition）を使ってテキストを正規化します。UTF-8エンコーディ"
+"ングのみをサポートしています。"
+
+msgid ""
+"Normally you don't need to use ``NormalizerNFKC51`` explicitly. You can use "
+"``NormalizerAuto`` instead."
+msgstr ""
+"通常、 ``NormalizerNFKC51`` を明示的に使う必要はありません。代わりに "
+"``NormalizerAuto`` を使ってください。"
+
+msgid "``NormalizerNFKC51`` hasn't parameter::"
+msgstr "``NormalizerNFKC51`` には引数はありません。::"
+
+msgid "Here is an example that uses ``NormalizerNFKC51`` normalizer:"
+msgstr "以下は ``NormalizerNFKC51`` ノーマライザーを使う例です。"
+
 msgid "Operations"
 msgstr "操作方法"
 

diff --git a/doc/source/example/reference/normalizers/normalizer-nfkc51.log b/doc/source/example/reference/normalizers/normalizer-nfkc51.log
@@ -1,4 +1,17 @@
 Execution example::
 
-  table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51
-  # [[0, 1337566253.89858, 0.000355720520019531], true]
+  normalize NormalizerNFKC51 "㎡"
+  # [
+  #   [
+  #     0,
+  #     1547241266.278454,
+  #     0.0001294612884521484
+  #   ],
+  #   {
+  #     "normalized": "m2",
+  #     "types": [
+  #     ],
+  #     "checks": [
+  #     ]
+  #   }
+  # ]
diff --git a/doc/source/reference/normalizers.rst b/doc/source/reference/normalizers.rst
@@ -79,53 +79,6 @@ Here is a list of built-in normalizers:
 
    normalizers/*
 
-.. _normalizer-auto:
-
-``NormalizerAuto``
-^^^^^^^^^^^^^^^^^^
-
-Normally you should use ``NormalizerAuto``
-normalizer. ``NormalizerAuto`` was the normalizer for Groonga 2.0.9 or
-earlier. ``KEY_NORMALIZE`` flag in ``table_create`` on Groonga 2.0.9
-or earlier equals to ``--normalizer NormalizerAuto`` option in
-``table_create`` on Groonga 2.1.0 or later.
-
-``NormalizerAuto`` supports all encoding. It uses Unicode NFKC
-(Normalization Form Compatibility Composition) for UTF-8 encoding
-text. It uses encoding specific original normalization for other
-encodings. The results of those original normalization are similar to
-NFKC.
-
-For example, half-width katakana (such as U+FF76 HALFWIDTH KATAKANA
-LETTER KA) + half-width katakana voiced sound mark (U+FF9E HALFWIDTH
-KATAKANA VOICED SOUND MARK) is normalized to full-width katakana with
-voiced sound mark (U+30AC KATAKANA LETTER GA). The former is two
-characters but the latter is one character.
-
-Here is an example that uses ``NormalizerAuto`` normalizer:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-auto.log
-.. table_create NormalLexicon TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
-
-.. _normalizer-nfkc51:
-
-``NormalizerNFKC51``
-^^^^^^^^^^^^^^^^^^^^
-
-``NormalizerNFKC51`` normalizes texts by Unicode NFKC (Normalization
-Form Compatibility Composition) for Unicode version 5.1. It supports
-only UTF-8 encoding.
-
-Normally you don't need to use ``NormalizerNFKC51`` explicitly. You can
-use ``NormalizerAuto`` instead.
-
-Here is an example that uses ``NormalizerNFKC51`` normalizer:
-
-.. groonga-command
-.. include:: ../example/reference/normalizers/normalizer-nfkc51.log
-.. table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51
-
 Additional normalizers
 ----------------------
 

diff --git a/doc/source/reference/normalizers/normalizer_nfkc51.rst b/doc/source/reference/normalizers/normalizer_nfkc51.rst
@@ -0,0 +1,38 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+.. groonga-command
+.. database: normalisers
+
+.. _normalizer-nfkc51:
+
+``NormalizerNFKC51``
+=====================
+
+Summary
+-------
+
+``NormalizerNFKC51`` normalizes texts by Unicode NFKC (Normalization
+Form Compatibility Composition) for Unicode version 5.1. It supports
+only UTF-8 encoding.
+
+Normally you don't need to use ``NormalizerNFKC51`` explicitly. You can
+use ``NormalizerAuto`` instead.
+
+Syntax
+------
+
+``NormalizerNFKC51`` hasn't parameter::
+
+  NormalizerNFKC51
+
+Usage
+-----
+
+Here is an example that uses ``NormalizerNFKC51`` normalizer:
+
+.. groonga-command
+.. include:: ../../example/reference/normalizers/normalizer-nfkc51.log
+.. table_create NFKC51Lexicon TABLE_HASH_KEY ShortText --normalizer NormalizerNFKC51
+