Полезная информация

На IRC-канале #mozilla-ru можно получить техническую консультацию онлайн и, конечно же, порцию общения.
 

Создание собственного поискового плагина

Firefox 2.x (Opensearch)

В версии Firefox 2.x появилась поддержка спецификации поисковых плагинов Opensearch. Как и в предыдущей версии, поисковый плагин описывается с помощью XML-файла. В тоже время раньше иконка хранилась в отдельном файле, теперь же она записывается в XML-файл в кодировке base64. Таким образом, теперь не достаточно простого текстового редактора для создания плагина.
Примечание Далее не будет рассказываться о самом формате Opensearch и его особенностях в Firefox. Будут рассмотрены только инструментальные средства для создания поисковых плагинов. Если вас интересует более подробная информация, см. ссылки внизу этой страницы.

Добавление поисковика через панель поиска

В простейшем случае добавить поисковый плагин в панель поиска Firefox очень легко. Браузер определяет поисковые формы и предлагает их добавить в списке доступных плагинов (например “Добавить ”Яндекс.Словари“). К сожалению, этот способ работает не всегда. Так, поисковые формы таких крупных сайтов как RuTube.ru и VKontakte.ru Firefox не находит.

Утилита Opensearch editor

Для работы с этим форматом была написана специальная программа Opensearch editor. Она позволяет создать поисковые плагин обладая минимальными знаниями о формате. Для работы программы необходимо скачать и установить версию Java не ниже 6. Для проверки, какая Java установлена в системе достаточно ввести в командной команду

java -version

В результате вы должны увидитеть что-то похожее на следующее:

java version "1.6.0"
Java(TM) SE Runtime Environment (build 1.6.0-b105)
Java HotSpot(TM) Client VM (build 1.6.0-b105, mixed mode, sharing)

Скачать свежую версию Java для вашей системы можно отсюда. Установка программы заключается в скачивание последней версии и распаковывания архива. В среде Windows XP программу можно запусить двойным щелчком мыши по файлу opensearch.jar. В среде Linux выставив права на выполнение скрипту run.sh или из командной строки:

java -jar opensearch.jar.

После этого необходимо заполнить информацию о информационном плагине и нажать кнопку ”Save search engine“. Далее кратко рассмотрены свойства плагина. Снимки экрана программы доступны на Sourceforge странице проекта

Общая информация

Снимок экрана (Общая информация и вкладка URL)

  • Short name - название плагина, которое будет отображаться в списке поисковых плагинов. Как правило, сюда помещают имя сайта.
  • Description - более развернутое описание сайта, для которого сделан плагин. В Firefox не используется.

URL

Вкладка с информацией по строке поиска и результате вывода. Нужно заполнить все поля.

  • Type - тип результата. Как правило, следует оставить значение по умолчанию - ”text/html“
  • Template - шаблон строки поиска. На данный момент поддерживается только GET-метод. Когда браузер осуществляет поисковый запрос, он заменяет подстроку {searchTerms} на введенный пользователем текст. Таким образом, в шаблоне нужно указать место, куда будет подставлен запрос пользователя. Делается это обычно просто. На сайте в строку поиска вставляется текст, я обычно использую слово тест и осуществляется запрос. В сроке адреса обычно появляется нечто вроде: rutube.ru/search.html?search=test&x=17&y=6. После этого заменяем слово ”test“ на ”{searchTerms}“. В Openearch Editor можно выделить слово test и нажать кнопку ST.

Image

Снимок экрана На этой вкладе достаточно выбрать изображение. Изображение сохраняется в XML-файл в формате base64, текст которого выводится в поле вывода.
Рассмотрим получение картинки, которая будет отображаться в списке поисковиков. Первый способ, который работает на большинстве сайтов - запросить ресурс favicon.ico: http://www.yandex.ru/favicon.ico Бывает, что такой фокус не проходит (например, на Mozilla.ru). Тогда смотрим исходный код страницы и ищем что-то вроде:

  <link rel="icon" href="/mozilla-16.gif" type="image/gif" />

Здесь указывается имя ресурса, который необходимо загрузить.

