Html help что это за программа

Содержание

История справочных систем от Microsoft насчитывает четыре версии:

  • WinHelp — Появилась вместе с Windows 3.0. Исходный формат базируется на RTF. Поддерживается всеми версиями Windows, но в настоящее время для новых приложений практически не используется.
  • HTML Help 1.x (далее «HH») — Вышла в 1997 г. вместе с IE4. Использует для тем формат HTML и движок IE. Входит в состав всех используемых в настоящее время версий Windows.
  • MS Help 2.x — Выпущена в начале 2002 г. Также использует формат HTML и движок IE. В основном используется для интеграции со справкой Visual Studio .NET
  • Longhorn Help — Новая справочная система, которая будет включена в Windows Longhorn. Подробнее — Introducing Windows «Longhorn» Help

Автором WinHelp и HH является Ральф Уолден (Ralph Walden), работавший на MS с 1987 до начала 1998 года. После ухода из MS он основал KeyWorks Software.

На настоящий момент наиболее удобным форматом, с точки зрения как разработки (наличие обширного инструментария), так и распространения (поддержка операционной системой), несомненно, является HTML Help 1.3.

Что такое HTML за 7 минут

Создание простейшей справки

Проект

Основным файлом справки является файл проекта (.HHP), описывающий опции компиляции и содержащий ссылки на все другие файлы, участвующие при сборке. Структура .HHP-файла – это структура INI-файла. Обычно нет необходимости редактировать файл проекта вручную — все, что нужно, может быть задано с помощью HTML Help Workshop (HHW). Новый проект может быть создан с помощью мастера — командой File > New > Project.

Файл проекта может быть создан и вручную. Вот пример типичного .HHP-файла:

[OPTIONS] Binary Index=No Compatibility=1.1 or later Compiled file=MyAppHelp.chm Contents file=MyAppHelp.hhc Default Window=main Default topic=HTMLWelcome.htm Display compile progress=No Index file=MyAppHelp.hhk Language=0x419 Русский Title=Мое приложение — Справка [WINDOWS] main=,»MyAppHelp.hhc»,»MyAppHelp.hhk»,»HTMLWelcome.htm»,»HTMLWelcome.htm». 0x72520,,0x60305e,[112,11,896,658],0x100b0000. 0 [FILES] HTMLManual.css

Содержание справки редактируется на вкладке Contents и содержится в .HHC-файле. Структура содержания — иерархическая, каждый элемент поименован, имеет иконку (выбирается из списка), к элементу содержания может быть привязана одна или несколько тем (HTML-файлов).

Предметный указатель описывается на вкладке Index и хранится в .HHK-файле.

ПРЕДУПРЕЖДЕНИЕ

.HHC и .HHK сохраняются из HHW в виде, похожем на HTML, но здесь есть одна тонкость. Если вы хотите формировать .HHC или .HHK сторонними средствами, НЕДОСТАТОЧНО, чтобы это был XML, сформированный по тому же DTD —файл должен содержать ту же шапку и такие же отступы в каждой строке — лишь в этом случае он будет принят в HHW и корректно прочитан компилятором.

ПРИМЕЧАНИЕ

Если вы хотите иметь возможность использовать в .HHC- и .HHK-файлах русский язык, не редактируйте эти файлы в HTML WorkShop – это средство не умеет работать с русским языком. – прим.ред.

Что такое HTML?

Темы

Страницы справки (темы) для HH — это обычные HTML-страницы, для создания которых может быть использован любой HTML-редактор — начиная от простейших Notepad и FAR+Colorer до монстрообразных MS Word и FrontPage.

Рекомендуется описать используемые во всех топиках стили с помощью CSS и поместить описание в отдельном файле — например, Manual.css — который подключать в заголовке каждой темы:

Сборка (компиляция)

Для сборки готового .CHM файла из HHW используйте команду File > Compile или соответствующую кнопку на панели команд.

В некоторых случаях может понадобиться возможность сборки справочника в автоматическом режиме — используйте утилиту hhc.exe с параметром — именем файла проекта:

«C:Program FilesHTML Help Workshophhc.exe» AMADocBase.hhp

Контекстная справка

Будем считать, что у нас уже написаны HTML-файлы, описывающие отдельные объекты программы (главное окно, диалоги и т.п.), и нам остается только связать программу с этими файлами.

