Html help workshop создание справки

Html help workshop создание справки

На рисунке — Microsoft HTML Help Workshop 4.74 (1996 — 1999 гг). Интерфейс и справка — на англ. языке. Вес 3,79 Мб. Бесплатная программа.Работает в Windows 2000, 7, 8, 95, 98, ME, NT, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows Vista, Windows XP.

Назначение программы — создание справок в формате CHM.

Формат справок CHM, созданный Microsoft — обычный формат справочных материалов, которые сопровождают все программы, работающие в системе Windows

Для создания содержания справки нужно создать необходимое число html-страниц (в соответствии с числом разделов и подразделов справки).

Страницы html можно создавать, не выходя из HTML Help Workshop — программа имеет встроенный редактор html-кода (типа Блокнота Windows).

Кроме этого, html-страницы Вы можете создать в любом другом HTML-редакторе и затем использовать их для создания справки в HTML Help Workshop.

Созданная навигация по справке имеет вид иерархического дерева, с пунктами и подпунктами.

Программа имеет ряд мастеров — есть мастер по созданию проекта в целом, мастер по созданию навигации по справке.
Есть мастер ActiveX Control Wizard, который дает возможность вставить или редактировать управление в файле HTML.

Программа имеет встроенный небольшой и простой редактор изображений.

Имеется средство просмотра интерактивной справки, связанных компонентов справки (Help Viewer).

При создании справки в Microsoft HTML Help Workshop применяется код HTML, ActiveX, Java, языки для написания сценариев (JScript, и Microsoft Visual Basic), изображения форматов .jpeg .gif, и.png.

С программой идет несколько справок по использованию компонентов программы и применению языков программирования, включая описания синтаксиса и примеры кода.
Несмотря на большое количество прилагаемых к программе обучающих материалов, Microsoft HTML Help Workshop больше рассчитана на программистов, которые смогут создать справку как составную часть собственной программы.

В наше время существует много программ, которые намного проще в изучении и применении, чем Microsoft HTML Help Workshop, поэтому вряд ли программа будет популярной среди широкой публики.

Эта статья впервые была опубликована на сайте www.relib.com

Если вы когда-либо смотрели Справку в Internet Explorer (IE) последних версий, то наверняка задавались вопросом, как создать справочную систему для вашего приложения подобно этой? В этой статье рассказывается как сформировать систему html-справки, используя Microsoft HTML Help Workshop, и как вызвать из VB-приложения готовый справочный файл.

Впервые Microsoft представила HTML Help — новую справочную систему, основанную на html — в августе 1997 как замену WinHelp. Это было относительно ново и не использовалось в других приложениях, кроме IE. Однако, как мы можем сейчас видеть — все новые версии продуктов Microsoft используют HTML Help: начиная игрой "Пасьянс" и заканчивая операционной системой Windows 98. Чтобы использовать советы из данной статьи на вашем компьютере должен быть установлен как минимум IE 3.02 (для использования всех функций HTML Help вы нуждаетесь в одной из последних версий IE).

Типичное окно HTML Help состоит из трех основных частей, как показано на Рис.1. В верхней части панель инструментов, которая содержит кнопки управления. В левой нижней части — окно навигации, импортированное из ActiveX-компонента HHCtrl.OCX и предоставляющее возможности просмотра оглавления, индекса и функцию поиска. В правой нижней части — окно содержания, которое действует как контейнер для HTML документов.

Рис.1. Три части окна Справки Internet Explorer 4.0.

HTML Help Workshop

Для создания файлов HTML Help вы можете использовать специализированный редактор HTML Help Workshop, созданный Microsoft. HTML Help Workshop доступен для загрузки на сайте Microsoft. В этой части показывается, как сделать простую справочную систему с использованием этого инструмента. Прежде чем начать, установите HTML Help Workshop на вашу машину и посмотрите табл.1, дающую пояснения к различным типам файлов, используемых в HTML Help.

Читайте также:  Acer 5755g оперативная память

