Skip to content

docs: Clarify html encoder #27766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 24, 2018
Merged

docs: Clarify html encoder #27766

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a75929
docs: Clarify html encoder
robinst Dec 12, 2017
129dc1d
docs: Rephrase html encoder description some more
robinst Jan 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/search/request/highlighting.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just checked that for "html" not only text between highlight tags gets escaped, but the whole snippet. I think you could also change "text" here to "text snippet" or just "snippet". Would that make more sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it's a bit confusing because "highlighted text" could also refer to all the text that is being highlighted (as opposed to the text between the highlighting tags).

`default` (no encoding) or `html` (escapes HTML highlighting tags).
`default` (no encoding) or `html` (encodes the content as HTML, but not 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