Microsoft WinHelp — это фирменный формат для файлов онлайн-справки , которые могут отображаться обозревателем справки Microsoft winhelp.exe или winhlp32.exe . Формат файла основан на Rich Text Format (RTF). Он оставался популярной платформой справки от Windows 3.0 до Windows XP . WinHelp был удален в Windows Vista якобы для того, чтобы отговорить разработчиков программного обеспечения от использования устаревшего формата и поощрить использование более новых форматов справки. Поддержка файлов WinHelp в конечном итоге будет полностью удалена в Windows 10 .
Файл WinHelp имеет суффикс ".hlp". Он может сопровождаться необязательным файлом таблицы содержания (.cnt), если разработчик справки его создал. Когда Windows открывает файл WinHelp, он создает файл .gid в том же каталоге или в " %LOCALAPPDATA%\Help", содержащий информацию о файле .hlp, такую как размер и местоположение окна. Если пользователь щелкает вкладку "Найти" и включает индексацию ключевых слов, Windows создает файл индекса с расширением .fts (полнотекстовый поиск). Аннотации и закладки для каждого файла справки Windows имеют расширения ".ann" и ".bmk".
Ряд программных инструментов может декомпилировать файл WinHelp в его исходные документы: HPJ, CNT, RTF , BMP и SHG . Файл HPJ — это файл проекта, который создается и редактируется в Help Workshop (или стороннем инструменте для создания справок). HPJ содержит информацию о том, какие файлы RTF следует скомпилировать в справку, идентификаторы MAP и псевдонимы, которые предоставляют ссылки из вызывающего приложения на файл справки, и внешний вид файла справки (размер окна, кнопки по умолчанию, цветовые схемы и т. д.). Файл CNT предоставляет оглавление для файла справки. Файл SHG — это графический файл «SHED», который по сути создает карту изображений вызовов справки для графического файла (например, BMP).
Ряд инструментов могут читать и исследовать эти файлы. (См., например, Help to RTF и winhelpcgi.)
Исходные файлы, необходимые для компиляции файла .hlp, состоят из одного или нескольких документов в формате Rich Text Format и файла проекта справки с расширением .hpj, а также любых файлов изображений (. bmp , . wmf или .shg), которые используются в файле справки. Также можно создать необязательный файл оглавления с расширением .cnt для использования с файлом .hlp.
В файлах .rtf темы разделены разрывами страниц. Каждая тема имеет ряд сносок , содержащих информацию для компилятора справки:
Обязательна только сноска #. Все остальные необязательны.
Текст в каждой теме может содержать ограниченное форматирование, включая жирный текст, курсив и цвета. Верхний и нижний индексы не допускаются. Переходы между темами в одном файле справки обычно отображаются в исходном документе как дважды подчеркнутый текст (зеленый по умолчанию, хотя это можно переопределить), за которым следует идентификатор темы в скрытом тексте. Всплывающие ссылки отображаются в исходном документе как текст с одним подчеркиванием (также зеленый по умолчанию), за которым следует идентификатор темы в скрытом тексте. (В файле .hlp переходы отображаются как зеленый текст с одним подчеркиванием, а всплывающие окна отображаются как зеленый текст с пунктирным подчеркиванием.)
Изображения можно добавлять с помощью кодов, таких как {bmc image.bmp}. Поддерживаемые форматы изображений включают .bmp , .wmf и .shg (используются для карт изображений, которые могут содержать переходы или всплывающие окна, которые запускаются при нажатии на определенные части изображения).
После создания исходных файлов файл справки можно скомпилировать с помощью компилятора WinHelp, например HCW.exe, или с помощью коммерческой программы, например RoboHelp или HelpBreeze, большинство из которых (включая две упомянутые здесь) также используют hcw.exe в качестве внутреннего компилятора.
В зависимости от способа запуска и настроек, выбранных автором справки, файл WinHelp открывается либо с темой по умолчанию, либо с оглавлением, либо с индексом.
Раздел в файле WinHelp открывается в отдельном окне, в размере и исходном положении, которые может выбрать автор Help. Пользователи могут изменять размер или положение окна. Автор Help может контролировать, будет ли файл Help сохранять настройки пользователя между сеансами или всегда открываться в размере и положении по умолчанию.
Когда тема открыта, строка заголовка в верхней части окна справки отображает заголовок темы. Ниже находится ряд меню ( Файл , Правка , Закладка , Параметры и Справка ), которые управляют различными аспектами файла. Под меню обычно располагается ряд кнопок . Автор справки управляет тем, какие кнопки, если таковые имеются, появляются. К типичным кнопкам относятся Содержание , Индекс , Назад и Печать , а также кнопки << и >> для просмотра файла. Авторы справки также могут создавать пользовательские кнопки для перехода к определенным темам или выполнения других действий.
Под кнопками находится основная текстовая область окна. Обычно текст начинается с заголовка, часто жирного или более крупного шрифта, чем остальной текст. Иногда этот заголовок может находиться в непрокручиваемой области — области окна, которая не перемещается вверх или вниз с помощью полосы прокрутки сбоку окна. Непрокручиваемые области можно использовать только в начале темы. Автор справки может управлять размером и цветом фона непрокручиваемой области.
Авторы справки также могут управлять цветом фона основной текстовой области, где отображается фактический текст темы. Этот текст можно форматировать и упорядочивать разными способами. В тексте переходы отображаются как зеленый текст с одним подчеркиванием . Один щелчок по переходу открывает другую тему. Некоторые переходы могут открывать вторичные окна справки для отображения информации. Всплывающие окна отображаются в тексте как зеленый текст с пунктирным подчеркиванием. Один щелчок по всплывающему окну открывает небольшое окно без меню, кнопок или полос прокрутки, размер которого соответствует размеру текста. Часто всплывающие окна предоставляют краткие определения ключевых терминов или другую дополнительную информацию об основном тексте. Всплывающее окно автоматически исчезает при следующем щелчке или нажатии клавиши пользователем.
Во многих, хотя и не во всех разделах справки, в конце текста есть переходы « См . также» . В зависимости от предпочтений автора справки эта функция может быть простым списком переходов под заголовком «См. также» или небольшой кнопкой, при нажатии которой открывается диалоговое окно со всеми соответствующими разделами. Нажатие на название раздела в этом диалоговом окне и последующее нажатие на «Отображение» открывает этот раздел.
Большинство файлов справки также содержат оглавление и индекс, помогающие пользователям находить информацию. Они отображаются в отдельном окне с вкладками. Нажатие на вкладку Содержание открывает оглавление, в котором пользователи могут нажимать на заголовки, чтобы увидеть темы. Часто заголовки помечены значками, похожими на маленькие книги, а темы имеют значки, похожие на страницы. Двойной щелчок по теме (или щелчок по теме, а затем щелчок Показать ) открывает эту тему. Нажатие на вкладку Индекс открывает индекс, в котором есть поле ввода и алфавитный список ключевых слов. Ввод текста в поле ввода автоматически прокручивает список ключевых слов до ближайшего соответствия. Двойной щелчок по ключевому слову (или щелчок по ключевому слову, а затем щелчок Показать ) отображает тему, связанную с этим ключевым словом (если только одна), или выводит список всех тем, связанных с ним. Индекс важен для помощи пользователям в поиске информации. Иногда файлы справки также имеют вкладку Найти , которая позволяет пользователю искать любое слово, используемое в тексте файла, а не только ключевые слова.
WinHelp также поддерживает функцию, известную как контекстно-зависимая справка . Контекстно-зависимая справка — это помощь, которая соответствует тому, где пользователь находится в программном приложении и что он пытается сделать.
Довольно критической для безопасности функцией является то, что можно также включить файл DLL , содержащий пользовательский код, и связать его с темами WinHelp. Фактически это делает файлы .HLP эквивалентными исполняемым файлам.
На конференции WritersUA 2006 года Microsoft объявила о своих намерениях постепенно отказаться от WinHelp как поддерживаемой платформы. Тед Дворкин (партнер-директор WinHelp Experience) заявил: «WinHelp не соответствует стандартам кода, установленным для Vista. Эти стандарты включают безопасность, надежность и производительность». Он продолжил, сказав, что WinHelp разработан таким образом, что «...нам пришлось бы переписать его с нуля, чтобы соответствовать стандартам кода Vista. И такой подход не имеет смысла, учитывая, что у нас есть две другие системы справки в Vista». [ необходима цитата ]
Обновленное лицензионное соглашение запрещает разработчикам приложений упаковывать библиотеки WinHelp вместе со своими установщиками. Это означает, что руководства WinHelp для устаревших приложений не читаются на новой установке Windows Vista (или более поздней версии). Чтобы прочитать их, конечный пользователь должен получить 32-битный просмотрщик WinHelp с веб-сайта Microsoft и вручную установить его. [10]
В Windows 10 и более поздних версиях Microsoft не предлагает средство просмотра WinHelp для операционной системы. Последняя версия Windows, в которой можно было открывать и читать файлы WinHelp с помощью официального загружаемого компонента Microsoft, — это Windows 8.1 . Версия winhlp32 с открытым исходным кодом из Wine также работает в Windows 10. Она включена в состав WineVDM . Также в Windows 10 WinHelp работает с winhlp32.exe из более старой версии Windows.
Хотя документация может полностью поддерживаться в формате представления, специфичном для поставщика, например, WinHelp, чаще всего документацию приходится публиковать в нескольких форматах представления одновременно: Microsoft Compiled HTML Help (CHM), WinHelp, HTML- страницы, Java Help , PDF и т. д. Поддерживать каждый формат по отдельности было бы очень дорого и подвержено ошибкам.
По этой причине авторы часто поддерживают документацию в стандартном для отрасли, нейтральном к поставщику формате разработки, например DocBook или FrameMaker , который можно использовать для создания нескольких различных форматов презентаций (включая WinHelp). [ необходима ссылка ] Различные файлы презентаций, созданные таким образом (с помощью WinHelp или других инструментов), содержат единообразное содержимое, поскольку они были созданы из одного и того же источника.
.chmрасширение файла)