Microsoft HTML Help

Разработка интерактивных описаний

 

Можно как угодно относиться к компании Microsoft, но невозможно не признать, что по части заботы об удобстве пользователя до сих пор никто не превзошёл команду Билла Гейтса. Ещё одним аргументом в пользу данного мнения может послужить факт выпуска очередной версии программы HTML Help, предназначенной для создания компактных файлов поддержки, содержащих описание разрабатываемого вами программного продукта или, скажем, дайджест коммерческого Web-сайта.

Попробуем пояснить основные принципы работы с HTML Help.

Начнём с начала.

Программа HTML Help абсолютно бесплатно распространяется компанией Microsoft. Вес основного дистрибутивного файла 4 Mb, дополнительный модуль, позволяющий создавать оболочки на 28 различных языках (в том числе, по-русски), весит около 500 Kb.

Требования к системе минимальные: 8 Mb свободного дискового пространства и наличие инсталлированного браузера MS Internet Explorer (версия не ниже 3, лучше всего 5).

HTML Help позволяет работать с готовым документом (предпочитает форматы htm или txt) или создавать новые документы с помощью встроенного редактора текстов Notepad и простого графического редактора Image Editor. На выходе разработчик получает компактный файл описания в формате chm, в несколько раз меньший по размерам аналогичного по содержанию htm-файла. При этом chm-файл содержит все тексты, гиперссылки и картинки из исходного файла, плюс может быть запущен на компьютере, как в самостоятельной оболочке, так и в качестве дополнительного модуля к существующей программе. Качество картинок в chm-описании совсем незначительно уступает качеству исходных графических файлов.

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

- полностью подготовить базовый текст с картинками в Word (формат doc или rtf),
- импортировать готовое описание во Front Page (формат htm) и работу в HTML Help начинать с “чистовика” гипертекста.

 

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

Инсталлируйте программу HTML Help на свой компьютер и произведите первый запуск: Start (Пуск) > Programs (Программы) > HTML Help Workshop. Для создания приложения нужен сам Workshop, его спутник Image Editor предназначен только для редактирования картинок.

Инициируйте создание нового описания, выбрав меню File > New или, нажав на кнопку . В возникшем окне New отметьте строку Project и смело жмите на OK.

Программа передаст бразды управления вездесущему Волшебнику (Wizard), который поможет вам сделать первые шаги. После того, как Волшебник поведает правдоподобную сказку о своих безграничных возможностях, вы нажмёте на Next (Далее) и окажетесь перед необходимостью придумать имя для своего проекта (в нашем случае, “hhrus”). В дальнейшем это имя будет использовано при генерации проектного файла hhp, поэтому лучше выбрать имя покороче и отказаться от кириллицы.

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

Поскольку желательно на этом этапе отметить сразу все участвующие в подготовке проекта файлы, не забудьте, что

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

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

Теперь можно безбоязненно жать на Next (Далее) и Finish (Готово). Всё, полки готовы к бою. Переходим к непосредственной работе над проектом.

 

Для начала необходимо скомпилировать наши файлы (то есть загнать всё в одну “миску для фарша”). Нажмите на кнопку Compile HTML file и далее на кнопку Compile. После кратких пререканий по поводу необходимости сохранить последние изменения, программа HTML Help примется перемалывать htm-файлы и файлы, на которые есть ссылки из гипертекстов. Дождитесь окончания этой процедуры и внимательно вглядитесь в сообщения об ошибках, во время компиляции программа могла, например, обнаружить ссылки на несуществующие ресурсы.

Теперь перейдём к наполнению содержанием оглавления нашего проекта. Для этого придётся нажать на кнопку Contents.

  

Не забудьте дать имя hhc-файлу содержания проекта.

 

Основные рабочие кнопки при создании оглавления:

 Contents properties - вызов таблицы основных свойств (установите поддержку кириллицы, остальное – по усмотрению; General > Font > Change),

 Insert a heading – установить заголовок документа,

 Insert a page – установить страницу документа,

 Edit selection – редактировать отмеченную позицию,

 Delete selection – удалить отмеченную позицию.

Этот этап, пожалуй, самый захватывающий. Если вам когда-нибудь приходилось писать книги, вы наверняка знаете, что именно при работе с оглавлением автор начинает ощущать собственную значимость. “Неужели всё это моё? Надо же, ведь это я сам написал… и т.д.”

