Skip to content

Commit

Permalink
[Docs] Clarify html encoder in highlighting.asciidoc (#27766)
Browse files Browse the repository at this point in the history
The previous description was a bit confusing because the pre/post tags used for highlighting are not escaped, the rest of the content is.
  • Loading branch information
robinst authored and Christoph Büscher committed Jan 24, 2018
1 parent 67cd026 commit 0c4045b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/reference/search/request/highlighting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,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
Expand Down

0 comments on commit 0c4045b

Please sign in to comment.