Browse Source

Docs: Update highlighting.asciidoc

Added note about how to highlight on the `_all` field

Closes #7991
Clinton Gormley 11 years ago
parent
commit
6a180d1803
1 changed files with 6 additions and 0 deletions
  1. 6 0
      docs/reference/search/request/highlighting.asciidoc

+ 6 - 0
docs/reference/search/request/highlighting.asciidoc

@@ -23,11 +23,17 @@ search hit (there will be another element in each search hit, called
 `highlight`, which includes the highlighted fields and the highlighted
 `highlight`, which includes the highlighted fields and the highlighted
 fragments).
 fragments).
 
 
+[NOTE]
+==================================
 In order to perform highlighting, the actual content of the field is
 In order to perform highlighting, the actual content of the field is
 required. If the field in question is stored (has `store` set to `true`
 required. If the field in question is stored (has `store` set to `true`
 in the mapping) it will be used, otherwise, the actual `_source` will
 in the mapping) it will be used, otherwise, the actual `_source` will
 be loaded and the relevant field will be extracted from it.
 be loaded and the relevant field will be extracted from it.
 
 
+The `_all` field cannot be extracted from `_source`, so it can only
+be used for highlighting if it mapped to have `store` set to `true`.
+==================================
+
 The field name supports wildcard notation. For example, using `comment_*`
 The field name supports wildcard notation. For example, using `comment_*`
 will cause all fields that match the expression to be highlighted.
 will cause all fields that match the expression to be highlighted.