Html help file chm

What is a CHM file?

The CHM file format represents Microsoft HTML help file that consists of a collection of HTML pages. It provides an index for quick accessing the topics and navigation to different parts of the help document. The CHM file can be searched for contents via the provided search option. CHM is Microsoft Proprietary online help file format that is often used for software documentation. In addition, it is used in several other applications like training guides, interactive books, and electronic newsletters. Most of the modern Microsoft Development environments support generating CHM documentation from information available in the application.

The unique ability of CHM file format to implement a combined table of contents and index makes it distinct over other standard HTML pages. The generated CHM file is relatively small in size and, hence, can easily be distributed with software packages. The help authoring tool, HTML Help Workshop, provides an easy-to-use system for creating and managing help projects and their related files. CHM files may include text, images, and hyperlinks; viewable in a Web browser; used by Windows and other programs as an online help solution.

CHM File Format

The final form of generated CHM file depends on how the help system is designed and whether it is destined for an application or a web site. A CHM file supports data compression with LZX compression to generate the compressed HTML files. It has the built-in search engine for quick searching of contents along with the capability to merge multiple .CHM files. A CHM file consists of a set of HTML files, a linked Table of contents and an index file.

HTML Files

Whether you are creating help topics for distribution with a program, or on the Web, the documents you author are created using a special formatting language known as Hypertext Markup Language (HTML). HTML topic files have a .htm or .html file name extension.

Although each help topic or Web page you author appears to be a document with text, graphics, or animated images on it, .htm files are actually text documents that have special HTML formatting codes. These codes, called tags, tell a browser how to display each page. Only the text that appears in a topic or Web page is actually in the .htm file. Any graphics, sounds, animated images, or other elements that appear are separate files that your HTML file points to. The browser copies or downloads the graphics, sounds, or other elements when it sees the tags telling it to do so.

Table of Contents (TOC)

The help table of contents (.hhc) file is an HTML file that contains the topic titles for your table of contents. When a user opens the table of contents in a compiled help file (or on a Web page) and clicks a topic title, the HTML file associated with that title will open.

Index File

The index (.hhk) file is an HTML file that contains the index entries (keywords) for your index. When a user opens the index in a compiled help file, or on a Web page, and clicks a keyword, the HTML file associated with the keyword will open.

HTML Help Components

HTML Help is made up of several components. These include the following:

HTML Help Workshop : a help authoring tool with an easy-to-use graphical interface for creating project files, HTML topic files, contents files, index files, and everything else you need to put together an online help system or Web site.
HTML Help ActiveX control : a small, modular program used to insert help navigation and secondary window functionality into an HTML file.
The HTML Help Viewer : a fully-functional and customizable three-paned window in which online help topics can appear.
Microsoft HTML Help Image Editor : an online graphics tool for creating screen shots; and for converting, editing, and viewing image files.
The HTML Help Java Applet : a small, Java-based program that can be used instead of an ActiveX control to insert help navigation into an HTML file.
The HTML Help executable program : the program that displays and runs help when you click a compiled help file.
The HTML Help compiler : the program that compiles project, contents, index, topic, and other files into a compiled help file.
The HTML Help Authoring Guide : an online guide designed to assist help authors in using HTML Help to design a help system. The guide also contains a complete HTML Help reference for developers and an HTML tag reference for authors.

References

Формат 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.

Источник

Html help file chm