Блог технического писателя Ильи Жукова

Как отредактировать CHM-файл

Пользовательская документация для приложений, работающих в ОС 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 WindowsOverview / Window Types) текстом на английском языке. Заменим в разделе About the HTML Help ViewerOverview / Window Types) рисунок на рисунок с переводом, вставим текст на русском языке и переведем название раздела в содержании.

пример CHM-файла

 

Таким образом, на входе есть:

  • Файл справки в формате chm на английском языке.
  • Функционал справки: содержание, указатель, расширенный поиск, избранное.
  • В разделах, которые необходимо отредактировать: текст, 2 ссылки и рисунок с текстовыми выносками и тремя активными областями (по щелчку на экран выводятся всплывающие подсказки с текстом).

функционал CHM-файла

 

Задачи:

  • Вставить в раздел текст на языке оригинала.
  • Заменить рисунок.
  • Заменить текст всплывающих подсказок на русский.
  • Заменить английский текст русским.
  • Перевести заголовок раздела в содержании.

 

На выходе необходимо получить полнофункциональный файл api.chm с описанными выше изменениями.

 

Здесь забегу немного вперед. Так как материал получился объемным, чтобы не сокращать описание, я разделил его на несколько частей. Читать можно в любом порядке:

 

Часть 2. Редактирование CHM бесплатными программами.

Часть 3. Декомпиляция CHM-файла.

Часть 4. Создание и настройка проекта в HTML Help Workshop.

Часть 5. Внесение изменений и сборка нового CHM-файла.

Часть 6. Редактирование CHM-файла в Help+Manual 7.

 

Добавить комментарий

Последние статьи

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

Читать полностью...

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

Читать полностью...

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

Читать полностью...

Сборка CHM-файла в Help and Manual

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

Читать полностью...

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

Читать полностью...

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

Читать полностью...

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

Читать полностью...

Как сделать качественные скриншоты

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

Читать полностью...

Внесение изменений и сборка нового CHM-ф…

Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными пр...

Читать полностью...

Создание и настройка проекта в HTML Help…

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная ч...

Читать полностью...

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

Читать полностью...

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

Читать полностью...

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

Читать полностью...

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

Читать полностью...

Дата в полном формате с месяцем в родите…

Сегодня пользовательская документация поставляется, как правило, в электронном формате и содержит дату выпуска. Ее обычно указывают в хедере, футере или в специальном ...

Читать полностью...

Корректная работа WebHelp на локальном к…

Вряд ли кто-то считает тестирование справки хоть сколько-нибудь сложной задачей. Тестирование документации вообще очень редко упоминается в профильной литературе. Мног...

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019. Охраняется законом об авторском праве.