Табл.1. Файлы, используемые в HTML Help.

Extension Type
HHP Help project
HHC Table of contents
HHK Index
CHM Compiled Help
HTM Individual Help
H Header files

Создание проекта Справки HTML Help

До того, как вы сможете начать формировать вашу систему Справки, вы должны создать все HTML-файлы, которые потребуются для создания справочного файла. Затем создайте каталог HTMLHelp и сохраните там подготовленные HTML-файлы — это будет каталог вашего проекта.

Теперь откройте HTML Help Workshop и выберите в меню пункт File | New. В появившемся диалоговом окне New выберите Project и щелкните OK. Запустившийся Мастер Проекта (New Project Wizard) предложит вам выполнить ряд шагов для создания вашего проекта. Убедитесь, что проверили опцию HTML Files в окне New Project-Existing Files и прибавили ваши HTML-файлы к создаваемому проекту. Щелкните кнопку Finish, чтобы создать проект. Рисунок 2 показывает типичное окно HTML Help Workshop.

Рис.2. Окно редактора HTML Help Workshop.

Главное окно HTML Help Workshop состоит из четырех закладок: Проект, Содержание, Индекс, Справка и набора кнопок для каждой закладки. Вы можете использовать закладку Проект (Project), чтобы изменить параметры проекта, добавить или удалить файлы содержания, изменить настройки окна и установить параметры для HTMLHelp API. Установка настроек окна и HTMLHelp API важна для VB разработчиков. Мы покажем вам позже как установить эти параметры.

Добавление оглавления и индексных файлов

Файл оглавления определяет содержание, которое вы будете видеть в закладке Contents в будущем справочном файле. Оглавление обычно организовано в виде дерева с разделами, подразделами и страницами.

Чтобы добавить файл оглавления к вашему проекту щелкните закладку Contents (Оглавление) и увидите диалог Table Of Contents Not Specified. Выберите Create A New Contents File, чтобы создать пустую таблицу файла оглавления. Теперь вы сможете прибавить ваше содержание, используя кнопки Insert Heading и Insert Page. В диалоговых окнах, которые появляются, когда вы выбираете эти параметры, вы можете сопоставить HTML-файлы с разделами и страницами. Вы можете также редактировать, удалять или реорганизовывать ваши разделы и страницы, используя кнопки Edit, Delete и Move Selection.

Индексный файл содержит ключевые слова, которые вы видите, когда щелкаете закладку Index. Для добавления индексного файла к вашему проекту щелкните закладку Index и увидите диалог Index Not Specified. Выберите Create New Index и создайте пустой индексный файл. Вы можете прибавлять ключевые слова, использующие кнопку Insert A Keyword и сопоставлять HTML-файл с этим ключевым словом. Вы можете также редактировать, удалять или реорганизовывать ключевые слова, используя кнопки Edit, Delete и Move Selection.

Параметры окна и HTMLHelp API

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

Когда вы вызываете HTMLHelp API из VB, вы можете обратиться к этим свойствам и показывать справочное окно в различных стилях. Кликните закладку Project, затем кнопку Add/Modify Window Definitions. В окне Add A New Window Type введите MyWindow (или любое другое название) и щелкните OK. В диалоговом окне Window Type вы можете выбрать различные закладки, чтобы изменить кнопки, стили и т.д. Кликнув OK, будет создано новое определение окна.

Если вам надо включить в ваш справочный файл закладку Search — кликните Панель Навигации и выберите Add Search Tab. Нажав OK — перед вами появится Мастер, который поможет создать функцию поиска. На втором шаге выберите Compile Full-text Search Information, чтобы позволить компилятору Справки сформировать ключевые слова для поиска.

Кнопка HTMLHelp API Information позволяет установить параметры контекстно-зависимой справки. Когда вы нажмете эту кнопку, вы увидите диалог HTMLHelp API information. Вы можете сопоставить файл заголовков, который определяет все контекстные идентификаторы, в закладке Map (Карта). Рис.3 показывает содержание типичного файла заголовков.

