IDOL Server 24.2

# 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.

  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.

If you set the AgentBooleanField parameter for your query, you can also use the following options:

- `AgentBoolSentences`. Return documents with an additional `autn:highlighted` field, which contains the query text with highlighting for all sentences that contain words matched by the specified AgentBooleanField.

- `AgentBoolTerms`. Return documents with an additional `autn:highlighted` field, which contains the query text with highlighting for all terms that match the specified AgentBooleanField.

NOTE: By default, highlighting does not take proximity matching into account. It highlights a term or sentence each time it occurs, even if a particular occurrence does not match the query proximity expression.

The `Proximity` option highlights the span that includes each term in the proximity expression, excluding any occurrences of terms that do not match the proximity expression. For example, when highlighting the expression `cat NEAR dog`, it does not highlight occurrences of cat that are not near an instance of dog. However, for the expression `fish OR cat NEAR dog`, it highlights all instances of fish, as well as expressions that contain cat near dog.

Actions: | Query
Type: | String
Default: | Off
Example: | `Highlight=terms`
See Also: | AgentBooleanField EndTag StartTag HighlightType configuration parameter

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.2

Topic Title: Highlight