1. В проекте на VB.NET заводим отдельный модуль (например, HelpSystem). В нем мы описываем все вещи в программе, для которых у нас будет контекстная справка, например:

Public Enum HelpContextID FormMain = 2001 FormLogin = 2002 FormError = 3010 FormWait = 3030 . EndEnum

2. В проекте справки заводим файл Map.h вида:

#define FormMain 2001 #define FormLogin 2002 #define FormError 3010 #define FormWait 3030 .

т.е. здесь мы описываем то же, что и в HelpContextID enum, но в другом формате. HelpContextID enum и Map.h должны быть «синхронизированы» — чтобы ID в программе и в справке всегда совпадали. В C/C++ это было проще — формат файла Map.h был специально приспособлен для того, чтобы входной файл для справки совпадал с файлом, используемым в самой программе.

Читайте также:
Dolby advanced audio v2 что это за программа и нужна ли

В проекте справки заводим файл Aliases.h вида:

FormLogin=HTML2_2.htm FormMain=HTML3_1.htm#FormMain FormWait=HTML2_2.htm .

Здесь задается отображение символического имени, заданного в Map.h, на конкретную тему и место в ней.

Вызов контекстной справки происходит так: в HTML Help API передается идентификатор справки — целое число, которое определяется в HelpContextID enum — по нему (используя Map.h) определяется символическое имя, затем по символическому имени (используя Aliases.h) определяется тема, которая будет показана.

В файле проекта справки задаем ссылки на Aliases.h и Map.h:

[ALIAS] #include Aliases.h [MAP] #include Map.h

3. В программе на VB.NET описываем вызов справки:

‘ Показывает TOC или Index справочной системы. ‘ HelpNavigator.TableOfContents или HelpNavigator.Index Public Sub ShowHelp(ByVal val As HelpNavigator) IfNot CheckHelpFileExists() ThenExitSubDim mainForm As Form = Common.g_ApplicationContext.MainForm Help.ShowHelp(mainForm, g_HelpFilePath, val) EndSub’ ‘ Показывает страницу справочной системы, соответствующую значению contextID. ‘ PublicSub ShowHelp(ByVal contextID AsInteger) IfNot CheckHelpFileExists() ThenExitSubDim id AsInteger = contextID Dim mainForm As Form = Common.g_ApplicationContext.MainForm Help.ShowHelp(mainForm, g_HelpFilePath, CType(15, HelpNavigator), id) EndSub’ ‘ Показывает страницу справочной системы, соответствующую значению contextID. ‘ PublicSub ShowHelp(ByVal parent As Control, ByVal contextID AsInteger) IfNot CheckHelpFileExists() ThenExitSubDim id AsInteger = contextID Dim mainForm As Form = Common.g_ApplicationContext.MainForm Help.ShowHelp(parent, g_HelpFilePath, CType(15, HelpNavigator), id) EndSub

Здесь g_HelpFilePath — глобальная переменная с полным путем к файлу справки. g_ApplicationContext — глобальная переменная с контекстом приложения, используется для получения главного окна — можно его получать любым другим способом.

Вызов из программы

Везде, где нужен вызов справки, расставляем вызовы вида:

Private Sub btnHelp_Click(ByVal sender AsObject, _ ByVal e As System.EventArgs) Handles btnHelp.Click HelpSystem.ShowHelp(Me, HelpContextID.FormContactProps) EndSub

Вызов содержания справки и предметного указателя:

HelpSystem.ShowHelp(HelpNavigator.TableOfContents) HelpSystem.ShowHelp(HelpNavigator.Index)

Вызов средствами Win32

Хотя класс System.Windows.Forms.Help и предоставляет необходимую функциональность, бывают случаи, когда ее недостаточно. Например, окно справки всегда лежит поверх окна основного приложения, переданного первым параметром в функцию ShowHelp().

Окно справки может занимать значительное место и закрывать большую часть окна приложения — поэтому может оказаться удобным, чтобы окно справки могло перекрываться окном основного приложения. Но функция ShowHelp() не имеет такой функциональности — вы не можете передать первым параметром Nothing, поскольку получите исключение. В таком случае придется воспользоваться функцией WinAPI:

Public Enum HTMLHelpCommand HH_DISPLAY_TOPIC = 0 HH_DISPLAY_TOC = 1 HH_DISPLAY_INDEX = 2 HH_DISPLAY_SEARCH = 3 HH_HELP_CONTEXT = H12 EndEnum «hhctrl.ocx», EntryPoint:=»HtmlHelp», CharSet:=CharSet.Auto)> _ Function HTMLHelp( _ ByVal hWndCaller As IntPtr, ByVal pszFile AsString, _ ByVal uCommand AsInteger, ByVal dwData AsInteger) AsIntegerEndFunction

Собственно вызов выглядит так:

WinAPI.HTMLHelp(Nothing, filePath, HTMLHelpCommand.HH_HELP_CONTEXT, contextID) WinAPI.HTMLHelp(Nothing, filePath, HTMLHelpCommand.HH_DISPLAY_TOC, 0)

Теперь все отлично — окно справки висит отдельно, работать в программе не мешает.

Helpware FAR

К счастью, помимо HHW существуют и другие средства разработки HTML Help, среди которых я бы особо выделил Helpware FAR — бесплатный набор утилит для работы над справкой формата HH. Вот некоторые из его возможностей:

  • Редактор проекта (.HHP).
  • Редактор содержания (.HHC) и предметного указателя (.HHK).
  • Утилита проверки связей в .CHM (Link Checker).
  • Сжатие .CHM.

Распространение продукта

Практически все используемые в настоящее время версии Windows уже содержат HTMLHelp:

Версия Windows Версия HTMLHelp
Windows 95 не содержит
Windows 95 OSR2 не содержит
Windows NT 4 не содержит
Windows 98 1.1a
Windows 98 SE 1.21
Windows ME 1.32
Windows 2000 1.30
Windows 2000 SP1-3 1.31
Windows XP 1.33
Windows XP SP1 1.4
Windows XP SP2 1.4e

В Windows 95/98/NT можно установить HH с помощью дистрибутива HHUPD.EXE, который доступен после установки HHW. Для работы HH требуется IE 3.0 и выше. Для использования DHTML, очевидно, нужен IE версии 4, для XML понадобится IE версии 5 и выше. Последние версии IE включают в себя обновление HH — например, в состав IE 6.0 SP1 входит HH 1.4. Более подробно — см.

HTML Help — Tech Info.

Ссылки

Общая информация

  • MSDN — Microsoft Help Technologies Start Page
  • MSDN — HTML Help Frequently Asked Questions
  • MSHelpWiki
  • http://www.winwriters.com/
  • http://www.g2meyer.com/usablehelp/
  • Help Technology Centre — Resources and Techniques for Help Systems

Инструментарий

  • Microsoft HTML Help Downloads
  • http://helpware.net/
  • KeyWorks Software

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

  • MetaGuide — Руководство для разработчиков технической документации к программному обеспечению
  • Форум технических писателей и переводчиков
  • КТ №43 / В поисках тленного стиля
  • КТ №43 / Милостивый государь, технический писатель
  • Как сделать хорошее руководство пользователя

Источник: www.rsdn.org

Формат HTML Help

Устаревший к 1996 г. формат WinHelp был заменен на новый формат HTML Help (CHM). Его полное название — Microsoft Compiled HTML Help. Первая версия CHM вышла в 1997 г. Так как более новые форматы справки, разработанные Microsoft для замены HTML Help, так и не стали публичными, CHM сегодня остается стандартом справки для платформы Windows. Средство для просмотра CHM-файлов поддерживается во всех версиях Windows 10.

Читайте также:
Anvide labs что это за программа

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

Наименование:

Microsoft Compiled HTML Help (CHM) — система справки для платформы Windows.

Расширение файлов:

Платформы:

Windows 98 – Windows 10

Программа:

HTML Help Workshop

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

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

Майкрософт, 1997 г.

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

справка в формате CHM (HTML Help)

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

Например, вкладка Избранное используется очень редко и, как правило, скрывается. Аналогично можно скрыть вкладку Поиск. Вкладка Указатель скрывается только автоматически, если в файле справки нет ни одного ключевого слова.

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

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

файлы HTML Help

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

На вкладке Избранное можно добавить ссылки на разделы справки для быстрого доступа к ним. Список избранных разделов справки сохраняется и отображается каждый раз при запуске файла справки. Ссылки на избранные разделы можно удалять.