Читайте также:  File explorer windows 10

Рис.3. Файл заголовков, используемый HTMLHelp API.

Вы можете использовать закладку Alias, чтобы сопоставить константы идентификаторов контекстной Справки, определенные в заголовке HTML-файла, как показано на рис.4. Когда вы вызываете HTMLHelp из VB с константой идентификатора контекстной Справки, вы можете показать нужную тему Справки, связанную с этой константой.

Рис.4. Сопоставление идентификторов с HTML-файлами в закладке Alias.

Вы можете также устанавливать "всплывающий" текст используя закладку Text Pop-ups. Подробнее об этой возможности смотрите в он-лайн Справке по HTML Help Workshop.

Компиляция вашего проекта Справки

Прежде, чем вы начнете компилировать, нажмите кнопку Change Project Options в закладке Project и выберите Default File для вашего проекта в закладке General. Вы можете также кликнуть закладку Files, чтобы изменить название скомпилированного файла или проверить оглавление и индексные файлы. Нажмите кнопку Save All Project Files And Compile, чтобы откомпилировать ваш файл.

По умолчанию, ваш откомпилированный справочный файл будет иметь то же самое название как файл проекта с расширением CHM. Если в течении компиляции в вашем проекте встретятся какие-либо ошибки вы увидите их в правом окне. После успешной компиляции вы сможете вызывать вашу Справку из VB.

Вызов Справки из VB

Вы можете использовать API-функцию HTMLHelp, чтобы показывать справочные файлы из VB. Сейчас мы покажем вам, как использовать HTMLHelp API так, чтобы вы смогли многократно использовать это. Для начала создадим класс и назовем его CHelp. Добавьте следующий код а ваше VB-приложение: Класс CHelp имеет один метод — Show, он показан в следующем примере и имеет одним из параметров — имя файла. Это имя файла может быть откомпилированным файлом (CHM) или HTML-файлом (HTM). В первом случае вы можете использовать следующие два параметра для управления окном Справки. Второй параметр WindowPane является необязательным. Он отвечает за настройки окна, которые мы обсуждали ранее и может использоваться, чтобы отображать Справку в различных видах. Третий параметр ContextID является также необязательным. Подставив значение ContextID вы сможете реализовать контекстно-зависимую справку. Как видите, вы должны включить символ ">" с именем файла, если вы используете WindowPane. Команда HH_DISPLAY_TOPIC показывает содержание справки в окне Help. HH_HELP_CONTEXT отображает справку в зависимости от ContextID. HTMLHelp API возвратит указатель созданного справочного окна.

Использование класса CHelp

Как только вы создаете класса CHelp, все, что вы должны делать — вызов метода Show с именем откомпилированного файла в качестве первого параметра. Вы можете также передавать название HTML-файла, чтобы открыть его непосредственно в окне темы справки без Панели Навигации и Панели Инструментов.

Следующий пример показывает, как вызвать метод Show в процедуре события Click кнопки cmdShow. Вы можете попробовать вызов с другими параметрами, чтобы управлять окном Справки.

HTML Help — справочная система нового уровня, которая придаст вашему приложению современный вид. Так как в ее основе лежит HTML, то вы можете включать в вашу справку изображения, видеоролики, анимацию и звук. Возможности бесконечны.

Дополнительную информацию Вы можете получить в компании Interface Ltd.

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная часть исходника. Именно эти файлы мы будем редактировать, чтобы обновить CHM. Но для сборки обновленного CHM-файла отредактированных файлов будет недостаточно. Чтобы собрать новый CHM-файл при помощи бесплатной программы HTML Help Workshop, вам также потребуется файл проекта. Поэтому прежде, чем перейти к редактированию, рассмотрим, как создать проект в HTML Help Workshop, и научимся собирать обновленный CHM-файл.

Создание проекта

