Создание map-файлов Help ID
В Dr.Explain вы можете присвоить числовые идентификаторы (Help ID) и текстовые алиасы каждой теме справки, чтобы создать контекстно-зависимый файл помощи для вашего программного приложения. Затем вы можете создать map-файл, чтобы включить его в исходный код вашего приложения. Dr.Explain может генерировать map-файлы Help ID в трех распространенных форматах:
- .h (заголовочные файлы C++);
- .vb (map-файл Visual Basic);
- .inc (map-файл Object Pascal и Delphi).
Что такое контекстно-зависимый файл помощи?
Данный файл сопоставляет страницы вашего руководства с элементами интерфейса программы. У каждого элемента управления есть свой код или наименование. Такие же значения указаны в свойствах разделов в документации. Таким образом, программа, используя функции Microsoft HtmlHelp API, может открыть файл-помощи именно на разделе, связанном с определенным элементом ее графического интерфейса.
Например, пользователь, находясь в главном окне приложения при вызове контекстной справки, увидит перед собой CHM-руководство, открывшееся именно на странице, рассказывающей об этом окне.
Как создать map-файл Help ID в Dr.Explain?
Создать map-файл можно через главное меню при помощи экспорта в формат CHM:
Или выбрав иконку "Создать CHM" в панели инструментов:
Примеры пользовательских документаций, созданных в Dr.Explain
На этой странице вы можете изучить примеры реальных пользовательских документаций, разработанных в программе Dr.Explain. Ниже представлено несколько скриншотов справочных руководств не только в формате CHM, но и в других форматах:
Какие преимущества вы получите с Dr.Explain?
Dr.Explain избавит от необходимости использовать несколько разных инструментов: для захвата экрана, для создания аннотаций на скриншотах, для экспорта в определенный формат. Работайте над содержанием, а не над форматированием контента.
Удобство и простота использования. Автоматическое добавление аннотаций экономит время.
Стандартизация. Программа следит за наличием обязательных разделов и снабжает пояснениями по их содержанию. Автоматизировано оформление титульных листов, аннотаций.
Многоязычность. Возможность создания многоязычной документации, проверка орфографии на разных языках.
Для кого подходит Dr.Explain?
Программа подходит для широкого круга пользователей, ее ключевая особенность: автоматизированный процесс написания пользовательской документации. Причины, по которым выбирают Dr.Explain:
- нужно приложение для ПК, чтобы соблюсти конфиденциальность информации;
- нужна возможность совместной работы над одним проектом;
- нужно удобное управление структурой проекта;
- нужен экспорт в разные форматы;
- нужна гарантия длительной поддержки программы;
- нужны готовые шаблоны для быстрого начала разработки.
Пользователи о создании map-файлов в Dr.Explain
"Создав CHM, мы можем легко добавить его в наши приложения .NET."
Алекс Мьюир, управляющий директор компании Database Software Solutions Ltd
Интервью с Алексом
Часто задаваемые вопросы
Можно ли создать map-файл без специальных знаний?
Можно. Этот процесс автоматизирован. Dr.Explain позволяет создавать контекстно-зависимую справку, присваивая идентификаторы темам и генерируя map-файлы для интеграции с приложением.
Что такое контекстная справка?
Вызывая контекстную справку, пользователь получает помощь по тому элементу программы, с которым он в данный момент работает.
Можно ли создать веб-версию справочной документации?
Можно. Для этого специальных знаний не требуется.
Есть ли в программе возможность автоматической нумерации разделов?
Есть. При удалении разделов происходит автоматический перерасчет.
Можно ли редактировать созданные программой аннотации?
Можно редактировать их в программе при помощи дизайнера аннотаций.
Можно ли импортировать в программу старые документы Word и продолжить работу над ними?
Можно. При этом структура вашего документа сохранится.
Есть ли в программе возможность создать полнотекстовый поиск?
Есть.