§ 4. Создание chm-файлов

Определения и обозначения

Справочная система CHM — электронная справка, объединяющая HTML-страницы, изображения и навигационные средства в один скомпилированный файл. Скомпилированный значит собранный программой из подготовленных материалов. Такой формат удобен, когда пользователю нужна целая справка, а не набор разрозненных файлов.

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

Файл проекта — текстовый файл с расширением .hhp, в котором задаются параметры справки и перечисляются её материалы. Его можно представить как инструкцию для программы-сборщика: в нём указано, что именно и как нужно объединить. Если проекта нет, программа не получит полного описания будущей справки.

Файл содержания — файл .hhc с иерархическим перечнем разделов справки, по которому пользователь переходит между страницами. Иерархический перечень показывает, какие темы главные, а какие относятся к ним. Это помогает читателю ориентироваться в материалах, даже если HTML-страниц несколько.

Как это устроено

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

Затем создают файл проекта .hhp, потому что одной папки с HTML-документами недостаточно для сборки. В проекте указывают главную страницу, список HTML-файлов и параметры будущего CHM. По этому описанию программа определяет, какие материалы включить и с какой страницы открывать справку.

Чтобы пользователь мог переходить к разделам в удобном порядке, составляют файл содержания .hhc. В нём задают перечень тем и их вложенность, например разделы внутри общей темы. Если нужен поиск по ключевым словам, дополнительно создают файл указателя .hhk: он выполняет другую задачу и не заменяет содержание.

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

После проверки HTML Help Workshop компилирует проект и создаёт единый файл .chm. Сборка объединяет подготовленные материалы, но сама по себе не гарантирует, что навигация настроена правильно. Поэтому готовую справку открывают и проверяют: переходят по разделам, открывают страницы и смотрят, отображаются ли изображения.

Файлы, используемые при создании справки CHM

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

Разбор задач

Одна HTML-страница

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

1. Подготовь HTML-страницу с текстом справки и сохрани её в рабочей папке. Проверь, что страница открывается и её имя записано без ошибок.
2. Создай файл проекта .hhp и укажи в нём главную страницу и HTML-файл, который нужно включить. Проверь пути: если файл лежит в другой папке, проект должен ссылаться на правильное расположение.
3. Открой проект в HTML Help Workshop и выполни компиляцию. После сборки найди созданный .chm и открой его, чтобы проверить, что страница отображается.

Ответ. Для получения CHM нужны HTML-страница и проект, указывающий эту страницу как главную и включающий её в справку. Программа компилирует проект в один файл .chm. Итог проверяют, открывая его и просматривая страницу.

Три страницы в заданном порядке

Условие. Нужно собрать справку из трёх HTML-страниц так, чтобы разделы отображались в заданном порядке. Перечислить страницы в проекте важно для включения материалов, но сам порядок навигации читатель видит в содержании. Значит, требуется настроить и проект .hhp, и файл .hhc.

1. Подготовь три страницы и проверь, что каждая открывается отдельно. Запиши их имена и реши, какой раздел будет первым, а какие будут идти за ним.
2. Добавь все три HTML-файла в список материалов проекта. Это нужно, чтобы компилятор включил страницы в CHM, а не оставил их только в рабочей папке.
3. В файле .hhc создай пункты содержания в требуемом порядке и свяжи каждый пункт с нужной страницей. Если темы вложены одна в другую, отрази это в иерархии содержания.
4. Скомпилируй проект и открой полученную справку. Пройди по пунктам содержания и сравни порядок открывающихся страниц с заданным.

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

Не открывается раздел с изображением

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

1. Найди страницу, на которую должен вести пункт содержания, и проверь, что её имя и расположение совпадают с указанными в проекте и .hhc. Если файл переименовали или переместили, исправь соответствующие записи.
2. Открой HTML-страницу и проверь ссылку на изображение. Сверь путь и имя файла с фактическим расположением картинки, включая папку, в которой она сохранена.
3. Убедись, что нужная страница и связанные материалы учтены в проекте. Исправь обнаруженные ошибки, затем снова скомпилируй справку.
4. Открой новый CHM, выбери проблемный раздел и проверь изображение. Если ошибка сохранилась, повторно проверь адрес страницы, ссылку на картинку и актуальность скомпилированного файла.

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

Типичные ошибки

Считать, что достаточно сохранить HTML-страницы. Это ошибка, потому что страницы сами по себе не описывают параметры и состав справки для компилятора. Её допускают, когда принимают исходные документы за готовый проект. Проверь себя: есть ли файл .hhp и указаны ли в нём главная страница и материалы?

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

Указать неверный путь к странице или изображению. Если путь неправильный, программа не найдёт материал или ссылка в готовом CHM не сработает. Ошибка часто появляется после перемещения файла или неточной записи его имени. Проверь, совпадают ли путь и имя в ссылке с фактическим расположением файла, а затем пересобери проект.

Перепутать содержание и указатель. Содержание .hhc задаёт структуру разделов и переходы между ними, а указатель .hhk помогает искать темы по ключевым словам. Путаница возникает потому, что оба файла относятся к навигации. Для самопроверки спроси себя: нужно показать порядок разделов или организовать поиск по словам?

Связь с другими темами

Для создания CHM нужно уметь создавать и просматривать HTML-страницы, а также пользоваться файлами и папками: без этого не подготовить и не проверить материалы. Гиперссылки связывают разделы, а относительные пути помогают находить страницы и изображения внутри папок проекта. Поэтому ошибки в ссылках и расположении файлов влияют на работу справки. Эти навыки пригодятся при подготовке электронных инструкций, справок и учебных материалов.

Что запомнить

• CHM — скомпилированная справка, собранная из материалов проекта.
• Файл проекта имеет расширение .hhp.
• Файл содержания .hhc задаёт структуру разделов.
• Файл указателя .hhk предназначен для поиска тем по ключевым словам.
• HTML-страницы и связанные файлы должны быть доступны по указанным путям.
• После компиляции нужно проверить навигацию и открытие материалов в готовом CHM.