Читайте также:
Квикстеп программа что это

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

Считается, что внешний вид навигационной панели (Содержание, Указатель, Поиск) изменить практически не возможно. Стандартными средствами можно изменить тип и размер шрифта оглавления и ключевых слов, отключить значки «+» и «-», которые отображаются слева от разделов, включить пунктирную линию, показывающую древовидную структуру разделов, включить выделение разделов при наведении на них курсора, а также включить автоматическое скрытие неактивных родительских разделов. При очень большом желании можно добиться следующего результата.

справка в формате 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 https://help-spravka.ru/blog/12-formats/6-format-html-help» target=»_blank»]help-spravka.ru[/mask_link]

HTMLHelp

Для просмотра .CHM-файлов используется стандартное средство просмотра, встроенное во все версии Microsoft Windows, начиная с Windows 98, и Windows NT. Кроме того, существует ряд сторонних программ-просмотровщиков, FBReader, etc. Для создания .CHM-файлов «Майкрософт» предоставляет бесплатное средство HTML Help Workshop.

История

  • Февраль 1996 — Майкрософт анонсирует планы по прекращению разработки WinHelp и начале разработки HTMLHelp
  • Август 1997 — HTML Help 1.0 выходит в составе Internet Explorer 4.0
  • Февраль 1998 — HTML Help 1.1a поставляется вместе с Windows 98
  • Январь 2000 — HTML Help 1.3 поставляется вместе с Windows 2000
  • Июль 2000 — HTML Help 1.32 выпускается вместе с Internet Explorer 5.5 и Windows ME
  • Октябрь 2001 — HTML Help 1.33 выходит вместе с Internet Explorer 6 и Windows XP
  • Март 2001 — На конференции WritersUA анонсируются планы по созданию новой системы справки Microsoft Help 2, также основанной на HTML
  • Январь 2003 — Майкрософт решает не выпускать Help 2 в качестве широкоиспользуемой платформы

В 2002 году компанией Майкрософт была распространена информация о ряде проблем с безопасностью, связанных с форматом .CHM, был выпущен ряд заплаток. [1] Кроме того, было анонсировано, что формат более не будет дорабатываться, вместо этого произойдёт переход к новому поколению справочной системы Windows под названием Microsoft Assistance Markup Language, которая войдёт в состав операционной системы Windows Vista.

Преимущества формата

Недостатки формата

  • Недокументированность.
  • Хорошо известен сбой, который не даёт просмотреть эти файлы, либо поиск в них отказывается работать. Это легко исправить, запустив команду «regsvr32 %windir%system32hhctrl.ocx».
  • Файлы могут не открываться, если в пути к файлу имеются символы кириллицы, а так же символы «_» и «#».
  • Формат ориентирован только под Windows.

Работа с HTMLHelp на платформах, отличных от Windows

С целью создания открытого инструментария, доступного на разных платформах, начат проект chmlib, в рамках которого разработана библиотека; на основе последней создан ряд программных продуктов, среди которых:

  • arCHMage
  • xCHM
  • GnoCHM
  • ChmSee
  • Chmox
  • extract_chmLib — средство командной строки, существующее в рамках проекта Debian, позволяющее конвертировать из chm в html

См. также

Примечания

Ссылки

  • HTMLHelp в MSDN
  • Helpware FAR — набор утилит для работы с рядом форматов справки, в том числе HTMLHelp
  • Типовые решения проблем отображения страниц HTMLHelp
  • CHM Editor — редактор CHM файлов без перекомпиляции
  • CHM Decoder — позволяет распаковывать CHM файлы в оригинальные HTML
  • KDE CHM Viewer — просмотр CHM файлов под Linux.
  • arCHMage — позволяет распаковывать CHM файлы в оригинальные HTML, а также конвертировать в PDF
  • ChmSee — программа для просмотра CHM файлов под Linux, построенная на GTK.
  • Chmox — программа для просмотра CHM файлов под Mac OS X.
  • chmlib — программная библиотека для работы с форматом CHMde:CHM (Dateiformat)

Источник: www.sbup.com

Рейтинг
( Пока оценок нет )
Комментарии0
Загрузка ...
Похожие материалы
EFT-Soft.ru