Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, технические переводчики, а также другие специалисты, занимающиеся разработкой и локализацией программного обеспечения, нередко сталкиваются с необходимостью внести изменения в CHM-файл. Если есть исходник, это не представляет особых проблем. Если исходника нет, внесение изменений в CHM — непростая, но решаемая задача. Продолжая тему работы с форматом HTML Help (CHM), я расскажу о том, как отредактировать CHM-файл, если нет исходника.
Кому и когда это может понадобиться
Представьте себе такую ситуацию: выходя на новое место работы, вы получаете задачу обновить пользовательскую документацию. На первый взгляд, все просто и понятно. Но, как известно, дьявол кроется в деталях. На входе есть CHM-файл, рабочие сборки программы, список закрытых программистами задач в Jira или Redmine и дата, например, дата очередного релиза. Исходника (проект, из которого справка была собрана) нет. Связи с автором нет. Времени на создание проекта справки с нуля тоже нет. Как технический писатель я оказывался в подобном положении, и не один раз.
У технических переводчиков также порой возникает необходимость отредактировать CHM-файл. Иногда в переведенном на русский язык файле справки остается несколько абзацев или несколько рисунков с текстом на английском языке. Иногда на языке оригинала выводится текст всплывающих подсказок или название раздела в содержании. И вроде бы перевести пару строк текста – минутное дело. А вот как вставить текст и рисунки в CHM-файл, если все нужно сдать сегодня к концу дня?
Похоже, что тема редактирования CHM стала тем «хорошо забытым старым», что сегодня, зимой 2019 года, является тем «новым». Действительно, обзоры инструментов для работы с форматом CHM, датированные 1990ми-2000ми годами, частично утратили свою актуальность. Часть программ, о которых в них идет речь, уже не существует. Поэтому давайте рассмотрим два основных способа редактирования справки в формате HTML Help (CHM). Первый способ предполагает использование бесплатного программного обеспечения, второй — профессионального платного.
Пример
Разберем оба способа на конкретном примере: возьмем файл api.chm. Это часть справки, встроенной в HTML Help Workshop. После установки данной программы этот файл вы найдете в папке: C:\Windows\Help. Дополним текст в разделе About pop-up Windows (в Overview / Window Types) текстом на английском языке. Заменим в разделе About the HTML Help Viewer (в Overview / Window Types) рисунок на рисунок с переводом, вставим текст на русском языке и переведем название раздела в содержании.
Таким образом, на входе есть:
- Файл справки в формате chm на английском языке.
- Функционал справки: содержание, указатель, расширенный поиск, избранное.
- В разделах, которые необходимо отредактировать: текст, 2 ссылки и рисунок с текстовыми выносками и тремя активными областями (по щелчку на экран выводятся всплывающие подсказки с текстом).
Задачи:
- Вставить в раздел текст на языке оригинала.
- Заменить рисунок.
- Заменить текст всплывающих подсказок на русский.
- Заменить английский текст русским.
- Перевести заголовок раздела в содержании.
На выходе необходимо получить полнофункциональный файл api.chm с описанными выше изменениями.
Здесь забегу немного вперед. Так как материал получился объемным, чтобы не сокращать описание, я разделил его на несколько частей. Читать можно в любом порядке:
Часть 2. Редактирование CHM бесплатными программами.
Часть 3. Декомпиляция CHM-файла.
Часть 4. Создание и настройка проекта в HTML Help Workshop.
Часть 5. Внесение изменений и сборка нового CHM-файла.
Часть 6. Редактирование CHM-файла в Help+Manual 7.
