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

Как отредактировать 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.

 

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

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

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

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

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual

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

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

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

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

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

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

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
вычитка текста

Как вычитать свой текст: инструкция для …

В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и...

Читать полностью...
качество текста

Как повысить качество текста инструкций

Каждый автор знает: во время написания и правки текста глаз замыливается. Смотришь в текст и читаешь не то, что написано, а то, что хочешь видеть. В этой статье я расс...

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

Закон построения нехудожественного текст…

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

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

Примечания и предупреждения в тексте инс…

Важную информацию в тексте можно выделять по-разному. Можно целые предложения оформлять жирным, подчеркнутым и курсивным шрифтом. Можно написать все слова в предложени...

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

Методика чтения научных книг

Я не люблю брать в руки разрисованные книги. Текст исчиркан, подчеркнут, зачеркнут. Ручкой, карандашом, маркером. Уголки страниц загнуты. На полях рукописные пометки, ...

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

Книга «Пиши, сокращай: как создавать сил…

Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв...

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

Как починить поиск в русском PDF

Начинающий пользователь Help+Manual, пишущий документацию на русском языке, рано или поздно сталкивается с ситуацией, когда в созданном PDF-документе не работает поиск...

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

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

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

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

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

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

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

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

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

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