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

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

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

В предыдущей статье Как отредактировать CHM-файл я обозначил цели и задачи редактирования, а также выбрал файл api.chm, который буду использовать в качестве примера. Программу HTML Help Workshop я использую, так как это родной инструмент, предоставленный разработчиком формата CHM, компанией Microsoft. Текстовый редактор Notepad++, по-моему, идеально подходит для выполнения данной задачи благодаря подсветке синтаксиса многих языков программирования и разметки, а также поддержке различных форматов и кодировок. Вместо него можно использовать любой бесплатный текстовый редактор.

Редактируя справку в формате HTML Help при помощи бесплатных программ, я придерживаюсь следующего порядка работы, который выработал на практике:

  1. Подготовка программ и материалов.
  2. Декомпиляция CHM-файла
    (извлечение из CHM редактируемых файлов; подробное описание состава CHM смотрите в материале Формат HTML Help).
  3. Создание и настройка проекта в HTML Help Workshop
    (для сборки CHM с аналогичным функционалом).
  4. Внесение изменений, сборка и тестирование
    (с поэтапной проверкой внесенных изменений).

Подготовка программ и материалов

Чтобы отредактировать CHM-справку в рамках поставленных задач, выполните следующие подготовительные мероприятия:

  1. Скачайте HTML Help Workshop по ссылке и установите с настройками по умолчанию.
  2. Запустите HTML Help Workshop из меню Пуск. Если установка прошла успешно, должно открыться окно программы следующего вида.

окно программы HTML Help Workshop

  1. Скачайте Notepad++ по ссылке и установите с настройками по умолчанию. Для выполнения описанных выше задач подойдет любой бесплатный текстовый редактор, например, Блокнот, Atom и т.п.
  2. Запустите Notepad++ из меню Пуск. Если установка прошла успешно, должно открыться окно программы следующего вида.

окно программы Notepad++

  1. Подготовьте рисунок, который необходимо вставить в Чтобы вставить текст перевода поверх оригинала, подойдет любой, в том числе бесплатный, графический редактор. Если вы работаете в ОС Windows, можно использовать Paint.
  2. Подготовьте текст на английском языке.
  3. Подготовьте переводы.

Отдельно скажу несколько слов о текстах и переводах. Для целей данной статьи можно использовать любой онлайн генератор рыбного текста, например, BlindtextGenerator. Чтобы научиться редактировать CHM, этого будет достаточно. Для не учебного проекта вам потребуется профессионально подготовленный текст, а также перевод, выполненный профессиональным переводчиком. Даже если вы самостоятельно составите текст на русском языке, пользоваться онлайн переводчиками я не рекомендую. В Интернет есть масса обзоров, в которых разбираются ошибки систем машинного перевода. Чтобы получить качественный перевод, лучше воспользоваться услугами профессионалов. Найти квалифицированного переводчика можно на онлайн биржах. Я пользуюсь бесплатным сервисом по подбору переводчиков Переводчик.me. Пробовал и другие бесплатные сервисы, но остановился на этом из-за удобного поиска и доступности ресурса. Аналогичным образом можно найти технического писателя: на биржах удаленной работы и профессиональных форумах.

За рамками целей и задач редактирования CHM, обозначенных выше в материале Как отредактировать CHM-файл, остается простое обновление справки, когда нужно что-то удалить и что-то добавить на языке оригинала. В этом случае порядок работы с бесплатными программами и процесс редактирования будет аналогичный. Здесь я также рекомендую заранее проработать изменения в структуре, написать новые тексты, сделать скриншоты. Дополнительно необходимо обозначить разделы, абзацы, предложения, которые нужно отредактировать, удалить или переместить. Для этого подойдут любые привычные средства, в том числе шариковая ручка и бумажный блокнот. Для работы со структурой рекомендую использовать средства, обеспечивающие максимальную наглядность, чтобы было видно, что было до, и что должно быть после внесения изменений. Из бесплатных программ это в первую очередь FreeMind, из платных — MindManager или EdrawMax. Для работы с текстом рекомендую использовать текстовый редактор с проверкой орфографии.

Разумеется, если вы используете Help+Manual 7, вышеупомянутого многообразия не потребуется. Встроенного визуального редактора будет вполне достаточно для оперативной переработки структуры и контента. Более того, с Help+Manual 7 эту же работу можно выполнить в 2-3 раза быстрее, так как предварительную подготовку материалов делать заранее не нужно. Данному способу редактирования CHM будет посвящена отдельная статья.

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

 

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

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

Что нового в 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-файл

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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