search

Note: This documentation is for an old version of Webinator. The latest documentaion is here.

This performs a normal search based on the query/queries provided.

Parameters:

The following parameters can be provided to further refine the search:

urlQuery - Used for URL Prefix queries. Corresponds to the default search interface's uq query-string variable (here).
depthQuery - the maximum depth that would be allowed. Supplying a value of 3 would only return pages that are no more than 3 clicks away from a Base URL. Corresponds to the default interface's dq variable.
categoryQuery - numeric index for a category to use. 1 is the first category, etc. Corresponds to the default interface's cq variable.
proximity - specifies a required proximity for the words in the query. Corresponds to the default interface's prox variable. Possible values are:
- page - words must occur on the same page (default)
- paragraph - words must occur in the same paragraph
- sentence - words must occur in the same sentence.
- line - words must occur on the same line.

The search function may also use the rankKnobs structure (section 5.19.8, here).

The search function may also take a number of Additional Field parameters, as described in the Searching Additional Fields section (here).

The output of the function is described in the XML Elements in Search Results section (6.8, here).