Windows html help files

Файлы справки (справка HTML)

Указанные ниже файлы создаются, когда вы добавляете в приложение поддержку справки типа «Справка в формате HTML», установив флажок Контекстная справка и выбрав Формат справки HTML на странице Дополнительные функции мастера приложений MFC.

Имя файла	Расположение каталога	Расположение в обозревателе решений	Описание
Имя_проекта.hhp	Имя_проекта\hlp	файлы справки HTML	Файл проекта справки. Он содержит данные, необходимые для компиляции файлов справки в файл HXS или CHM.
Имя_проекта.hhk	Имя_проекта\hlp	файлы справки HTML	Содержит индекс разделов справки.
Имя_проекта.hhc	Имя_проекта\hlp	файлы справки HTML	Содержимое проекта справки.
Makehtmlhelp.bat	Projname	Исходные файлы	Используется системой для сборки проекта справки при компиляции проекта.
Afxcore.htm	Имя_проекта\hlp	Разделы справки HTML	Содержит стандартные разделы справки для обычных команд MFC и объектов экрана. Добавьте собственные разделы справки в этот файл.
Afxprint.htm	Имя_проекта\hlp	Разделы справки HTML	Содержит разделы справки для команд печати.
*.jpg; *.gif	Имя_проекта\hlp\Images	Файлы ресурсов	Содержат изображения для различных формируемых разделов в файлах справки.

Источник

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

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

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 — обновления системы безопасности, запрет на работу из ЛС.

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

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

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 можно условно разделить на 3 части. Под строкой заголовка окна может отображаться (1) панель с кнопками Скрыть / Показать (содержание), Назад, Вперед (навигация), Домой, Печать и Параметры. Сюда можно добавить и другие, в том числе пользовательские кнопки. При необходимости автор справки может скрыть часть кнопок или все кнопки (панель).

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

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

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

Источник

About HTML Help URLs

Many of the HTML Help API commands require that you specify an HTML Help URL in the pszURL parameter.

An HTML Help URL specifies a compiled help (.chm) file or a topic within a help file. Usually, a window type in which to display the HTML Help URL is also specified.

Specifing an HTML Help URL

The following example shows the syntax to display a compiled help file:

where Helpfile.chm is the name of the compiled help file and Window name is the name of the help window in which you want the topic to appear.

To specify a topic within a compiled help file, use the following syntax:

Helpfile.chm::/Topic.htm[>Window name] 

where Helpfile.chm is the name of the compiled help file, Topic.htm is the name of the HTML file that you want to open and Window name is the name of the help window in which you want the topic to appear.

Specifying a topic file path

A compiled help file retains the folder structure in which it was organized before compilation, unless the option to compile flat has been selected.

For example, if a project is organized in three folders (one for HTML files, one for images, and one for style sheets), the help file will contain those same folders internally. The folder in which the project file resides is considered the root.

To correctly link to a topic file, you must specify the full path. The following example specifies an overview topic:

Helpfile.chm::/Html/Overview/Topic.htm[>Window name] 

where Overview is a folder within the Html folder.

Notes

• When coding an HTML tag in an HTML file, or when specifying a compiled help file path in the HTML Help ActiveX control, you must include the prefix ms-its, which determines where the help file resides on a user’s computer. The prefix ms-its is a pluggable protocol that follows standards set up by the World Wide Web Consortium (W3C). The ms-its protocol works with Microsoft Internet Explorer 4.0 or later, but is not supported in all browsers.
• The prefix mk: @MSITStore is an earlier version of the ms-its protocol that works with Microsoft Internet Explorer 3.0 or later.
• The following examples show the syntax to use when including the prefix:

ms-its:Helpfile.chm::/Topic.htm[>Window name] mk:@MSITStore:Helpfile.chm::/Topic.htm[>Window name] 

Источник