Kouhei Sutou
null+****@clear*****
Tue Sep 15 13:40:00 JST 2015
Kouhei Sutou 2015-09-15 13:40:00 +0900 (Tue, 15 Sep 2015) New Revision: 4a3abc6added78f61e01d13ee774f24399179145 https://github.com/groonga/groonga/commit/4a3abc6added78f61e01d13ee774f24399179145 Message: doc highlight_html: use common format Modified files: doc/source/reference/functions/highlight_html.rst Modified: doc/source/reference/functions/highlight_html.rst (+18 -8) =================================================================== --- doc/source/reference/functions/highlight_html.rst 2015-09-15 13:39:25 +0900 (b811bbb) +++ doc/source/reference/functions/highlight_html.rst 2015-09-15 13:40:00 +0900 (e5e88e0) @@ -12,6 +12,8 @@ highlight_html This feature is experimental. API will be changed. +.. versionadded:: 4.0.5 + Summary ------- @@ -25,9 +27,9 @@ For example, a tagged text of ``I am a groonga user. <3`` for keyword Syntax ------ -``highlight_html`` has only one parameter:: +This function has only one parameter:: - highlight_html(column) + highlight_html(text) Usage ----- @@ -48,8 +50,6 @@ Here are a schema definition and sample data to show usage. ``highlight_html`` can be used in only ``--output_columns`` in :doc:`/reference/commands/select`. -``highlight_html`` requires Groonga 4.0.5 or later. - ``highlight_html`` requires :doc:`/reference/command/command_version` 2 or later. @@ -79,12 +79,22 @@ You can specify string literal instead of column. Parameters ---------- -There is only one parameter ``column`` . +This section describes all parameters. + +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is only one required parameters. + +``text`` +"""""""" + +The text to be highlighted in HTML. -``column`` -^^^^^^^^^^ +Optional parameters +^^^^^^^^^^^^^^^^^^^ -Specifies a column of the table. +There is no optional parameters. Return value ------------ -------------- next part -------------- HTML����������������������������...下載
