Формат WinHelp

Разработанный на смену Microsoft QuickHelp, формат WinHelp на протяжении полутора десятилетий был стандартом отрасли и популярным форматом справки для операционных систем семейства Windows, начиная с версии 3.0 до XP. Для Windows Vista, Windows 7, Windows 8 и 8.1 средство для просмотра файлов WinHelp можно и сегодня бесплатно скачать на сайте компании Майкрософт. Начиная с Windows 10 формат WinHelp не поддерживается.

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

Наименование :	WinHelp (Microsoft Windows Help, .HLP) — устаревший формат файлов справки для организации справочной системы.
Расширение файлов:	.hlp
Платформы:	Windows 3.0 – Windows XP
Программа:	Microsoft Help Workshop Файлы .hlp можно открыть при помощи браузера для просмотра справки winhelp.exe или winhlp32.exe. Начиная с Windows Vista в составе дистрибутива нет средства для просмотра файлов справки в формате WinHelp. Для Windows Vista, Windows 7, Windows 8 и 8.1 его можно бесплатно скачать из Центра загрузки Майкрософт и установить. В Windows 10, Windows Server 2012 и более поздних версиях данного семейства ОС WinHelp не поддерживается.
Разработчик, 1-й релиз:	Майкрософт, 1987 г. Первую версию WinHelp разработал Флойд Роджерс (Floyd Rogers) в 1987 г. В 1992 г. разработку WinHelp возглавил Ральф Уолден (Ralph Walden), автор Microsoft QuickHelp, выпустивший WinHelp 4.0.
История:	1987-1989 — выход WinHelp 1.х и WinHelp 2.0 с ранними версиями Word и Excel. 1990 —WinHelp 3.0 вышел в мае с Windows 3.0; 1992 —WinHelp 3.1 вышел в марте с Windows 3.1; 1995 — WinHelp 4.0 с Windows 95/NT; 2006 — Майкрософт объявили о прекращении разработки и поддержки WinHelp. 2009 — 14 октября Майкрософт объявила о возможности загрузки браузера справки winhlp32.exe для Windows 7.
Формат - предшественник:	WinHelp был создан для замены Microsoft QuickHelp (система текстовой справки / character based help для OS/2, разработанная Ральфом Уолденом в 1987 г., которая была позднее портирована в MS-DOS).
Формат-преемник:	HTML Help (CHM)
Поддержка контекстной справки:	Да
Возможность изменения внешнего вида под пользователя:	В современном смысле – нет.

Как выглядит WinHelp

Справка в формате WinHelp — это файл(ы) с расширением .hlp. С ними могут поставляться файлы в формате .cnt, содержащие оглавление справки. Их наличие не обязательно.

файлы WinHelp

При запуске файла WinHelp открывается либо оглавление, либо указатель, либо раздел (topic), выбранный разработчиком справки как раздел по умолчанию. Оглавление, указатель и поиск располагаются в отдельном окне на соответствующих вкладках. Текст раздела справки, выбранного в оглавлении, открывается также в отдельном окне, для которого разработчик может задать размер и расположение. Работая со справкой, пользователи могут перемещать окна, а также менять их размеры. Пользовательские размеры и положение окон справки могут сохраняться между сессиями. Окна справки могут также каждый раз открываться с использованием значений, заданных по умолчанию в настройках проекта.

рабочая справка WinHelp

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

Как работает WinHelp

При открытии файла справки WinHelp операционная система создает в этой же папке или в папке «%LOCALAPPDATA%\Help» (например, в Windows 7 C:\Users\User\AppData\Local\Help) файл с расширением .gid, содержащий такую информацию о .hlp-файле, как размер окна и месторасположение файла. Когда пользователь в окне справки переходит на вкладку с предметным указателем или поиском, операционная система создает в той же папке файл с расширением .fts (full text search). Пользовательские заметки и закладки (annotations and bookmarks), созданные во время работы со справой, сохраняются в файлах с расширениями .ann и .bmk.

Как создать WinHelp

Справка в формате WinHelp представляет собой один или несколько текстовых файлов в формате .rtf, а также рисунки в формате .bmp, скомпилированные в файл формата .hlp. Чтобы создать справку в формате WinHelp, необходимо:

подготовить текст разделов справки в любом текстовом редакторе, позволяющем работать с документами в формате .rtf;
подготовить графику в формате .bmp или .shg (не обязательно);
собрать справку при помощи программы Microsoft Help Workshop (либо аналогичной программы для создания справки в формате WinHelp).

бесплатная программа для создания WinHelp - Microsoft Help Workshop

Для сборки .hlp-файла минимально необходимы один или несколько файлов в формате .rtf и файл проекта в формате .hpj. Полный список исходных файлов следующий:

.hpj – файл проекта справки; создается и редактируется программой Microsoft Help Workshop; содержит данные о файлах с текстом и рисунками, которые необходимо включить в справку, о размере окна справки, его цветовой схеме, вызове справки из приложения и т.д.
.cnt — оглавление для файла справки;
.bmp — файлы рисунков, использованных в справке (.bmp, .wmf или .shg);
.shg — segmented hyper graphics; файл, содержащий рисунок и карту ссылок (щелкнув различные части рисунка, пользователь может открыть разные разделы справки); создается программой exe, входящей в состав Microsoft Help Workshop, либо аналогичными программами.
.rtf — файл(ы) с текстом справки, который размечен особым образом.

В .rtf-файлах используется следующая разметка текста. Разделы (topics) отделяется друг от друга разрывами страниц. В тексте раздела используются следующие сноски:

# — идентификатор раздела (topic ID), используется для создания ссылок на данный раздел; данная сноска обязательна;
$ — название раздела, как оно будет отображаться в оглавлении и других местах;
К — ключевые слова для указателя;
А — ключевые слова для формирования ссылок «Смотрите также» (See Also), A-keywords или associative keywords;
* — теги сборок;
+ — сноски с данными о последовательности просмотра;
! — макрос, который будет запущен при открытии раздела.

Для оформления текста разделов используются базовые элементы форматирования (жирный, курсив, цвет). Не допускается использование подстрочных и надстрочных знаков. Ссылки на другие разделы оформляются как текст с двойным подчеркиванием, после которого скрытым текстом указывается идентификатор целевого раздела. Ссылки для открытия всплывающих подсказок оформляются как текст, подчеркнутый одной чертой, после которого указывается идентификатор целевого раздела скрытым текстом. Рисунки вставляются в текст при помощи следующего кода: {bmc image.bmp}.

Для сборки справки в формате WinHelp используется компилятор hcw.exe (hcrtf.exe). Он входит в состав Microsoft Help Workshop, а также используется в качестве компилятора в другом коммерческом ПО (RoboHelp, Helpbreeze, Help&Manual до версии 6). Так как формат WinHelp считается устаревшим, в современных версиях данных программ сохранена возможность импорта .hlp-, .hpj- и .rtf-файлов, размеченных для создания WinHelp.