Kouhei Sutou
null+****@clear*****
Mon Sep 21 22:45:52 JST 2015
Kouhei Sutou 2015-09-21 22:45:52 +0900 (Mon, 21 Sep 2015) New Revision: 2fe529171f99458d9b0bef1d1076696655eeeabb https://github.com/groonga/groonga/commit/2fe529171f99458d9b0bef1d1076696655eeeabb Message: doc tutorial: improve description GitHub: fix #405 Reported by Hiroyuki Sato. Thanks!!! Modified files: doc/locale/ja/LC_MESSAGES/tutorial.po doc/source/tutorial/data.rst doc/source/tutorial/introduction.rst Modified: doc/locale/ja/LC_MESSAGES/tutorial.po (+30 -24) =================================================================== --- doc/locale/ja/LC_MESSAGES/tutorial.po 2015-09-19 21:01:15 +0900 (2127905) +++ doc/locale/ja/LC_MESSAGES/tutorial.po 2015-09-21 22:45:52 +0900 (d8a85eb) @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: 1.2.1\n" "Report-Msgid-Bugs-To: \n" -"PO-Revision-Date: 2015-09-16 23:23+0900\n" +"PO-Revision-Date: 2015-09-21 22:45+0900\n" "Last-Translator: Masafumi Yokoyama <yokoyama �� clear-code.com>\n" "Language-Team: Japanese\n" "Language: ja\n" @@ -136,11 +136,13 @@ msgstr "" "す。" msgid "" -"The following example creates a ShortText column and updates existing " -"records. The third record has the default value because not updated." +"The following example creates a ``ShortText`` column and updates existing " +"records. The third record (``\"Block\"`` key record) has the default value " +"(zero-length string) because it's not updated." msgstr "" -"以下の例では、ShortText型のカラムを作成し、IDが1と2のレコードを更新します。更" -"新しないレコードについては、デフォルト値のままとなります。" +"以下の例では、 ``ShortText`` 型のカラムを作成し、既存のレコードを更新します。" +"3つ目のレコード（キーが ``\"Block\"`` のレコード）は更新していないのでデフォ" +"ルト値（長さが0の文字列）になります。" msgid "Date and time type" msgstr "日時" @@ -173,11 +175,13 @@ msgstr "" "す。整数部が秒数で、小数部はマイクロ秒の値です。" msgid "" -"The following example creates a Time column and updates existing records. " -"The first record has the default value because not updated." +"The following example creates a ``Time`` column and updates existing " +"records. The first record (``\"Monkey\"`` key record) has the default value " +"(``0.0``) because it's not updated." msgstr "" -"以下の例では、Time型のカラムを作成し、IDが2と3のレコードを更新します。更新し" -"ないレコードについては、デフォルト値のままとなります。" +"以下の例では、 ``Time`` 型のカラムを作成し、既存のレコードを更新します。1つ目" +"のレコード（キーが ``\"Monkey\"`` のレコード）は更新していないのでデフォルト" +"値（ ``0.0`` ）になります。" msgid "Longitude and latitude types" msgstr "経緯度" @@ -212,12 +216,13 @@ msgstr "" "フォルト値は \"0x0\" です。" msgid "" -"The following example creates a WGS84GeoPoint column and updates existing " -"records. The second record has the default value because not updated." +"The following example creates a ``WGS84GeoPoint`` column and updates " +"existing records. The second record (``\"Flower\"`` key record) has the " +"default value (``\"0x0\"``) because it's not updated." msgstr "" -"以下の例では、世界測地系を用いるWGS84GeoPoint型のカラムを作成し、IDが1と3のレ" -"コードを更新します。更新しないレコードについては、デフォルト値のままとなりま" -"す。" +"以下の例では、世界測地系を用いる ``WGS84GeoPoint`` 型のカラムを作成し、既存の" +"レコードを更新します。2つ目のレコード（キーが ``\"Flower\"`` のレコード）は更" +"新していないのでデフォルト値（ ``\"0x0\"`` ）になります。" msgid "Reference types" msgstr "テーブル参照" @@ -233,29 +238,30 @@ msgstr "" "のレコードにアクセスできるようにします。" msgid "" -"You can specify a column in the associated table to the `output_columns` " +"You can specify a column in the associated table to the ``output_columns`` " "parameter of a :doc:`/reference/commands/select` command. The format is " -"\"Src.Dest\" where Src is the name of the reference column and Dest is the " +"``Src.Dest`` where Src is the name of the reference column and Dest is the " "name of the target column. If only the reference column is specified, it is " -"handled as \"Src._key\". Note that if a reference does not point to a valid " +"handled as ``Src._key``. Note that if a reference does not point to a valid " "record, a :doc:`/reference/commands/select` command outputs the default " "value of the target column." msgstr "" "テーブル参照のカラムがあるときは、 :doc:`/reference/commands/select` コマンド" -"の `output_columns` 引数に \"参照元カラム.参照先カラム\" と指定することによ" +"の ``output_columns`` 引数に ``参照元カラム.参照先カラム`` と指定することによ" "り、参照先カラムの値を取り出すことができます。参照元カラムのみを指定したとき" -"は、 \"参照元カラム名._key\" と同様の扱いとなり、参照先レコードの主キーが取り" +"は、 ``参照元カラム名._key`` と同様の扱いとなり、参照先レコードの主キーが取り" "出されます。テーブル参照が有効なレコードを指していないときは、 :doc:`/" "reference/commands/select` コマンドは参照先カラムのデフォルト値を取り出すよう" "になっています。" msgid "" -"The following example adds a reference column to the Site table that was " -"created in the previous tutorial. The new column, named link, is designed " -"for storing links among records in the Site table." +"The following example adds a reference column to the ``Site`` table that was " +"created in :ref:`tutorial-introduction-create-table`. The new column, named " +"``link``, is designed for storing links among records in the ``Site`` table." msgstr "" -"ここでは、先のチュートリアルで作成したSiteテーブルにlinkという新たなカラムを" -"作成し、サイト間のリンク関係を保存できるようにしてみましょう。" +"ここでは、 :ref:`tutorial-introduction-create-table` で作成した ``Site`` テー" +"ブルに参照カラムを作成します。作成する参照カラムは ``link`` という名前にしま" +"す。このカラムには ``Site`` テーブルのレコード間でのリンク関係を保存します。" msgid "" "The `type` parameter of the :doc:`/reference/commands/column_create` command " Modified: doc/source/tutorial/data.rst (+14 -5) =================================================================== --- doc/source/tutorial/data.rst 2015-09-19 21:01:15 +0900 (6243ca3) +++ doc/source/tutorial/data.rst 2015-09-21 22:45:52 +0900 (5a32275) @@ -67,7 +67,9 @@ String types The string types are divided according to the maximum length. For more details, see :doc:`/reference/types`. The default value is the zero-length string. -The following example creates a ShortText column and updates existing records. The third record has the default value because not updated. +The following example creates a ``ShortText`` column and updates +existing records. The third record (``"Block"`` key record) has the +default value (zero-length string) because it's not updated. .. groonga-command .. include:: ../example/tutorial/data-4.log @@ -89,7 +91,9 @@ The date and time type of Groonga is Time. Actually, a Time column stores a date Groonga internally holds the value of Epoch as pair of integer. The first integer represents the value of seconds, on the other hand, the second integer represents the value of micro seconds. So, Groonga shows the value of Epoch as floating point. Integral part means the value of seconds, fraction part means the value of micro seconds. -The following example creates a Time column and updates existing records. The first record has the default value because not updated. +The following example creates a ``Time`` column and updates existing +records. The first record (``"Monkey"`` key record) has the default +value (``0.0``) because it's not updated. .. groonga-command .. include:: ../example/tutorial/data-5.log @@ -111,7 +115,9 @@ The longitude and latitude types are divided according to the geographic coordin A number with/without a decimal point represents a longitude or latitude in milliseconds/degrees respectively. Note that a combination of a number with a decimal point and a number without a decimal point (e.g. 35.1x139) must not be used. A comma (',') is also available as a delimiter. The default value is "0x0". -The following example creates a WGS84GeoPoint column and updates existing records. The second record has the default value because not updated. +The following example creates a ``WGS84GeoPoint`` column and updates +existing records. The second record (``"Flower"`` key record) has the +default value (``"0x0"``) because it's not updated. .. groonga-command .. include:: ../example/tutorial/data-6.log @@ -128,9 +134,12 @@ Reference types Groonga supports a reference column, which stores references to records in its associated table. In practice, a reference column stores the IDs of the referred records in the associated table and enables access to those records. -You can specify a column in the associated table to the `output_columns` parameter of a :doc:`/reference/commands/select` command. The format is "Src.Dest" where Src is the name of the reference column and Dest is the name of the target column. If only the reference column is specified, it is handled as "Src._key". Note that if a reference does not point to a valid record, a :doc:`/reference/commands/select` command outputs the default value of the target column. +You can specify a column in the associated table to the ``output_columns`` parameter of a :doc:`/reference/commands/select` command. The format is ``Src.Dest`` where Src is the name of the reference column and Dest is the name of the target column. If only the reference column is specified, it is handled as ``Src._key``. Note that if a reference does not point to a valid record, a :doc:`/reference/commands/select` command outputs the default value of the target column. -The following example adds a reference column to the Site table that was created in the previous tutorial. The new column, named link, is designed for storing links among records in the Site table. +The following example adds a reference column to the ``Site`` table +that was created in :ref:`tutorial-introduction-create-table`. The new +column, named ``link``, is designed for storing links among records in +the ``Site`` table. .. groonga-command .. include:: ../example/tutorial/data-7.log Modified: doc/source/tutorial/introduction.rst (+2 -0) =================================================================== --- doc/source/tutorial/introduction.rst 2015-09-19 21:01:15 +0900 (bd54735) +++ doc/source/tutorial/introduction.rst 2015-09-21 22:45:52 +0900 (ea77cb4) @@ -90,6 +90,8 @@ Basic commands :doc:`/reference/commands/load` inserts records to a table. +.. _tutorial-introduction-create-table: + Create a table -------------- -------------- next part -------------- HTML����������������������������...Download