среда, 22 декабря 2010 г.

Подключение модуля справки MySQL Reference Manual к справочной системе Eclipse

Цель: подключить модуль руководства MySQL Reference Manual к справочной системе Eclipse.
В результате получаем:
  • единообразный, стандартный для платформы Eclipse доступ к справочным данным;
  • возможность поиска в документации.
Выглядит это как показано на рис. 1.
Рисунок 1
Этапы решения задачи.

  1. Загружаем подходящий файл руководства в формате "Eclipse Doc Plugin" с сайта dev.mysql.com. Да. Oracle позаботилась о возможности интеграции MySQL Reference Manual в Eclipse.
  2. В простейшем случае разархивируем содержимое загруженного файла (у меня это каталог com.mysql.refman_5.5.en) в каталог plugins платформы Eclipse (см. рис 2). И получаем желаемый результат - файл справки станет доступен по команде Help > Help Contents. Возможно Eclipse потребуется перегрузить. В простейшем случае задача решена. Поздравляю!


Рисунок 2
Но! Как всегда совершенству нет предела. MySQL Reference Manual состоит из множества html файлов, которые занимают около 40 Мб дискового пространства. Воспользуемся возможностью системы справки Eclipse, которая позволяет работать с zip архивами. Создадим архив с названием doc.zip, который содержит всё содержимое каталога com.mysql.refman_5.5.en, кроме файлов plugin.xml и toc.xml. Результат показан на рис. 3.
Рисунок 3
Теперь всё руководство состоит из трех файлов и занимает менее 19 Мб на жестком диске.

Порядок действий не описан на сайте dev.mysql.com. С единственным документом, который и позволил найти решение задачи, можно познакомиться здесь.

Несколько сложнее интегрировать PHP manual. Инструкция находится здесь.

Комментариев нет:

Отправить комментарий