WinHelp - WinHelp

WinHelp
Расширение имени файла
.hlp
Тип интернет-СМИ приложение / winhlp
Магическое число 3 этаж 5 этаж 03 00
Разработано Microsoft
Первый выпуск 1990 г.
Расширен с RTF
Стандарт Нет
Microsoft WinHelp
Разработчики) Microsoft
Операционная система Windows Vista , Windows 7 , Windows 8 , Windows 8.1
Включено в Windows 3.0 , Windows 95 , Windows XP
Преемник Скомпилированная справка Microsoft HTML
Тип Справочная система

Microsoft WinHelp это проприетарный формат для онлайн - справки файлы , которые могут быть отображены с помощью браузера Microsoft Help winhelp.exe или winhlp32.exe . Формат файла основан на Rich Text Format (RTF). Он оставался популярной платформой помощи от Windows 3.0 до Windows XP . WinHelp был удален из Windows Vista якобы для того, чтобы отговорить разработчиков программного обеспечения от использования устаревшего формата и поощрить использование новых форматов справки.

История

  • 1990 - WinHelp 1.0 поставляется с Windows 3.0 .
  • 1995 - WinHelp 4.0 поставляется с Windows 95 / Windows NT .
  • 2006 - Microsoft объявила о намерении отказаться от WinHelp в качестве поддерживаемой платформы. WinHelp не входит в состав Windows Vista по умолчанию. Файлы WinHelp бывают 16-битного и 32-битного типов. Vista по-разному трактует эти типы файлов. При запуске приложения, использующего 32-битный формат .hlp, Windows предупреждает, что этот формат больше не поддерживается. Загружаемое средство просмотра для 32-разрядных файлов .hlp доступно в Центре загрузки Microsoft. 16-разрядные файлы WinHelp продолжают отображаться в Windows Vista (только 32-разрядная версия) без загрузки программы просмотра.
  • 9 января 2009 г. - Microsoft объявила о доступности программы Windows Help (WinHlp32.exe) для Windows Server 2008 в Центре загрузки Microsoft.
  • 14 октября 2009 г. - Microsoft объявила о доступности программы справки Windows (WinHlp32.exe) для Windows 7 и Windows Server 2008 R2 в Центре загрузки Microsoft.
  • 26 октября 2012 г. - Microsoft объявила о доступности программы справки Windows (WinHlp32.exe) для Windows 8 в Центре загрузки Microsoft.
  • 5 ноября 2013 г. - Microsoft объявила о доступности программы справки Windows (WinHlp32.exe) для Windows 8.1 в Центре загрузки Microsoft.
  • 15 июля 2015 г. - Microsoft полностью удалила справку Windows из Windows 10 . Попытка открыть файл .hlp просто приводит пользователей к странице справки с подробным описанием того, что он был удален.

Формат файла

Файл 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 .)

Резюме по файлам winHelp
.hlp Описание
.hpj файл проекта ( простой текст ?); содержит список всех файлов .rtf для компиляции в файл .hlp и некоторую дополнительную информацию
.cnt Файл содержания (TOC) .
.rtf фактическое текстовое содержимое в Rich Text Format -format
.bmp .dib .wmf .shg файлы изображений в различных форматах: .bmp или .dib , .wmf .shg
.fts .ftg Полнотекстовый поиск; используется для поиска по тексту справочных документов
.Анна файл с аннотациями ( обычный текст ?)
.bmk файл с закладками ( обычный текст ?)

Исходные файлы и компиляция

Исходные файлы, необходимые для компиляции файла .hlp, состоят из одного или нескольких документов в формате Rich Text и файла проекта справки с расширением .hpj, а также любых файлов изображений (.bmp, .wmf или .shg), которые используются в файл справки. Необязательный файл оглавления с расширением .cnt также может быть создан для использования с файлом .hlp.

В файлах .rtf темы разделяются разрывами страниц. В каждой теме есть серия сносок, которые содержат информацию для компилятора справки:

# сноски содержат идентификатор темы (используется для создания ссылок на эту тему).
$ footnotes содержат название темы, отображаемое в оглавлении, указателе и других местах.
K сносок содержат ключевые слова для индекса.
A сносок содержит Смотрите также ключевые слова.
* сноски содержат теги сборки.
+ сноски содержат информацию о последовательности просмотра.
! сноски содержат макросы статей.

Требуется только сноска #. Все остальные не обязательны.

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

Изображения могут быть добавлены с помощью таких кодов, как {bmc image.bmp}. Поддерживаемые форматы изображений включают .bmp , .wmf и .shg (используются для карт изображений, которые могут содержать переходы или всплывающие окна, запускаемые при нажатии на определенные части изображения).

После создания исходных файлов файл справки может быть скомпилирован с помощью компилятора WinHelp, такого как HCW.exe, или с помощью коммерческого программного обеспечения, такого как RoboHelp или HelpBreeze , большинство из которых (включая два цитируемых здесь) также используют hcw. exe в качестве внутреннего компилятора.

Внешний вид и особенности WinHelp

