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

Редактирование 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-файлы, а также оцените возможности данного метода на практике.

 

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

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

Как вставить тесты в CHM и WebHelp…

Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...

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

Оформление рисунков в Help+Manual при по…

Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...

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

Подключение таблицы стилей к проекту Hel…

При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...

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

Формулы в HTML Help (CHM)

Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и по...

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

Импорт документов MS Word в Help+Manual…

Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...

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

Поиск в WebHelp находит удаленные раздел…

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

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

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

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

Как поддерживать скриншоты в актуальном …

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

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

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

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

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

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

Размер и расположение окна CHM при перво…

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

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

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

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

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

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

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

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

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

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

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

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

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

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

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

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