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

Формат HTML Help

Устаревший к 1996 г. формат WinHelp был заменен на новый формат HTML Help (CHM). Его полное название — Microsoft Compiled HTML Help. Первая версия CHM вышла в 1997 г. Так как более новые форматы справки, разработанные Microsoft для замены HTML Help, так и не стали публичными, CHM сегодня остается стандартом справки для платформы Windows. Средство для просмотра CHM-файлов поддерживается во всех версиях Windows 10.

Сводная информация

Наименование:

Microsoft Compiled HTML Help (CHM) — система справки для платформы Windows.

Расширение файлов:

.chm

Платформы:

Windows 98 – Windows 10

Программа:

HTML Help Workshop

Стандартное средство для просмотра CHM файлов — hh.exe (Microsoft® HTML Help Executable). Начиная с Windows 98, оно входит в любую ОС данного семейства и располагается в папке Windows. Для вывода на экран содержимого справки hh.exe использует основные компоненты Internet Explorer. Поэтому для просмотра CHM-справки в ОС Windows достаточно, чтобы был установлен Internet Explorer.

 

Разработчик, 1-й релиз:

Майкрософт, 1997 г.

HTML Help 1.0 Beta (1996) и HTML Help 1.0. (1997) вышли под руководством системного архитектора Ральфа Уолдена (Ralph Walden).

С 1998 г. разработку возглавлял Шейн МакРобертс (Shane McRoberts).

 

История:

1996 — Анонс и выход HTML Help 1.0 Beta.

1997 — выход HTML Help 1.0 с IE4.

1998 — выход HTML Help 1.1 с Windows 98.

1999 — выход HTML Help 1.21 с IE5.

2000 — выход HTML Help 1.3 с Windows 2000. HTML Help стал обновляться с ОС Windows.

2000 – выход HTML Help 1.32 с Windows Me и IE5,5.

2001 — выход HTML Help 1.33 с Windows XP и IE6.

2002 — выход HTML Help 1.4 SDK (версия HTML Help 1.3) с Windows XP SP1 и IE6 SP1. После этого разработка была заморожена.

2004-2005 — обновления системы безопасности, запрет на работу из ЛС.

 

Формат - предшественник:

WinHelp

Формат-преемник:

Microsoft Help 2 (не публичный формат — в 2003 г. Майкрософт решила не выпускать новую платформу для справки MS Help 2).

Поддержка контекстной
справки:

Да

Возможность изменения
внешнего вида под
пользователя:

область отображения раздела – полностью;

область отображения содержания — ограниченно, но возможно.

 

Применение формата

Формат HTML Help задумывался, как система доставки информации с широким спектром применения: от разработки справки для приложений, работающих под управлением ОС Windows, до создания электронных книг и интерактивных систем обучения.

Плюсы

  • Вся информация сохранена в одном файле.
  • Небольшой размер файла (алгоритм сжатия LZX).
  • Встроенная система полнотекстового поиска.
  • Возможности форматирования HTML и
  • Единственный на сегодня формат, поддерживающий модульные системы справки (общие оглавление и указатель формируются во время запуска).
  • Единственная на сегодня система справки с
  • Безопасность — при загрузке файлов CHM из сети содержимое файла блокируется (для разблокировки требуется участие пользователя).

Минусы

  • Формат не обновляется с 2002 г., только средство просмотра для Windows 10 (32- и 64-бит).
  • Плохая документированность.
  • Отсутствие поддержки
  • Файлы CHM могут не открываться, если путь к файлу содержит кириллические символы, «_» или «#».
  • Начиная с 2005 г. работает только на локальных ПК. Файлы CHM из ЛС не открываются.

Как выглядит HTML Help

Справка в формате HTML Help — это один или несколько файлов в формате .chm. Формат HTML Help поддерживает модульные системы справки (состоящие из нескольких CHM-файлов), в которых главный CHM-файл формирует содержание во время запуска. Справка в формате CHM открывается, как правило, в одном общем окне.

справка в формате CHM (HTML Help)

Окно справки в формате CHM можно условно разделить на 3 части. Под строкой заголовка окна может отображаться (1) панель с кнопками Скрыть / Показать (содержание), Назад, Вперед (навигация), Домой, Печать и Параметры. Сюда можно добавить и другие, в том числе пользовательские кнопки. При необходимости автор справки может скрыть часть кнопок или все кнопки (панель).