В зависимости от того, как он был запущен, и какие настройки выбрал автор справки, файл WinHelp открывается либо в своей теме по умолчанию, либо в оглавлении, либо в своем индексе.

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

Когда тема открыта, в строке заголовка в верхней части окна справки отображается заголовок темы. Ниже находится ряд меню (« Файл» , « Правка» , « Закладка» , « Параметры» и « Справка» ), которые управляют различными аспектами файла. Под меню обычно появляется ряд кнопок . Автор справки определяет, какие кнопки появляются. Типичные кнопки включают в себя « Содержание» , « Указатель» , « Назад» и « Печать» , а также кнопки << и >> для просмотра файла. Авторы справки также могут создавать настраиваемые кнопки для перехода к определенным темам или выполнения других действий.

Под кнопками находится основная текстовая область окна. Обычно текст начинается с заголовка, часто жирным или более крупным шрифтом, чем остальной текст. Этот заголовок может иногда находиться в области без прокрутки - области окна, которая не перемещается вверх или вниз с помощью полосы прокрутки сбоку от окна. Области без прокрутки можно использовать только в начале темы. Автор справки может управлять размером и цветом фона области без прокрутки.

Авторы справки также могут управлять цветом фона основной текстовой области, где отображается фактический текст темы. Этот текст можно отформатировать и расположить по-разному. Внутри текста переходы отображаются в виде зеленого текста с одним подчеркиванием . Одно нажатие на прыжок открывает другую тему. Некоторые переходы могут открывать дополнительные окна справки для отображения информации. Всплывающие окна отображаются в тексте в виде зеленого текста с пунктирной линией. При однократном щелчке по всплывающему окну открывается небольшое окно без меню, кнопок или полос прокрутки, размер которого соответствует тексту. Часто всплывающие окна содержат краткие определения ключевых терминов или другую дополнительную информацию об основном тексте. Всплывающее окно автоматически исчезает в следующий раз, когда пользователь щелкает или нажимает клавишу.

Многие, хотя и не все разделы справки имеют Смотрите также прыжки в конце текста. В зависимости от предпочтений автора справки эта функция может представлять собой простой список переходов под заголовком « См. Также» или небольшую кнопку, при нажатии на которую открывается диалоговое окно, отображающее все соответствующие темы. Если щелкнуть имя темы в этом диалоговом окне, а затем щелкнуть « Показать», откроется эта тема.

Большинство файлов справки также содержат оглавление и указатель, помогающие пользователям найти информацию. Они отображаются в отдельном окне с вкладками. При нажатии на вкладку « Содержание » открывается оглавление, в котором пользователи могут щелкать заголовки для просмотра тем. Часто заголовки помечаются значками, которые выглядят как маленькие книги, а темы имеют значки, похожие на страницы. Двойной щелчок по теме (или щелчок по теме, а затем щелчок по Display ) открывает эту тему. При нажатии на вкладку « Указатель » открывается указатель, в котором есть поле для ввода текста и алфавитный список ключевых слов. Ввод в поле ввода автоматически прокручивает список ключевых слов до наиболее близкого соответствия. Двойной щелчок по ключевому слову (или щелчок по ключевому слову, а затем щелчок по Display ) отображает тему, связанную с этим ключевым словом (если только одно), или вызывает список всех связанных с ним тем. Индекс важен для помощи пользователям в поиске информации. Иногда в файлах справки также есть вкладка « Найти », которая позволяет пользователю искать любое слово, используемое в тексте файла, а не только ключевые слова.

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

Существенной с точки зрения безопасности функцией является то, что можно также включить файл DLL, содержащий собственный код, и связать его с темами WinHelp. Фактически это делает файлы .HLP эквивалентными исполняемым файлам.

Окончание поддержки

На конференции WritersUA 2006 года Microsoft объявила о намерении отказаться от WinHelp в качестве поддерживаемой платформы. Тед Дворкин (партнер-директор WinHelp Experience) заявил: «WinHelp не соответствует стандартам кода, установленным для Vista. Эти стандарты включают безопасность, надежность и производительность». Далее он сказал, что WinHelp разработан таким образом, что «... нам придется переписать его с нуля, чтобы соответствовать стандартам кода Vista. И этот подход не имеет смысла, учитывая, что у нас есть два других Справочные системы в Vista ».

Обновленное лицензионное соглашение запрещает разработчикам приложений упаковывать библиотеки WinHelp вместе со своими установщиками. Это означает, что руководства WinHelp для устаревших приложений не читаются при новой установке Windows Vista (или более поздней версии). Чтобы прочитать их, конечный пользователь должен получить 32-разрядную программу просмотра WinHelp с веб-сайта Microsoft и вручную установить ее.

Начиная с 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 pages, Java Help , PDF и т. Д. Поддерживать каждый формат по отдельности было бы очень дорого и чревато ошибками.

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

Смотрите также

использованная литература

внешние ссылки

  • Help-Info: информация об онлайн-справке (Microsoft), примерах и т. Д.
  • HelpMaster: самый большой выбор файлов и подсказок, связанных с WinHelp, HTMLHelp и HTML.
  • Справочные системы MS , список справочных систем MS и связанных инструментов из неофициальной спецификации