honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Docs] Clarify `html` encoder in highlighting.asciidoc (#27766) 

The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
This commit is contained in:
Robin Stocker 2018-01-25 02:45:40 +11:00 committed by Christoph Büscher
parent a1c40b05cb
commit 64bbb3a235
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/search/request/highlighting.asciidoc
View File

@ -142,8 +142,9 @@ You can specify the locale to use with `boundary_scanner_locale`.
boundary_scanner_locale:: Controls which locale is used to search for sentence
and word boundaries.
encoder:: Indicates if the highlighted text should be HTML encoded:
`default` (no encoding) or `html` (escapes HTML highlighting tags).
encoder:: Indicates if the snippet should be HTML encoded:
`default` (no encoding) or `html` (HTML-escape the snippet text and then
insert the highlighting tags)
fields:: Specifies the fields to retrieve highlights for. You can use wildcards
to specify fields. For example, you could specify `comment_*` to