Создание файлов справки CHM без специальных знаний
Dr.Explain создаёт скомпилированный файл (.chm) с готовой системой контекстной помощи. Разделы пользовательской документации привязываются к элементам интерфейса через Help Context ID автоматически.
Как создать файл справки CHM в Dr.Explain?
Dr.Explain поддерживает механизм Help Context ID и создаёт из вашего проекта полноценную систему контекстно-зависимой справки.
Шаг 1. Создание проекта
- Создайте новый проект или выберите один из предустановленных шаблонов пользовательской документации. Если у вас уже есть файл документации, например, в формате DOCX, вы можете импортировать его в Dr.Explain с сохранением структуры документа.
- Настройте внешний вид документа: выберите готовую тему из списка или создайте уникальный дизайн, добавив собственный CSS и JavaScript код. Настроить оформление документации можно на любом этапе работы.
Шаг 2. Добавление контента
- Заполните разделы пользовательской документации текстом, изображениями, таблицами с помощью WYSIWYG редактора. Добавьте ключевые слова. Автоматическое аннотирование возьмет на себя самую рутинную работу — описание скриншотов.
- Часто повторяющиеся фрагменты текста можно сохранить в переменных, чтобы избежать дублирования контента. Проверьте текст на ошибки встроенным инструментом проверки орфографии.
Шаг 3. Экспорт и компиляция файла CHM
- Настройте экспорт, если необходимо. Настройки можно произвести один раз и применять их в следующих проектах Dr.Explain.
- Экспортируйте документ. Программа автоматически сгенерирует Help Context ID для каждого раздела и скомпилирует .chm-файл.
Как интегрировать файл CHM в приложение Windows?
Рассмотрим пример интеграции CHM-файла, созданного в программе Dr.Explain, в .NET-приложение.
У каждого раздела в панели свойств есть поле "Имя файла", значение которого вы можете изменить на свое усмотрение. В примере ниже это значение "knopka_sokhranit".
Откройте редактор кода и у элемента интерфейса, который должен вызывать соответствующий раздел документации (раздел "Кнопка Сохранить"), пропишите значение раздела: knopka_sokhranit:
private void HlpButton_Click(object sender, EventArgs e) { Help.ShowHelp(this, "knopka_sokhranit.chm"); }
Так мы привязываем элементы интерфейса к разделам пользовательской документации.
Примеры руководств пользователя в формате CHM, созданных в Dr.Explain
Ниже представлены примеры реальных контекстных справок, созданных в программе Dr.Explain.
Какие преимущества вы получите с Dr.Explain?
Dr.Explain — это специализированная профессиональная программа, при этом ее инструменты просты для понимания и удобны в применении. Вот почему программу выбирают не только профессионалы, но и начинающие авторы. Перечислим некоторые ключевые особенности, которые помогают ускорить написание контекстных справочных файлов.
Контекстная привязка без написания кода. Dr.Explain связывает конкретные элементы интерфейса с соответствующими разделами в CHM-файле (через Help Context ID).
Полноценный поиск "из коробки". Полнотекстовый поиск доступен без необходимости ручной настройки.
Автоматизация индексации. Это означает, что программа связывает ключевые слова с разделами справки без вашего участия. Пока Dr.Explain формирует структуру перекрестных ссылок, автор фокусируется на качестве контента, а не на технической разметке документов.
Для кого подходит Dr.Explain?
Dr.Explain подходит для тех, кто пишет пользовательскую документацию для Windows-приложений. Перечислим несколько ситуаций, когда без Dr.Explain не обойтись:
- вы разрабатываете Windows-приложение и для него нужна контекстная справка;
- ваша пользовательская документация разрослась, и требуется полнотекстовый поиск;
- нужно создать многоязычную справку в едином стиле;
- нужно экспортировать пользовательскую документацию в формат CHM без знаний программирования;
- желательна бесплатная версия программы для ознакомления.
Пользователи о создании файлов справки CHM в Dr.Explain
"Dr.Explain привлек нас простотой в управлении и работе со скриншотами. Мы решили построить нашу систему на основе мастера создания скриншотов, создавая пояснения, направляющие пользователя. Работа с элементами управления на каждом скриншоте, а также возможность создания CHM- и HTML-файлов стали ключевыми моментами при выборе вашего продукта".
Роберт Сибильски, генеральный директор и главный программист компании Siborsoft
Интервью с Робертом
"Нам впервые потребовалось создать файл справки для проекта. Я провел небольшое исследование и сравнил различные инструменты для создания CHM-файлов справки, и Dr. Explain показался мне подходящим и очень простым в применении".
Рик Сзаш, программист из Damselfly Solutions Inc
Интервью с Риком
"Дал людям возможность сравнить сгенерированный CHM в Dr.Explain с другими файлами справки. Разница оказалась огромной! Комментарии, которые я получил о версии Dr.Explain, были абсолютно положительными, а о CHM-файлах, созданных в IDE, — отрицательными... CHM, созданный Dr.Explain, выглядит идеально, что повышает ценность всего проекта. Мы видим, насколько он серьезен".
Мишель Гарсия, основатель и генеральный директор компании IIM Services Agency
Интервью с Мишелем
Часто задаваемые вопросы
Как передать ID раздела из Dr.Explain в код?
В свойствах раздела укажите имя файла. Это значение вставляется в Help.ShowHelp. Пример кода приведён выше.
Можно ли настроить параметры Help Context ID?
Можно. Например, вы можете настроить префикс, преобразование регистра, правила написания алиасов.
Можно ли создавать map-файл при экспорте в формат CHM?
Можно. Окно "Управление Help Context ID" содержит целый ряд настроек.
Dr.Explain может экспортировать документ в печатные форматы?
Программа может экспортировать документ в печатные форматы DOCX, PDF.
Можно изменять оформление CHM-файла на свой вкус?
Можно. В программе имеются различные темы оформления, которые вы можете изменить.
При коллективной работе над одним документом можно защитить контент от случайного изменения другим участником?
Можно блокировать разделы от нежелательных исправлений. Заблокированные разделы доступны только для чтения.