Об осуществлении контекстной справки

Windows теперь имеет множество разных технологий контекстно-зависимой справки. Вообще, осуществление этих технологий - задание программистов. Они должны написать запросы, которые обращаются к определенным разделам в вашей справке, и синтаксис этих запросов зависит от формата справки (WinhelpЗаметьте, что Windows Vista не поддерживает Winhelp. Если Вы хотите быть совместимым с Vista, Вы должны перейти к другому формату справки. или Справка HTML) и языка программирования, который они используют.

Контекстно-зависимая справка полностью поддерживается только в Winhelp (.HLP) и Справке HTML (.CHM). Однако, также возможно сделать ограниченные контекстные запросы в Броузерной справке, сгенерированной Help & Manual. См. Контекстные запросы в Броузерной справке для деталей.

Бесплатные обучающие программы и инструменты контекстно-зависимой справки для программистов:

То, как осуществлены технологии контекстно-зависимой справки, описанные здесь, изменяется в зависимости от языка программирования, который Вы используете. Коллекция бесплатных обучающих программ для программистов доступна на странице обучающих программ на web сайте EC Software. Эти учебники охватывают осуществление контекстно-зависимой справки и связь с помощью интерфейса с файлами справки, сгенерированными Help & Manual в Delphi, Visual Studio (VB и C++), MS Access, Visual Objects, Clarion, APL, Visual Foxpro и REALbasic.

Вы можете также интересоваться EC Software Help Suite (EHS), бесплатным пакетом инструментов для того, чтобы связать с помощью интерфейса со справкой для программистов Delphi Borland и Borland C++. EHS особенно полезен для того, чтобы осуществить все виды контекстно-зависимой справки с полным исходным кодом. Это доступно на странице ресурсов Delphi на web сайте EC Software, где Вы можете также загрузить всестороннюю бесплатную обучающую программу по интеграции справки в приложения Delphi.

Ваше задание как автора справки

Есть множество вещей, которые Вы должны сделать, как автор справки, чтобы работала контекстно-зависимая справка:

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

Ваши программисты нуждаются в способе обратиться к разделам в справке. Это относится одинаково к разделам в основной справке, которые вызывают всю справку, и всплывающим разделам, к которым обращаются индивидуально.

Программы обращаются к разделам в вашей справке с ID раздела и/или числами справочного контекста, оба из которых сохранены во вкладке Опции раздела каждого раздела в Help & Manual. Когда Вы планируете ваш проект справки, Вы должны говорить с программистами и узнавать, что они хотят использовать, и не должны ли они использовать специальные форматы. (Некоторые языки программирования требуют специальных форматов для ID раздела или определенных диапазонов чисел для чисел справочного контекста.)

Префиксы ID раздела:	Если ваши программисты требуют специальных префиксов ID раздела, Вы можете применить их к ID новых разделов автоматически. Только пойдите Проект > Свойства проекта > Общие cвойства > ID раздела и контекстная справка, и вставьте префикс, который Вы хотите использовать, в области Префикс ID раздела.
Автогенерация чисел справочного контекста:	Help & Manual может также генерировать и применить числа справочного контекста к новым разделам автоматически. Найдите Проект > Свойства проекта > Общие свойства > ID раздела и контекстная справка, чтобы установить эту особенность.
Применение чисел справочного контекста к существующим разделам:	Вы можете также применить числа справочного контекста к существующим разделам и импортировать "файлы карты справочного контекста" со списками контекстных чисел, предоставленных вашими программистами. См. Инструмент контекста справки для деталей.
Изменение ID раздела:	Не отчаивайтесь, если Вы обнаруживаете, что Вы использовали неправильный формат ID раздела! Вы можете редактировать ваши ID раздела в любое время, Help & Manual обновляет все внутренние ссылки автоматически. См. Изменение ID раздела для деталей.

Планирование вашей структуры для контекстно-зависимой справки

Прежде, чем Вы начинаете писать, Вы также должны планировать вид контекстно-зависимой справки, которую Вы собираетесь использовать. Например, если диалоги в приложении собираются иметь кнопку Справка, Вы должны иметь соответствующие разделы для ссылок этих кнопок из всех уместных диалогов. Это может показаться тривиальным, но весьма просто это забыть!

Планирование использования контекстно-зависимых всплывающих разделов

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

Когда они используются таким образом, они отображены в их собственном небольшом окне, которое закрывается после того, как пользователь прочитал содержание, не отображая всю справку. Они обычно используются для справки Что это?, но к ним можно также обратиться кнопками и т.д. (Чтобы видеть пример этого, щелкните правой кнопкой мыши на какой-нибудь кнопке или управлении в Help & Manual и выберите Что это? в контекстном меню.)

Если Вы собираетесь использовать контекстно-зависимые всплывающие разделы, они требуют некоторого осторожного планирования. Между прочим, Вы нуждаетесь в полном списке всех управлений и других элементов программы, для которых Вы хотите сделать контекстно-зависимое всплывание, наряду со всеми ID раздела и/или числами справочного контекста, которые собираетесь использовать, чтобы обратиться к ним.

Автогенерация ваших контекстно-зависимых всплывающих разделов

Так как вообще этих разделов много, создание их вручную может требовать много работы, и Вы вероятно начнете жалеть, что не можете генерировать их автоматически. Хорошо, Вы можете!

Все, что Вы должны сделать, - получить "файл карты справочного контекста" от программиста со списком ID разделов и чисел справочного контекста (если применимо). Как только Вы имеете это, Вы можете автоматически генерировать все всплывающие разделы в Help & Manual, вместе с соответствующими ID и числами справочного контекста.

·	См. Автогенерация контекстно-зависимого всплывания для деталей.

См. также:

Использование контекстно-зависимой справки

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

Создание всплывающих разделов

Изменение ID раздела