Kouhei Sutou
null+****@clear*****
Sun Apr 24 18:17:55 JST 2016
Kouhei Sutou 2016-04-24 18:17:55 +0900 (Sun, 24 Apr 2016) New Revision: 86a1ca1c741f1e3c57654ca0033c7bed3a706ace https://github.com/pgroonga/pgroonga.github.io/commit/86a1ca1c741f1e3c57654ca0033c7bed3a706ace Message: Document pgroonga.highlight_html() Modified files: _po/ja/reference/functions/pgroonga-highlight-html.po ja/reference/functions/pgroonga-highlight-html.md ja/reference/functions/pgroonga-snippet-html.md reference/functions/pgroonga-highlight-html.md Modified: _po/ja/reference/functions/pgroonga-highlight-html.po (+164 -4) =================================================================== --- _po/ja/reference/functions/pgroonga-highlight-html.po 2016-04-24 17:57:34 +0900 (ab2f29e) +++ _po/ja/reference/functions/pgroonga-highlight-html.po 2016-04-24 18:17:55 +0900 (5b46687) @@ -1,7 +1,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"PO-Revision-Date: 2016-04-19 15:20+0900\n" +"PO-Revision-Date: 2016-04-24 18:17+0900\n" "Language: ja\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -14,15 +14,175 @@ msgid "" "layout: en\n" "---" msgstr "" +"---\n" +"title: pgroonga.highlight_html関数\n" +"layout: ja\n" +"---" msgid "# `pgroonga.highlight_html` function" -msgstr "" +msgstr "# `pgroonga.highlight_html`関数" msgid "Since 1.0.7." -msgstr "" +msgstr "1.0.7で追加。" msgid "## Summary" msgstr "## 概要" -msgid "TODO" +msgid "" +"`pgroonga.highlight_html` function surrounds the specified keywords in the spe" +"cified text by `<span class=\"keyword\">` and `</span>`. HTML special characters" +" such as `&` in the specified text are escaped." +msgstr "" +"`pgroonga.highlight_html`関数は指定したテキスト中にある指定したキーワードを`<span class=\"keyword\">`と`</" +"span>`で囲みます。指定したテキスト中にある`&`などのHTMLの特別な文字はエスケープされます。" + +msgid "## Syntax" +msgstr "## 構文" + +msgid "Here is the syntax of this function:" +msgstr "この関数の構文は次の通りです。" + +msgid "" +"```text\n" +"text pgroonga.highlight_html(target, ARRAY[keyword1, keyword2, ...])\n" +"```" +msgstr "" + +msgid "`target` is a text to be highlighted. It's `text` type." +msgstr "`target`はハイライト対象のテキストです。型は`text`です。" + +msgid "" +"`keyword1`, `keyword2`, `...` are keywords to be highlighted. They're an array" +" of `text` type. You must specify one or more keywords." +msgstr "" +"キーワードは`<span class=\"keyword\">`と`</span>`で囲まれています。`target`中の`<`、`>`、`&`、`\"`はHTM" +"Lエスケープされます。" + +msgid "" +"`pgroonga.highlight_html` markups the keywords in `target`. It's type is `text" +"` type." +msgstr "`pgroonga.highlight_html`は`target`中のキーワードをマークアップします。型は`text`です。" + +msgid "" +"The keywords are surrounded with `<span class=\"keyword\">` and `</span>`. `<`, " +"`>`, `&` and `\"` in `target` is HTML escaped." +msgstr "" +"キーワードは`<span class=\"keyword\">`と`</span>`で囲まれます。`target`中の`<`、`>`、`&`、`\"`はHTMLエ" +"スケープされます。" + +msgid "## Usage" +msgstr "## 使い方" + +msgid "You need to specify at least one keyword:" +msgstr "少なくとも1つキーワードを指定しなければいけません。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.',\n" +" ARRAY['PostgreSQL']);\n" +"-- highlight_html \n" +"-- ------------------------------------------------------------------\n" +"-- PGroonga is a <span class=\"keyword\">PostgreSQL</span> extension.\n" +"-- (1 row)\n" +"```" +msgstr "" + +msgid "You can specify multiple keywords:" +msgstr "複数のキーワードを指定できます。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.',\n" +" ARRAY['Groonga', 'PostgreSQL']);\n" +"-- highlight_html " +" \n" +"-- ---------------------------------------------------------------------------" +"--------------------\n" +"-- P<span class=\"keyword\">Groonga</span> is a <span class=\"keyword\">PostgreSQ" +"L</span> extension.\n" +"-- (1 row)\n" +"```" +msgstr "" + +msgid "" +"You can extract keywords from query by [`pgroonga.query_extract_keywords` func" +"tion](pgroonga-query-extract-keywords.html):" +msgstr "" +"[`pgroonga.query_extract_keywords`関数](pgroonga-query-extract-keywords.html)を使う" +"とクエリーからキーワードを抽出できます。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.',\n" +" pgroonga.query_extract_keywords('Groonga Postgr" +"eSQL -extension'));\n" +"-- highlight_html " +" \n" +"-- ---------------------------------------------------------------------------" +"--------------------\n" +"-- P<span class=\"keyword\">Groonga</span> is a <span class=\"keyword\">PostgreSQ" +"L</span> extension.\n" +"-- (1 row)\n" +"```" +msgstr "" + +msgid "HTML special characters are escaped automatically:" +msgstr "HTMLの特別な文字は自動でエスケープされます。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('<p>PGroonga is Groonga & PostgreSQL.</p>',\n" +" ARRAY['PostgreSQL']);\n" +"-- highlight_html " +" \n" +"-- ---------------------------------------------------------------------------" +"------------\n" +"-- <p>PGroonga is Groonga & <span class=\"keyword\">PostgreSQL</span>" +".</p>\n" +"-- (1 row)\n" +"```" +msgstr "" + +msgid "Characters are normalized:" +msgstr "文字は正規化されます。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('PGroonga + pglogical = replicatable!',\n" +" ARRAY['Pg']);\n" +" highlight_html " +" \n" +"------------------------------------------------------------------------------" +"------------------\n" +" <span class=\"keyword\">PG</span>roonga + <span class=\"keyword\">pg</span>logica" +"l = replicatable!\n" +"(1 row)\n" +"```" +msgstr "" + +msgid "Multibyte characters are also supported:" +msgstr "マルチバイト文字にも対応しています。" + +msgid "" +"```sql\n" +"SELECT pgroonga.highlight_html('10㌖先にある100ｷﾛグラムの米',\n" +" ARRAY['キロ']);\n" +"-- highlight_html " +" \n" +"-- ---------------------------------------------------------------------------" +"------------\n" +"-- 10<span class=\"keyword\">㌖</span>先にある100<span class=\"keyword\">ｷﾛ</span>グラムの" +"米\n" +"-- (1 row)\n" +"```" +msgstr "" + +msgid "## See also" +msgstr "## 参考" + +msgid "" +" * [`pgroonga.query_extract_keywords` function](pgroonga-query-extract-keywor" +"ds.html)" msgstr "" +" * [`pgroonga.query_extract_keywords`関数](pgroonga-query-extract-keywords.html" +")" Modified: ja/reference/functions/pgroonga-highlight-html.md (+93 -5) =================================================================== --- ja/reference/functions/pgroonga-highlight-html.md 2016-04-24 17:57:34 +0900 (3a5103c) +++ ja/reference/functions/pgroonga-highlight-html.md 2016-04-24 18:17:55 +0900 (b259626) @@ -1,12 +1,100 @@ --- -title: pgroonga.highlight_html function -layout: en +title: pgroonga.highlight_html関数 +layout: ja --- -# `pgroonga.highlight_html` function +# `pgroonga.highlight_html`関数 -Since 1.0.7. +1.0.7で追加。 ## 概要 -TODO +`pgroonga.highlight_html`関数は指定したテキスト中にある指定したキーワードを`<span class="keyword">`と`</span>`で囲みます。指定したテキスト中にある`&`などのHTMLの特別な文字はエスケープされます。 + +## 構文 + +この関数の構文は次の通りです。 + +```text +text pgroonga.highlight_html(target, ARRAY[keyword1, keyword2, ...]) +``` + +`target`はハイライト対象のテキストです。型は`text`です。 + +キーワードは`<span class="keyword">`と`</span>`で囲まれています。`target`中の`<`、`>`、`&`、`"`はHTMLエスケープされます。 + +`pgroonga.highlight_html`は`target`中のキーワードをマークアップします。型は`text`です。 + +キーワードは`<span class="keyword">`と`</span>`で囲まれます。`target`中の`<`、`>`、`&`、`"`はHTMLエスケープされます。 + +## 使い方 + +少なくとも1つキーワードを指定しなければいけません。 + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + ARRAY['PostgreSQL']); +-- highlight_html +-- ------------------------------------------------------------------ +-- PGroonga is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +複数のキーワードを指定できます。 + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + ARRAY['Groonga', 'PostgreSQL']); +-- highlight_html +-- ----------------------------------------------------------------------------------------------- +-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +[`pgroonga.query_extract_keywords`関数](pgroonga-query-extract-keywords.html)を使うとクエリーからキーワードを抽出できます。 + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + pgroonga.query_extract_keywords('Groonga PostgreSQL -extension')); +-- highlight_html +-- ----------------------------------------------------------------------------------------------- +-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +HTMLの特別な文字は自動でエスケープされます。 + +```sql +SELECT pgroonga.highlight_html('<p>PGroonga is Groonga & PostgreSQL.</p>', + ARRAY['PostgreSQL']); +-- highlight_html +-- --------------------------------------------------------------------------------------- +-- <p>PGroonga is Groonga & <span class="keyword">PostgreSQL</span>.</p> +-- (1 row) +``` + +文字は正規化されます。 + +```sql +SELECT pgroonga.highlight_html('PGroonga + pglogical = replicatable!', + ARRAY['Pg']); + highlight_html +------------------------------------------------------------------------------------------------ + <span class="keyword">PG</span>roonga + <span class="keyword">pg</span>logical = replicatable! +(1 row) +``` + +マルチバイト文字にも対応しています。 + +```sql +SELECT pgroonga.highlight_html('10㌖先にある100ｷﾛグラムの米', + ARRAY['キロ']); +-- highlight_html +-- --------------------------------------------------------------------------------------- +-- 10<span class="keyword">㌖</span>先にある100<span class="keyword">ｷﾛ</span>グラムの米 +-- (1 row) +``` + +## 参考 + + * [`pgroonga.query_extract_keywords`関数](pgroonga-query-extract-keywords.html) Modified: ja/reference/functions/pgroonga-snippet-html.md (+3 -1) =================================================================== --- ja/reference/functions/pgroonga-snippet-html.md 2016-04-24 17:57:34 +0900 (7685226) +++ ja/reference/functions/pgroonga-snippet-html.md 2016-04-24 18:17:55 +0900 (a37b554) @@ -23,7 +23,9 @@ text[] pgroonga.snippet_html(target, ARRAY[keyword1, keyword2, ...]) `pgroonga.snippet_html`は`text`型の配列を返します。 -返ってくる配列の各要素はキーワード周辺のテキストです。キーワードは`<span class="keyword">`と`</span>`で囲まれています。`target`中の`<`、`>`、`&`、`"`はHTMLエスケープされます。 +返ってくる配列の各要素はキーワード周辺のテキストです。 + +キーワードは`<span class="keyword">`と`</span>`で囲まれます。`target`中の`<`、`>`、`&`、`"`はHTMLエスケープされます。 各要素の`target`由来の部分の最大サイズは200バイトです。単位は文字数ではなくバイトです。各要素は200バイトより大きくなることがありまう。なぜなら、各要素には`<span class="keyword">`と`</span>`が含まれますし、HTMLエスケープした値が含まれることもあるからです。もし、`<`がHTMLエスケープされると`<`になり、バイトサイズは1から4に増えます。 Modified: reference/functions/pgroonga-highlight-html.md (+89 -1) =================================================================== --- reference/functions/pgroonga-highlight-html.md 2016-04-24 17:57:34 +0900 (41fb818) +++ reference/functions/pgroonga-highlight-html.md 2016-04-24 18:17:55 +0900 (80e6027) @@ -9,4 +9,92 @@ Since 1.0.7. ## Summary -TODO +`pgroonga.highlight_html` function surrounds the specified keywords in the specified text by `<span class="keyword">` and `</span>`. HTML special characters such as `&` in the specified text are escaped. + +## Syntax + +Here is the syntax of this function: + +```text +text pgroonga.highlight_html(target, ARRAY[keyword1, keyword2, ...]) +``` + +`target` is a text to be highlighted. It's `text` type. + +`keyword1`, `keyword2`, `...` are keywords to be highlighted. They're an array of `text` type. You must specify one or more keywords. + +`pgroonga.highlight_html` markups the keywords in `target`. It's type is `text` type. + +The keywords are surrounded with `<span class="keyword">` and `</span>`. `<`, `>`, `&` and `"` in `target` is HTML escaped. + +## Usage + +You need to specify at least one keyword: + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + ARRAY['PostgreSQL']); +-- highlight_html +-- ------------------------------------------------------------------ +-- PGroonga is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +You can specify multiple keywords: + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + ARRAY['Groonga', 'PostgreSQL']); +-- highlight_html +-- ----------------------------------------------------------------------------------------------- +-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +You can extract keywords from query by [`pgroonga.query_extract_keywords` function](pgroonga-query-extract-keywords.html): + +```sql +SELECT pgroonga.highlight_html('PGroonga is a PostgreSQL extension.', + pgroonga.query_extract_keywords('Groonga PostgreSQL -extension')); +-- highlight_html +-- ----------------------------------------------------------------------------------------------- +-- P<span class="keyword">Groonga</span> is a <span class="keyword">PostgreSQL</span> extension. +-- (1 row) +``` + +HTML special characters are escaped automatically: + +```sql +SELECT pgroonga.highlight_html('<p>PGroonga is Groonga & PostgreSQL.</p>', + ARRAY['PostgreSQL']); +-- highlight_html +-- --------------------------------------------------------------------------------------- +-- <p>PGroonga is Groonga & <span class="keyword">PostgreSQL</span>.</p> +-- (1 row) +``` + +Characters are normalized: + +```sql +SELECT pgroonga.highlight_html('PGroonga + pglogical = replicatable!', + ARRAY['Pg']); + highlight_html +------------------------------------------------------------------------------------------------ + <span class="keyword">PG</span>roonga + <span class="keyword">pg</span>logical = replicatable! +(1 row) +``` + +Multibyte characters are also supported: + +```sql +SELECT pgroonga.highlight_html('10㌖先にある100ｷﾛグラムの米', + ARRAY['キロ']); +-- highlight_html +-- --------------------------------------------------------------------------------------- +-- 10<span class="keyword">㌖</span>先にある100<span class="keyword">ｷﾛ</span>グラムの米 +-- (1 row) +``` + +## See also + + * [`pgroonga.query_extract_keywords` function](pgroonga-query-extract-keywords.html) -------------- next part -------------- HTML����������������������������...Download
