Редактор контекстной справки

Контекстная справка - это механизм, обеспечивающий связь между элементами пользовательского интерфейса и соответствующими разделами справки. При активации элемента пользовательского интерфейса в области динамической справки отображается страница справки. Пользовательский интерфейс и страницы справки можно связать двумя способами: статический файл XML или динамический провайдер контекста. Для статического связывания страниц необходимо создать файл XML контекстной справки. Редактор контекстной справки помогает в процессе создания таких страниц.

Страница редактора Определение состоит из двух столбцов и содержит графическое представление файла XML. Слева расположен столбец Контекстная справка, в котором показано дерево элементов XML, а также доступны действия для их добавления, удаления и перемещения. В другом столбце приведена более подробная информация о выбранном элементе, в которую при необходимости можно внести изменения.

На странице редактора Источник отображается текстовое представление файла xml. Файл xml можно редактировать непосредственно, и изменения, если они действительны, будут отражены на графической странице Определение.

Добавление новых контекстов справки

Редактор контекстов справки с заполненными полями

Для добавления нового контекста нажмите кнопку Добавить контекст. Таким образом, в xml добавляется новая запись контекста, которая будет отображаться в структуре на странице Определение. Новый контекст будет выбран и открыт в разделе сведений в правой колонке редактора. В этом разделе сведений можно указать более подробную информацию о контексте, в частности:

Добавление разделов справки и команд

Добавление контекста в файл обеспечивает наличие динамической справки с базовым описанием, отображаемым для пользователя. Как правило, пользователю хотелось бы создавать дополнительные ссылки на связанные разделы справочной системы. Для этого необходимо добавить разделы и команды в файл xml.

Редактор контекстов справки с заполненными полями

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

Кроме разделов, можно добавлять и команды. Для пользователя команда выглядит так же, как и раздел. Но при активации ссылки не открывается файл, а выполняется команда кода. Команды служат для открытия страниц свойств и выполнения других действий.

Редактор контекстов справки - команда добавить

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

Команды Удалить, вверх, вниз

На странице Определение есть три дополнительные кнопки, с помощью которых можно изменять порядок элементов в списке контекстов и удалять ненужные элементы.

Контекст справки с кнопками

Доступны следующие кнопки:

Регистрация файла контекстной справки

Для того, чтобы файл XML контекстной справки распознавался в Eclipse как источник динамической справочной системы, его необходимо зарегистрировать с помощью точки расширения org.eclipse.help.contexts. В редакторе предусмотрен способ автоматической регистрации файла контекстной справки. В верхнем правом углу окна редактора есть ссылка "Зарегистрировать этот файл контекстной справки". Щелкнув на этой ссылке, можно добавить соответствующую запись в файл plugin.xml.