Стрелками (вверх, вниз, вправо, влево) можно перемещать строки, поэтому окончательную сортировку строк оглавления можно произвести в последнюю очередь. При установке заголовка или страницы необходимо дать название ресурсу (Entry Title) и указать его точное месторасположение на компьютере (Edit > Browse). Наводить красоты лучше, уже имея перед глазами полный перечень глав, разделов и т.п. Выбирать подходящую иконку стоит на этапе окончательного редактирования (Edit selection > Advanced > Image index). После завершения процедуры создания оглавления произведите ещё раз компиляцию проекта и убедитесь в том, что не возникло новых ошибок. Далее кликните на клавишу View Compiled File и любуйтесь на здоровье своим детищем (уже в формате chm).

Налюбовались? Приступим к формированию раздела поиска по ключевым словам. Для этого необходимо снова запустить проектный hhp-файл и вызвать меню Index. Если вы хотите, чтобы поиск можно было производить как по английским, так и по русским ключевым словам, определите с помощью кнопки Index properties базовый язык как русский (Font > Change > Russian). Список ключевых слов определяет разработчик. Он же указывает путь от ключевого слова к нужному разделу (или разделам). Постарайтесь максимально заполнить поисковый словарь, отдавая предпочтение терминам, не встречавшимся в названиях разделов. Чем полнее и удобнее будет поисковая библиотека системы поддержки, тем большему числу пользователей программа придётся по душе.

 

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

 Insert a keyword - ввести ключевое слово (фразу) (Keyword) и указать путь до нужного раздела (Edit > Browse),

 Edit selection - редактировать отмеченную позицию,

 Delete selection - удалить отмеченную позицию,

 Sort keywords alphabetically - сортировать ключевые слова (фразы) по алфавиту.

Если вы уже подготовили поисковую систему по ключевым словам, пора приступить к генерации системы “полного контентного поиска”, то есть поиска по всем словам, содержащимся в создаваемом описании. Для этого нужно запустить проектный hhp-файл, выбрать окно Project, кликнуть на кнопку Add/Modify Windows Definitions (Дополнить/Изменить Определения Окон), в открывшейся таблице Window Types (Виды Окна) выбрать меню Navigation Pane (Панель Навигации), отметить галочками окна Search Tab и Advanced, нажмите на OK. Все дальнейшие шаги вам подскажет Волшебник (Wizard). Не забудьте только отметить Compile full-text information, тогда ваша поисковая система уж точно ничего не пропустит. Теперь, после перекомпиляции проектного файла, в chm-описании добавилось окно Search (Поиск), к помощи которого вы так часто прибегаете, когда изучаете по описанию чужое программное обеспечение.

В последней версии программы HTML Help появилась возможность добавить на панели меню Избранное (Favorites). В уже знакомом меню Navigation Pane, в строке Window Type указать имя, например “Избранное” или “Закладки”, отметить галочкой позицию Favorites Tab и нажать на OK. Наполнить содержанием и смыслом этот раздел можно, непосредственно редактируя chm-файл. Для этого достаточно отметить нужный раздел в окне Contents (Содержание), открыть окно Favorites (Избранное) и добавить избранный раздел в список излюбленных мест.

Несколько слов о создании дополнительных кнопочек.

Кликните на кнопку Add/Modify Windows Definitions, выберите меню Buttons (Кнопки).

 

htmlhelp26.gif (7302 bytes)
Hide/Show - Скрыть/Показать левый бар
 
Back - Назад - возврат к предпоследнему шагу
 
Forward - Вперёд - возврат к последнему шагу
 
Stop - Остановить загрузку страницы
 
Refresh - Обновить - перегрузить текущую страницу
 
Home - Домой - переход на стартовую страницу
 
Options - Параметры - "все в одном флаконе"
 
Print - Печать - вывод страницы на печать
 
Locate - Найти - показ текущей темы в оглавлении
 
Jump 1/2 - По выбору 1/2 - создание собственной кнопки с переходом на указанную страницу

 

Если вас действительно заинтересовала эта программа, и вы решили стать специалистом в области создания интерактивных описаний к программным пакетам, закажите себе книгу “The Official Microsoft HTML Help Authoring Kit” на www.amazon.com. К сожалению, полное описание программы HTML Help пока существует только на английском языке. Данная статья - первая, насколько мне известно, попытка дать краткую информацию о программе по-русски для широкой публики. Среди российских продуктов аналогичного назначения можно отметить программу компании “Анет” - Anet Help Tool. Там же рекомендую почитать статьи в разделе “Help технологии”. По моему опыту, специалисты в этой области пользуются немалым спросом.