Ниже в левой части окна отображается (2) навигационная панель с вкладками Содержание, Указатель, Поиск, Избранное. Навигационную панель можно временно скрыть во время работы со справкой при помощи кнопки Скрыть (Показать – снова вывести на экран). Часть вкладок может быть полностью скрыта. Например, вкладка Избранное используется очень редко и, как правило, скрывается. Аналогично можно скрыть вкладку Поиск. Вкладка Указатель скрывается только автоматически, если в файле справки нет ни одного ключевого слова.

На вкладке Содержание отображается динамическое оглавление справки: разделы и подразделы. В модульных системах справки оглавление формируется автоматически во время запуска файла. В (3) расположенной справа и занимающей большую часть окна области отображается содержимое раздела, выбранного в оглавлении. Внешний вид данной области можно полностью изменить в соответствии с предпочтениями автора или заказчика справки (фирменный стиль, дизайн-макет и т.п.).

На вкладке Указатель отображается список ключевых слов (обычные ключевые слова или K-keywords), по которым можно найти необходимую информацию и перейти в соответствующий раздел справки. При первом переходе на вкладку Указатель автоматически формируется файл поискового указателя. Он сохраняется в формате .chw в папку с файлом .chm под тем же именем, что и файл справки.

файлы HTML Help

На вкладке Поиск расположены элементы управления полнотекстовым поиском по всему содержимому файла справки. Результаты поиска также отображаются на данной вкладке. При открытии найденных разделов в области просмотра автоматически подсвечивается поисковый контекст (искомый термин или термины).

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

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

Считается, что внешний вид навигационной панели (Содержание, Указатель, Поиск) изменить практически не возможно. Стандартными средствами можно изменить тип и размер шрифта оглавления и ключевых слов, отключить значки «+» и «-», которые отображаются слева от разделов, включить пунктирную линию, показывающую древовидную структуру разделов, включить выделение разделов при наведении на них курсора, а также включить автоматическое скрытие неактивных родительских разделов. При очень большом желании можно добиться следующего результата.

справка в формате CHM

 

Как устроен HTML Help

HTML Help представляет собой скомпилированный HTML — автономный веб-сайт, сжатый алгоритмом LZX и упакованный в формат с расширением .chm. В HTML Help могут входить:

  • набор HTML-страниц;
  • стили CSS;
  • скрипты JavaScript и Visual Basic;
  • рисунки в форматах JPEG, GIF и PNG;
  • файл .hhc, содержащий оглавление справки (текст, размеченный тегами HTML);
  • файл .hhk — список ключевых слов и ссылок на разделы справки (текст, размеченный тегами HTML);
  • файл .hm — карта контекстных номеров справки;
  • другие файлы, необходимые для работы справки.

HTML Help также поддерживает ActiveX и Java.

 

Как создать HTML Help

Разработчик формата HTML Help предоставил бесплатную программу для разработки справки в формате CHM — HTML Help Workshop. Ее можно скачать по следующей ссылке: http://go.microsoft.com/fwlink/?LinkId=14188 Программа позволяет создать справку в формате CHM. Основной плюс — программа бесплатная. Основной минус — большая трудоемкость, особенно, если справку нужно поддерживать в актуальном состоянии.

Чтобы не перекапывать поле лопатой, можно воспользоваться трактором! Сегодня существует ряд коммерческих программ, позволяющих эффективно создавать и поддерживать справку в формате CHM. Самыми популярными являются Adobe RoboHelp и Help & Manual. Есть и другие, менее функциональные и менее популярные коммерческие программы, такие как HelpNDoc, различные конвертеры и т.п. Для сборки справки в формате CHM в любом случае используется компилятор hhc.exe (Microsoft HTML Help Compiler), входящий в состав HTML Help Workshop.

 

Источники и дополнительная информация:

Статья в Википедии «Microsoft Compiled HTML Help»

Страница Microsoft Help MVPs

Microsoft HTML Help Downloads

 

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

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

Что нового в 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 бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

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

Как отредактировать CHM-файл

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

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

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

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

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

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

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

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

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

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

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

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

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

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