IDOL Server 12.13

# Highlight

The modes to use to highlight text. You can use one or more of the following options. Separate multiple options with plus symbols. There must be no space before or after a plus symbol.

NOTE: If you use field restrictions with the query, IDOL Server highlights only terms in the specified fields.

- `Off`. Do not highlight.

- `Sentences`. Highlight sentences that contain link terms if they occur in a HighlightType field.

- `Terms`. Highlight all link terms that occur in a HighlightType field.

- `Proximity`. Highlight segments that match proximity expressions, if they occur in a HighlightType field. This option also highlights individual terms that are not part of proximity expressions in the original query. You can use this option only when you have set Boolean to `True`.

  NOTE: `Proximity` takes precedence over `Terms`, but the `Sentences` option takes precedence over `Proximity`.

- `SummarySentences`. Highlight all summary sentences that contain link terms.

- `SummaryTerms`. Highlight link terms that occur in summary sentences.

You must not combine the `Terms` option with the `Sentences` option, or the `SummarySentences` option with the `SummaryTerms` option.

NOTE: When you set Boolean to `True`, and you set `Highlight`, the action highlights terms according to Boolean and proximity operators. That is, it highlights a term only when it occurs in an expression that matches any proximity expressions. You can also set `Highlight` to `Proximity` to highlight the span that includes each term in the proximity expression.

Actions: | GetContent
Type: | String
Default: | Off
Example: | `Highlight=Terms`
See Also: | EndTag StartTag Boolean HighlightType configuration parameter

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Server 12.13

Topic Title: Highlight