Чтобы создать проект с базовыми настройками:

  1. Запустите HTML Help Workshop из меню Пуск.
  2. Выберите File / New.
  3. В окне New будет выделен Project. Нажмите на кнопку ОК. Будет открыто первое окно Мастера создания нового проекта.
  4. Для продолжения нажмите на кнопку Далее. В следующих пунктах описания данный шаг будет опущен.
  5. В окне New Project — — Destination укажите название проекта и путь к папке, в которой он будет создан: C: estdecompiled
    ew_prj.hhp
    . Можно также нажать на кнопку Browse и указать эти данные стандартным для ОС Windows способом.
Читайте также:  Delphi tag что это

  1. В окне New Project — — Existing Files пометьте все флажки, чтобы добавить в проект извлеченные из CHM файлы.

  1. В окне New Project — —Table of Contents нажмите Browse и выберите файл C: estdecompiledapi.hhc.

  1. В окне New Project — —Index нажмите Browse и выберите файл C: estdecompiledapi.hhk.

  1. В окне New Project — —HTML Files нажмите Add, выберите и добавьте все .htm-файлы из папки decompiled.

  1. В окне New Project — —Finish нажмите на кнопку Готово.

Будет создан проект для сборки справки. Файл проекта должен быть автоматически сохранен в выбранной папке.

Настройка проекта и тестовая сборка нового CHM-файла

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

Указать название справки, раздел по умолчанию и включить простой поиск:

  1. На вкладке Project щелкните Change Project Options.
  2. В окне Options на вкладке General введите название справки в поле Title. В оригинале это HTML Help API Reference.
  3. В раскрывающемся списке Default file: выберите файл ov_main.htm.

  1. Чтобы включить простой поиск, перейдите на вкладку Compiler, пометьте флажок Compile full-text search information и нажмите на кнопку ОК. Если сначала не включить простой поиск, это все равно придется сделать после активации расширенного поиска.

Включить расширенный поиск и избранное:

  1. На вкладке Project щелкните Add/Modify Window Definitions.
  2. В окне Add a New Window Type введите название для нового типа окна, например, new, и нажмите на кнопку ОК.

  1. В окне Window Types перейдите на вкладку Navigation Pane.
  2. В группе Tabs пометьте флажки Search tab, Advanced search, Favorites tab и нажмите на кнопку ОК. Окно Window Types будет закрыто.

  1. На вкладке Project снова щелкните Change Project Options, перейдите на вкладку Files и в поле Compiled file: проверьте путь к папке и название нового файла справки. Назовем его new_api.chm. В поле Compiled file: должно отображаться c: estdecompiled
    ew_api.chm
    .

  1. Нажмите на кнопку ОК.
  2. Выберите File / Save Project. Все должно быть готово к тестовой сборке справки.

Собрать новый CHM-файл

  1. Выберите File / Compile или на панели инструментов щелкните Compile HTML file.
  2. В окне Create a compiled file проверьте, чтобы для сборки был выбран файл текущего проекта, и нажмите на кнопку Compile.
  3. Перейдите в папку decompiled и запустите файл new_api.chm. Должен получиться следующий результат. Панель инструментов будет немного отличаться от оригинала.

Добавить кнопки на панель инструментов:

  1. В окне HTML Help Workshop на вкладке Project щелкните Add/Modify Window Definitions.
  2. В окне Window Types перейдите на вкладку Buttons.
  3. В группе Button Types пометьте флажки напротив тех кнопок, которые должны быть на панели инструментов, и снимите флажки напротив тех кнопок, которые необходимо скрыть.

  1. Нажмите на кнопку ОК.
  2. Выберите File / Save Project.
  3. Пересоберите справку. Должен получиться следующий результат.

Файлы, извлеченные из оригинального CHM, и файл проекта, созданный в HTML Help Workshop, вместе составляют новый исходник. Далее с ним можно работать: вносить изменения, дополнять, сокращать и т.д. этому посвящена следующая статья Внесение изменений и сборка нового CHM-файла.

Ссылка на основную публикацию
Adblock detector