IDOL Server 24.2

# Highlight

Allows you to highlight link terms in the text that you submit.

Set Text to the text that you want to highlight. You can also submit an IDX or XML document. In this case, you must set TextParse to `True`.

Set Links to the terms that you want to highlight in the specified Text. You can provide a list of stemmed terms, or you can specify a query string. If you specify a query string, you must also set Boolean to `True`. You must also set Boolean to `True` if you use the case-sensitive term operator (`~Term`).

## Example

    http://12.3.4.56:9000/action=Highlight&Text=Gene analysis discovered methods to determine the exact sequence of nucleotides that compose a specific gene&Links=nucleotid+gene+analysis

This action sends the specified text to IDOL Server, which returns a version of the submitted text, highlighting all terms that stem from the links `nucleotid`, `gene`, and `analysis`.

XML output:

    Gene <font color="red">analysis</font> discovered methods to determine the exact sequence of <font color="red">nucleotides</font> that compose a specific <font color="red">gene</font>

The XML output also an `<autn:highlighted>` tag to indicate whether any of the text was highlighted.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Links | The terms to highlight in the Text.
Text | The text to highlight.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Boolean | The format of the terms in Links.
DefaultOperator | The default operator to use between query terms in the text. You can use this parameter only if you set Boolean to `True`.
DetectLanguageType | Whether to detect the language type of the text.
EndTag | The end HTML tag to apply to highlighted terms.
FieldText | Add a field restriction to results.
FieldRestriction | Restricts a query to specified fields. You can use this parameter only if you set Boolean to `True`.
HardFieldRestriction | Whether to use only the fields that you list in the FieldRestriction parameter for matching. You can use this parameter only if you set Boolean to `True`.
Highlight | Whether to highlight link terms or sentences in the results.
HighlightTagTerm | Adds an attribute to the StartTag to indicate the term that is highlighted.
IgnoreSpecials | Treat special characters as normal characters in query syntax. You can use this parameter only if you set Boolean to `True`.
LanguageType | The language type of the terms.
MatchAllTerms | Return only results that match all terms in a query. You can use this parameter only if you set Boolean to `True`.
OutputEncoding | The encoding to convert the results to.
StartTag | The opening HTML tag to apply to highlighted terms.
Stemming | Disable stemming so that only documents that contain exact matches of query terms can return as results. You can use this parameter only if you set Boolean to `True`.
Synchronous | Whether to run the action synchronously or asynchronously.
TextParse | The format of the Text.
XMLFormat | Interprets the text as XML or HTML.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

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