Firefox

Снимок экрана Название этой вкладки подчеркивает, что данные настройки поддерживаются только в браузере Firefox.

  • Update URL - адрес, по которому будет проверятся наличие свежего поискового плагина;
  • Update interval - через какое количество дней Firefox должен проверять наличие новой версии плагина;
  • Search form - форма расширенное поиска на сайте. На данный момент этот параметр не используется;
  • Icon update URL - адрес, по которому будет искаться новая иконка. Имеет смысл сделать адрес на сервере, для которого написан плагин (на его favicon);

Author

Снимок экрана Информация о создателе поискового плагина. Браузером Firefox не используется.

  • Developer - имя разработчика;
  • Attribution - ?
  • Contact - как можно связаться с разработчиком. Обычно это адрес электронной почты.

Firefox 1.x

Поисковый плагин состоит из двух частей — непосредственно файл со скриптом (.src) и картинка к нему (.gif, .png).

Для начала рассмотрим получение картинки, которая будет отображаться в списке поисковиков. Первый способ, который работает на большинстве сайтов - запросить ресурс favicon.ico: http://www.yandex.ru/favicon.ico Бывает, что такой фокус не проходит (например, на Mozilla.ru). Тогда смотрим исходный код страницы и ищем что-то вроде:

<link rel="icon" href="/mozilla-16.gif" type="image/gif" />

Здесь указывается имя ресурса, который необходимо загрузить. После получения файла, его нужно преобразовать в формат gif или png. Для этого можно воспользоваться бесплатной программой IrfanView.

Теперь перейдем к редактированию файла скрипта. Рассмотрим для примера файл FindBookru.src — обычный XML файл:

<SEARCH
version = "7.1" 
name="FindBook.Ru"
description="FindBook.Ru name Search"
method="GET"
action="http://findbook.ru/search/d0"
queryCharset="windows-1251"
>
<input name="pvalue" user>''
<interpret  
browserResultType="result" 
resultListStart="<!-- web search results -->" 
resultListEnd="<!-- /web search results -->" 
resultItemStart="<li value=" 
resultItemEnd="&nbsp;|&nbsp;"
charset="windows-1251"
language="ru"
country="RU" 
>
</search>
<BROWSER
update="http://jgmgd.narod.ru/ffsearch/FindBook.Ru.SRC"
updateIcon="http://jgmgd.narod.ru/ffsearch/FindBook.Ru.jpg"
updateCheckDays="3"
>

Файл делится на две части — SEARCH и BROWSER. Часть SEARCH отвечает за процесс поиска и обработки запроса, а часть BROWSER содержит параметры автообновления плагина.

Рассмотрим поподробнее часть SEARCH:

version — всегда должно быть значение 7.1
name — имя поисковой системы
description — краткое описание поисковика (чего ищет и т. п.)
method — метод передачи формы
action — URL поисковой системы указывается вплоть до запроса поиска (обычно начинается со знака вопроса)
queryCharset — кодировка, в которой будет посылаться запрос
<input name=”pvalue“ user> — эта строка описывает запрос, в нашем случае это pvalue. Как определить запрос — заходим в поисковик, набираем там случайный запрос (желательно на английском), ищем, смотрим полученный URL и находим в нем то слово, которое мы искали. Перед ним будет переменная запроса, она то нам и нужна.

http://findbook.ru/search/d0?ptype=1&pvalue=мой_запрос&r=0&s=1&viewsize=15&startidx=0

Создание поискового плагина с помощью расширения

С помощью расширения Search Engine Ordering можно создать собственный поисковый плагин без редактирования файла (.src) текстовым редактором.

Для этого нужно:

1. Выбрать из контекстного меню формы поиска пункт ”Добавить поисковую систему“.
2. В окне диалога добавления поисковой системы выбрать имя и картинку и нажать ”Ок".

 
  firefox/search_plugins/mading_plugins.txt · Последние изменения: 2008/08/26 22:15
 

Board footer

Powered by PunBB
Modified by Mozilla Russia
Copyright © 2004–2011 Mozilla Russia
Язык отображения форума: [Русский] [English]