21.4. Создание файла описания поискового расширения

Теперь необходимо разработать само поисковое расширение. Как уже отмечалось, это небольшой файл в формате xml.

21.4.1. Структура и формат файла описания OpenSearch

Файлы описания OpenSearch – это небольшие XML-файлы, содержащие описание поставщика поиска для браузера Internet Explorer 8. В табл. 21.1 описываются значения, используемые в файле описания OpenSearch.

Таблица 21.1. Файл описания OpenSearch
Значение	Описание
ShortName (обязательный параметр)	Имя поставщика поиска, отображаемое при выборе поставщика в поле мгновенного поиска.
URL (обязательный параметр)	URL-адрес для основных поисковых запросов поставщика. Необходимо указывать абсолютный URL-адрес.
Image (необязательный параметр)	Указатель на файл значка, связанного с поставщиком поиска на веб-сайте. Этот значок отображается рядом с именем поставщика в поле мгновенного поиска. Если не указан допустимый файл значка ярлыка, используется общий значок.
Suggestions URL (JSON) (необязательный параметр)	URL-адрес, по которому могут быть извлечены варианты поиска с использованием нотации объектов JavaScript (JSON).
Suggestions URL (XML) (необязательный параметр)	URL-адрес, по которому могут быть извлечены варианты поиска в формате XML.
PreviewUrl (необязательный параметр)	URL-адрес для отображения результатов в окне предварительного просмотра ускорителя.

Ниже приведен образец файла описания OpenSearch, в котором определяется тип предоставляемых поисковых служб:

<?xml version="1.0" encoding="UTF-8"?>

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"

xmlns:ie="http://schemas.microsoft.com/Search/2008/">

<ShortName>My Custom Search</ShortName>

<Image height="16" width="16" type="image/icon">

http://example.com/example.ico

</Image>

<Url type="text/html"

template="http://example.com/search.aspx?q={searchTerms}&source=IE"/>

<Url type="application/x-suggestions+json"

template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>

<Url type="application/x-suggestions+xml"

template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>

<ie:PreviewUrl type="text/html"

template="http://suggestions.example.com/search.aspx?q={searchTerms}"/>

</OpenSearchDescription>

Каждый файл описания OpenSearch должен содержать имя поставщика и URL-адрес поиска. При отсутствии этих элементов установка поставщика поиска в браузере Internet Explorer 8 будет невозможна. В строке запроса каждого URL-адреса поиска должна содержаться фраза "{searchTerms}". При использовании этого поставщика для поиска в Internet Explorer 8 фраза "{searchTerms}" заменяется строкой запроса, введенной пользователем в поле мгновенного поиска. В файл описания OpenSearch следует включать значок (аналог фавикона в браузере). Если браузеру Internet Explorer 8 не удается найти значок, указанный с помощью атрибута "Image", поставщик представляется в меню быстрого выбора с помощью общего значка .