Запросить демо
Запросить демо

Создание файла помощи в формате CHM

02.02.2024

Содержание статьи:

Формат CHM (Compiled HTML Help) уже давно стал отраслевым стандартом для создания справочной документации к программным продуктам, работающим в операционной системе Windows. Расширение файла CHM поддерживается Windows, Mac и iOS. Главное преимущество этих файлов заключается в их совместимости с большинством стандартных веб-браузеров на любом устройстве или компьютере. Стоит отметить, что формат CHM также в электронных книгах. В отличие от обычных PDF или HTML файлы справки в формате CHM более компактны, а также интерактивны — поддерживают гиперссылки и позволяют обеспечить полнотекстовый поиск.

Используя CHM, можно организовать справочную информацию в удобную для восприятия иерархическую структуру — дерево страниц, где каждый документ является самостоятельным файлом, посвященным определенному вопросу или задаче. При этом вся документация собирается в единый файл, который можно распространять вместе с программой, что важно для максимального удобства конечных пользователей.

Сегодня процесс создания CHM-файлов максимально прост и не требует особых технических навыков и знаний благодаря таким инструментам, как Документерра — единая платформа для совместного создания и публикации внутренней и внешней документации в разных форматах, включая CHM.

Рассмотрим процесс создания CHM file в Документерре пошагово.

Создание иерархии контента с помощью дерева страниц

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

Далее необходимо выстроить удобную структуру будущей справочной системы. Начинаем с распределения материалов по тематическим блокам: создаем разделы, подразделы и статьи. Мощный полнотекстовый поиск и быстрый фильтр по названию документов ускорят процесс.

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

Не забудьте расставить перекрестные ссылки, а для облегчения поиска читателями — задать ключевые слова.

Настройка ID для создания контекстной помощи

Чтобы создать контекстную помощь при встраивании CHM в программные продукты нужно связать отдельные документы из файла и конкретные элементы приложения. 

Для этого страницам в CHM обычно присваиваются числовые значения вида «123». Иметь десятки, а иногда сотни и тысячи числовых значений — не интуитивно и создает проблемы, потому что нельзя быстро понять, какой именно документ прячется под тем или иным номером. Документерра предлагает другой подход: все документы генерируются системой автоматически и имеют человекочитаемые ID вида «kratkaya-istoriya». Это облегчает процесс настройки контекстной помощи и программистам, и техническим писателям.

Экспорт проекта в CHM-файл

Экспорт проекта в CHM в Документерре выполняется буквально в пару кликов, как и в любой другой формат. 

На странице «Проекты» найдите нужный проект и нажмите «Опубликовать». Выберите Microsoft Compiled HTML Help.chm в качестве формата и просто следуйте подсказкам мастера.

Интеграция CHM файла в приложение

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

В простейшем сценарии вы просто привязываете открытие всего CHM-файла к определенной кнопке, в более сложных — устанавливаете соответствие между нажатой кнопкой и конкретной страницей внутри файла, например. В любом случае, работая с Документеррой вы можете быть уверены в том, что результат, который открывается в окне Help Viewer перед конечным пользователем вашей справки, будет выглядеть ровно так, как задано вашими техническими писателями.

* * *

Создание справочной системы в формате CHM — важный этап разработки программного обеспечения. Компактный интерактивный CHM-файл позволяет максимально эффективно донести необходимую информацию до конечных пользователей в сети Интернет.

Благодаря современным инструментам вроде платформы Документерра, процесс создания CHM требует минимума усилий. Интуитивно понятный интерфейс позволяет быстро структурировать имеющийся контент, дополнить его медиафайлами, расставить ссылки и связи. Автоматическая генерация ID страниц упрощает последующую интеграцию CHM в приложение. 

Убедитесь в этом сами, записавшись на интерактивное демо.