Help > Websites > Customizations > Documents

Documents

Controls how Perceptive Enterprise Search will present each document when the user selects it from the result list. This enables you to control hit-highlight, hit-to-hit navigation and other options.

Show Annotations

This option specifies that Perceptive Enterprise Search annotations are displayed as icons within the document. The user can click on the icon to view the annotation. For further information on annotations see the Query Online Help.

Show Entities

This option specifies if Perceptive Enterprise Search should markup entities in the document. When enabled, the Before Entity and After Entity will be injected around each entity.

Automatic Link Detection

Use this option when URLs appear in documents other than HTML files. This option instructs Perceptive Enterprise Search to display the generated document showing these as click-able links. For example, if a document contains:

http://www.lexmark.com

Perceptive Enterprise Search will convert the above text into a click-able hyperlink.

Automatic Email Detection

Similar to Automatic Link Detection, this option will find text that appears to be email addresses and constructs a click-able link. When a user clicks one of these links, their email client is started with the "To" field pre-populated.

Automatic Image Detection

This option will find text that appears to be image filenames and if the images are present in the document's directory and generate click-able links. The images must be in a format supported by web browsers, such as GIF, JPG or PNG.

The image filename in the document must have one of the extensions specified in "Image Extensions".

Image Extensions

Contains a list of semicolon delimited extensions that are used during "Automatic Image Detection". A standard setting may look like:

GIF;JPG;PNG;TIF
Hide Meta Data

Instructs Perceptive Enterprise Search to show only the body portion of a document when rendering, excluding any metadata or document summary information.

Hit Highlighting And Navigation

Perceptive Enterprise Search supports enhanced customization of the document view. The settings below are substituted in as found documents are rendered.

Prev Doc

Specifies the template string to use when encountering the %PREV_DOC% symbol in any of the hit templates. It may contain the following tags:

Next Doc

Specifies the template string to use when encountering the %NEXT_DOC% symbol in any of the hit templates. It may contain the following tags:

Before First Hit

Specifies the template string to use before the very first hit in the document. This is the ideal place to handle Previous document links.

Before Hit

Specifies the template string to use before all hits but the first.

After Hit

Specifies the template string to use after all hits but the last.

After Last Hit

Specifies the template string to use after the very last hit in the document. This is the ideal place to handle Next document links.

Before First Hit By Term

Specifies the template string to use before the very first hit of a given term in the document.

Before Hit By Term

Specifies the template string to use before all hits of a given term, except the first.

After Hit By Term

Specifies the template string to use after all hits of a given term, except the last.

After Last Hit By Term

Specifies the template string to use after the very last hit of a given term in the document.

After Paragraph

Specifies the template string to use between paragraphs of a document.

After Page

Specifies the template string to use between pages of a document.

Before Entity

Specifies the template string to use at the beginning of each entity.

After Entity

Specifies the template string to use at the end of each entity.

Substitution Tags:

%LINE% The current line that is being processed
%COLUMN% The current character position within the current line
%HIT_ID% The index of the current hit
%NEXT_HIT% The index of the next hit
%PREV_HIT% The index of the previous hit
%TERM% The identifier of the current term
%TERM_HIT% The index of the current term hit
%TERM_HIT_ID% The identifier of the current term hit, consisting of the TERM_HIT and TERM_HIT_ID
%NEXT_TERM_HIT% The identifier of the next hit of the same term
%PREV_TERM_HIT% The identifier of the previous hit of the same term
%HIT_COLOR_BG% The HTML color reference for the current hit
%HIT_COLOR_FG% The HTML color reference for the current hit
%ENTITY.ID% The ID of the current entity.
%ENTITY.TYPE% The type ID of the current entity (between 1 and 5).
%ENTITY.TYPENAME% The type name of the current entity (Person, Organization, etc...)
%ENTITY.COUNT% The number of occurrences for the current entity.
%ENTITY.NAME% The display name of the current entity.
%ENTITY.CORE% The core name of the current entity (display name minus salutation).
%ENTITY.INDEX% The index of the current entity.
%ENTITY.NEXT.INDEX% The index of the next occurrence of this entity.