Display Settings

The table below details the display settings for a project. The name, variable name, variable type, description, and default are defined for each setting.

Note: Your Watson™ Explorer Engine search application may or may not require the configuration of these parameters. If the description of the parameters listed here does not clearly identify its potential use in your search application, please contact IBM support for clarification.
Table 1. Display Settings
Setting Name Type Description

Number of results per page

(render.list-show)

number

Maximum number of results initially displayed in the results list. The state parameter (modified when browsing the output) can modify this.

Default: 20

Number of clusters displayed

(render.tree-show)

number

Maximum number of clusters initially displayed at each level of the tree (with a "More" link to expand the list).

Default: 10

List of the maximum number of clusters shown by default per level

(render.tree-show-levels)

string

Space separated list of integers, each integer corresponds to the maximum number of clusters shown at a certain level by default. For example, setting it to '10 3' will display a maximum of 10 clusters at the top level and 3 at the second level. A value of -1 specifies no limit.

Default: -1

Ratio above which subclusters are shown by default rather than top clusters

(render.tree-show-subclusters-ratio)

number

If a subcluster has a score s1 (this score is based on the # of documents and the rank of the documents it contains), it will take priority over a cluster at the level above containing less than s1/render.tree-show-subclusters-ratio within the limits set by render.tree-show-levels. For example, setting this option to 0 will never show any subclusters. Setting it to -1 will show all possible subclusters within the limit of render.tree-show-levels.

Default: -1.000000

Maximum number of results shown for each site

(render.collapse-show)

number

When set to a value greater than 0, this option turns on "site collapsing" (see collapse-key) and limits the number of results coming from the same site that can be shown in the main search results list.

Default: -1

Ratio under which collapsing is disabled

(render.collapse-min-ratio)

number

If too many search results are collapsed (which will always be the case when the search performed is a site search), site collapsing is turned off by this option. This is the minimum ratio between the number of results shown in the main list if collapsing is turned on versus off.

Default: 0.500000

Document score ratio under which subsquent collapsed results are not shown

(render.collapse-min-doc-score-ratio)

number

In a collapsed set, subsequent results are only shown if their score is higher than this ratio times the score of the first result in the set. This is used in order to avoid promoting low score documents too much by collapsing them with high score documents.

Default: 0.700000

Insert documents in state tree

(render.tree-num-docs)

number

Maximum number of documents inserted into the tree under each node.

Default: 0

Max sources level

(render.expand-sources-max-level)

int

When offering source selection, hide all levels below this by default (the user will have to toggle them to do sub-selections).

Default: 10

Display XSL

(render.function)

string

The XSL stylesheet defined in the Display section for rendering the Watson Explorer Engine output from XML to HTML. (This XSL is saved as a function node called by the default parser.)

Default: custom-display

Advanced form sources

(render.sources)

string

List of sources (or source bundles) offered for selection in the advanced form.

Default: example-source-bundle

Input form

(render.form)

string

Name of the form (defined in the Syntax > Input Forms section) displayed. This is, in particular, the name of the default form used in the front page and all the result pages. In the default setup this variable can be set by the form CGI parameter (see the Main XML) allowing different forms to be displayed on different pages (for example, the advanced form after clicking on the "advanced search" link setting a different form parameter).

Default: simple

Input form (advanced)

(render.advanced-form)

string

Name of the form (defined in the Syntax > Input Forms section) referred to in the advanced search link (and displayed in the advanced search page by setting the form parameter, see the input form variable render.form).

Default: advanced

Display scores

(render.display-scores)

boolean

Display a score (from 0 to 100%) with each result.

Default: false

Display language

(render.language)

enum

The language used for all text in the end-user display.

Default: english

Hide user profile tabs

(render.hide-profile-tabs)

separated-enum-set

Toggle hiding of the tabs displayed on a user's profile page

Default: none

XSL parser

(render.parser)

string

The name of the XSL parser used to convert the XML state into HTML. Note that by default this loads the function defined by render.function and the XSL defined by render.extra-xsl. It is unlikely that you need to change this variable.

Default: query-meta

Display XSL for preferences pages

(render.preferences-function)

string

The XSL stylesheet defined in the Display section for rendering the preferences pages of the user interface.

Display alerts of project type

(render.alert-projects)

enum

Choose which of the user's alerts will be shown.

  • All Alerts: Show alerts created with any project
  • Current Project: Show only alerts that were created in the current project
  • (other): Specify alerts from which projects to display

Alerts for the current project and alerts with no project attribute will always be shown regardless of what this variable is set to.

Default: unset

Additional XSL code

(render.extra-xsl)

string

XSL code which will be added dynamically to the default XSL parser. Convenient to change the layout when reclustering.

Quirks mode

(render.quirks-mode)

boolean