Создание map-файлов Help ID

Чтобы связать ваше приложение с контекстной справкой, разработчику нужен мост между элементами интерфейса (кнопками, окнами) и разделами CHM-файла. Этот мост создается с помощью числовых идентификаторов (Help Context ID) и текстовых алиасов, которые назначаются каждому разделу справки.

Dr.Explain не только автоматически присваивает эти ID, но и генерирует map-файлы — готовые файлы с определениями, которые разработчик может напрямую включить в исходный код проекта.

Поддерживаемые форматы map-файлов:

• .h;
• .vb;
• .inc.

Это автоматизирует процесс интеграции: вы создаете документацию, Dr.Explain создает файл для разработчика, а пользователь получает идеально работающую контекстную помощь по F1.

Что такое контекстно-зависимый файл помощи?

Данный файл сопоставляет страницы вашего руководства с элементами интерфейса программы. У каждого элемента управления есть свой код или наименование. Такие же значения указаны в свойствах разделов в документации. Таким образом, программа, используя функции Microsoft HtmlHelp API, может открыть файл-помощи именно на разделе, связанном с определенным элементом ее графического интерфейса.

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

Как создать map-файл Help Context ID в Dr.Explain?

Создать map-файл можно через главное меню при помощи экспорта в формат CHM:

Или выбрав иконку "Создать CHM" в панели инструментов, или нажать сочетание клавиш Alt+Shift+M:

Примеры пользовательских документаций, созданных в Dr.Explain

На этой странице вы можете изучить примеры реальных пользовательских документаций, разработанных в программе Dr.Explain. Ниже представлено несколько скриншотов справочных руководств не только в формате CHM, но и в других форматах:

Какие преимущества вы получите с Dr.Explain?

• Экономия времени разработчика. Вам не нужно вручную создавать и прописывать сотни идентификаторов в коде. Dr.Explain сделает это за вас одним действием.
• Гарантия целостности связей. Идентификаторы в map-файле точно соответствуют ID, назначенным разделам справки.
• Поддержка основных сред разработки.
• Прозрачность для команды. Разработчик получает понятный .h/.vb/.inc файл, а технический писатель работает с проектом документации независимо.
• Автоматизация процесса. Назначение ID, генерация map-файла — все делается в интерфейсе Dr.Explain.

Для кого подходит Dr.Explain?

• Разработчикам Windows-приложений, которым нужна стандартная контекстная помощь (F1) и которые устали вручную связывать ID с темами справки.
• Техническим писателям, работающим в связке с командой разработки. Вы готовите контент, а инструмент генерации map-файлов — это "мостик" к коду, который может использовать разработчик.
• Командам, создающим сложное ПО с сотнями окон и диалогов. Автоматизация назначения ID и создания map-файлов экономит много времени.
• Всем, кто хочет, чтобы документация была не просто файлом, а частью продукта. Правильно интегрированная справка повышает качество и удобство ПО.

Пользователи о создании map-файлов в Dr.Explain

"Создав CHM, мы можем легко добавить его в наши приложения .NET."

Алекс Мьюир, управляющий директор компании Database Software Solutions Ltd

Интервью с Алексом

Часто задаваемые вопросы

Смотрите также

• Интегрируйте Help-файл в ваше приложение
• Автоматическое назначение Help Context ID идентификаторов разделам
• Поддержка идентификаторов контекстной справки