[Groonga-commit] groonga/groonga at d7163da [master] doc: add highlight_full parameters description

Back to archive index

naoa null+****@clear*****
Mon Aug 11 06:50:04 JST 2014


naoa	2014-08-11 06:50:04 +0900 (Mon, 11 Aug 2014)

  New Revision: d7163da1c28701a554aa18fd2c36821b42c74c54
  https://github.com/groonga/groonga/commit/d7163da1c28701a554aa18fd2c36821b42c74c54

  Merged 1c5df3c: Merge pull request #186 from naoa/doc-highlight-function

  Message:
    doc: add highlight_full parameters description

  Modified files:
    doc/locale/en/LC_MESSAGES/reference.po
    doc/locale/ja/LC_MESSAGES/reference.po
    doc/source/reference/functions/highlight_full.rst

  Modified: doc/locale/en/LC_MESSAGES/reference.po (+41 -0)
===================================================================
--- doc/locale/en/LC_MESSAGES/reference.po    2014-08-11 04:32:42 +0900 (b843527)
+++ doc/locale/en/LC_MESSAGES/reference.po    2014-08-11 06:50:04 +0900 (dd34a3d)
@@ -9933,6 +9933,47 @@ msgstr ""
 "``>``."
 
 msgid ""
+"There are three required parameters, ``column``, ``normalizer_name`` and ``use_html_escape``. "
+"There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``end_tagN``."
+msgstr ""
+"There are three required parameters, ``column``, ``normalizer_name`` and ``use_html_escape``. "
+"There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``end_tagN``."
+
+msgid "It specifies a column of the table."
+msgstr "It specifies a column of the table."
+
+msgid "It specifies a normalizer name."
+msgstr "It specifies a normalizer name."
+
+msgid ""
+"It specifies use or not use HTML escape. If it is ``true`` , use HTML escape. "
+"If it is ``false`` , not use HTML escape."
+msgstr ""
+"It specifies use or not use HTML escape. If it is ``true`` , use HTML escape. "
+"If it is ``false`` , not use HTML escape."
+
+msgid ""
+"It specifies a keyword for tagging. "
+"You can specify multiple keywords for each three arguments."
+msgstr ""
+"It specifies a keyword for tagging. "
+"You can specify multiple keywords for each three arguments."
+
+msgid ""
+"It specifies a open tag. "
+"You can specify multiple open tags for each three arguments."
+msgstr ""
+"It specifies a open tag. "
+"You can specify multiple open tags for each three arguments."
+
+msgid ""
+"It specifies a close tag. "
+"You can specify multiple close tags for each three arguments."
+msgstr ""
+"It specifies a close tag. "
+"You can specify multiple close tags for each three arguments."
+
+msgid ""
 "``highlight_full`` returns a tagged string or ``null``. If "
 "``highlight_full`` can't find any keywords, it returns ``null``."
 msgstr ""

  Modified: doc/locale/ja/LC_MESSAGES/reference.po (+42 -0)
===================================================================
--- doc/locale/ja/LC_MESSAGES/reference.po    2014-08-11 04:32:42 +0900 (38f132c)
+++ doc/locale/ja/LC_MESSAGES/reference.po    2014-08-11 06:50:04 +0900 (4321930)
@@ -9059,6 +9059,48 @@ msgstr ""
 "``<`` や ``>`` などの特殊文字は &lt; や &gt; にエスケープされています。"
 
 msgid ""
+"There are three required parameters, ``column``, ``normalizer_name`` and ``use_html_escape``. "
+"There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``end_tagN``."
+msgstr ""
+"必須引数は3つあります。 ``column`` と ``normalizer_name`` と ``user_html_escape`` です。"
+"省略可能引数は3つ以上あります。 ``keywordN`` と ``open_tagN`` と ``end_tagN`` です。"
+
+
+msgid "It specifies a column of the table."
+msgstr "テーブルのカラムを指定します。"
+
+msgid "It specifies a normalizer name."
+msgstr "ノーマライザー名を指定します。"
+
+msgid ""
+"It specifies use or not use HTML escape. If it is ``true`` , use HTML escape. "
+"If it is ``false`` , not use HTML escape."
+msgstr ""
+"HTMLエスケープの有無を指定します。 ``true`` を指定すればHTMLエスケープされます。"
+" ``false`` を指定すればHTMLエスケープされません。"
+
+msgid ""
+"It specifies a keyword for tagging. "
+"You can specify multiple keywords for each three arguments."
+msgstr ""
+"タグ付けするキーワードを指定します。"
+"3つの引数ごとに複数のキーワードを指定することができます。"
+
+msgid ""
+"It specifies a open tag. "
+"You can specify multiple open tags for each three arguments."
+msgstr ""
+"開始タグを指定します。"
+"3つの引数ごとに複数の開始タグを指定することができます。"
+
+msgid ""
+"It specifies a close tag. "
+"You can specify multiple close tags for each three arguments."
+msgstr ""
+"終了タグを指定します。"
+"3つの引数ごとに複数の終了タグを指定することができます。"
+
+msgid ""
 "``highlight_full`` returns a tagged string or ``null``. If "
 "``highlight_full`` can't find any keywords, it returns ``null``."
 msgstr ""

  Modified: doc/source/reference/functions/highlight_full.rst (+39 -0)
===================================================================
--- doc/source/reference/functions/highlight_full.rst    2014-08-11 04:32:42 +0900 (28ca08c)
+++ doc/source/reference/functions/highlight_full.rst    2014-08-11 06:50:04 +0900 (0237dcf)
@@ -80,6 +80,45 @@ You can specify string literal instead of column.
 .. include:: ../../example/reference/functions/highlight_full/usage_string_literal.log
 .. select Entries --output_columns 'highlight_full("Groonga is very fast fulltext search engine.", "NormalizerAuto", true, "Groonga", "<span class=\\"keyword1\\">", "</span>", "mysql", "<span class=\\"keyword2\\">", "</span>")' --command_version 2 --match_columns body --query "groonga"
 
+Parameters
+----------
+There are three required parameters, ``column``, ``normalizer_name`` and ``use_html_escape``.
+There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``end_tagN``.
+
+``column``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a column of the table.
+
+``normalizer_name``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a normalizer name.
+
+``use_html_escape``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies use or not use HTML escape. If it is ``true`` , use HTML escape.
+If it is ``false`` , not use HTML escape.
+
+``keywordN``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a keyword for tagging.
+You can specify multiple keywords for each three arguments.
+
+``open_tagN``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a open tag.
+You can specify multiple open tags for each three arguments.
+
+``close_tagN``
+^^^^^^^^^^^^^^^^^^^
+
+It specifies a close tag.
+You can specify multiple close tags for each three arguments.
+
 Return value
 ------------
 
-------------- next part --------------
HTML����������������������������...
다운로드 



More information about the Groonga-commit mailing list
Back to archive index