Як створити новий CHM-файл

CHM-файли (Compiled HTML Help) — це стандарт документації програмного забезпечення для Windows. Незалежно від того, чи ви розробник, що документує свою програму, чи технічний письменник, створення структурованого файлу довідки має важливе значення. Цей посібник проведе вас через процес створення нового CHM-проекту за допомогою CHM Editor.

Примітка: Створення CHM-файлів з нуля може бути складним при використанні стандартних інструментів. CHM Editor спрощує цей процес завдяки візуальному інтерфейсу та вбудованим шаблонам.

1. Встановлення та налаштування

Спочатку переконайтеся, що у вас встановлено CHM Editor. Якщо ви ще цього не зробили, ви можете завантажити пробну версію, щоб слідувати цьому посібнику.

Після встановлення запустіть програму. Ви побачите початковий екран.

2. Створення нового CHM-файлу

Щоб створити новий CHM-файл, перейдіть до меню Файл > Створити або просто натисніть Ctrl+N.

Налаштування CHM-файлу

Діалогове вікно «Новий CHM-файл» дозволяє налаштувати вашу документацію. Він називається «проектом», тому що CHM Editor створює допоміжні файли (такі як налаштування проекту та вихідні HTML-файли) разом із фінальним скомпільованим CHM:

Назва проекту: Внутрішня назва вашого проекту довідки.
Ім'я файлу та розташування: Де буде збережено ваш проект.
Мова: Мова за замовчуванням для вашого файлу довідки.
Назва компанії та веб-сайт: Додаткові метадані, що з'являються у властивостях файлу.
Шаблон: Виберіть одну з вбудованих професійних колірних схем:
- Simple Blue — стандартний діловий вигляд.
- Simple Green — свіжий сучасний вигляд.
- Simple Orange — теплий енергійний стиль.

3. Додавання тем

Файл довідки складається з кількох тем, організованих у деревоподібну структуру. Теми — це окремі сторінки вашої документації, якими будуть переміщатися користувачі.

Крок 1: Натисніть кнопку додавання теми

Щоб додати нову тему, натисніть кнопку + на панелі навігації:

Кнопка додавання теми на панелі інструментів CHM Editor

Крок 2: Налаштуйте тему

У діалоговому вікні, що з'явиться, ви можете визначити параметри теми:

У вас є три варіанти створення теми:

Створити з новим файлом: Створює нову порожню HTML-сторінку для написання контенту. Це найпоширеніший варіант при створенні документації з нуля.
Створити без файлу: Створює заголовок розділу (папку) у змісті, який містить інші теми, але сам не має контенту. Використовуйте для організації тем у логічні групи.
Створити з існуючим файлом: Пов'язує існуючий HTML-файл з вашої системи з проектом. Корисно, якщо у вас вже є документація у форматі HTML.

Крок 3: Встановлення теми за замовчуванням

Тема за замовчуванням — це перша сторінка, яку побачать користувачі при відкритті CHM-файлу. Є два способи її встановити:

Варіант А: При створенні теми встановіть прапорець «Встановити за замовчуванням»:

Прапорець встановлення за замовчуванням при створенні теми

Варіант Б: Клацніть правою кнопкою миші на будь-якій існуючій темі та виберіть «Встановити за замовчуванням»:

Опція «Встановити за замовчуванням» у контекстному меню

Порада: Не забудьте встановити тему за замовчуванням — це сторінка, яку користувачі побачать першою при відкритті вашого файлу довідки.

4. Редагування контенту

Використовуйте панель редактора для форматування тексту, вставки зображень та створення посилань.

Використовуйте деревоподібне представлення зліва для організації ієрархії тем.
Використовуйте панель редактора справа для візуального редагування контенту.

Переклад контенту

CHM Editor включає вбудований переклад на базі Google або Bing. Ви можете перекладати контент двома способами:

Переклад виділеного тексту: Виділіть потрібний текст, виберіть цільову мову зі спадного списку та натисніть кнопку Перекласти. Це корисно для перекладу частин документації, зберігаючи решту на оригінальній мові.
Переклад всієї сторінки: Без виділення тексту просто залишайтеся на сторінці, виберіть цільову мову та натисніть Перекласти. Весь контент сторінки буде перекладено зі збереженням HTML-форматування та структури.

Примітка: Професійні перекладачі можуть використовувати CHM Editor для роботи з файлами довідки як зі звичайними документами — знання HTML не потрібно. Всі теги та форматування зберігаються при перекладі.

Порада професіонала: Ви можете експортувати файл довідки у формати PDF або Word, якщо вам потрібна документація для друку.

З налаштованим проектом ви готові створювати повноцінну документацію. CHM Editor виконує складний процес компіляції у фоновому режимі, дозволяючи вам зосередитися на написанні якісного контенту.