Расширение справки

Средства работы со справкой, предусмотренные в платформе Eclipse, предоставляют базовые функции для расширения платформы дополнительной документацией и ее структуризации. Ограничения на структуру и уровень подробности документации отсутствуют. Вы можете самостоятельно выбрать структуру документации и необходимые утилиты для работы с ней в соответствии с конкретными потребностями. Модуль справки описывает структуру документации с помощью файлов оглавлений (toc).

Электронная справка по модулю предоставляется с помощью точки расширения org.eclipse.help.toc. Она может входить в состав модуля исходного кода, либо поставляться в отдельном модуле документации.

Отделение документации в отдельные модули рекомендуется, если за разработку модулей и документацию к ним отвечают разные группы, либо если требуется уменьшить взаимосвязь между документацией и исходным кодом.

Расширенные функции справочной системы включают в себя контекстную справку с ссылками на справочники, а также возможность вызывать из документации исходный текст платформы. Программа просмотра справки предоставляет такие функции, как просмотр, печать и поиск документации. В версии 3.1 появилась динамическая справка и возможность объ единенного поиска информации с помощью новой панели Справка.

Далее процедура расширения справки будет рассмотрена на примере создания модуля документации.