Построение файла проекта

Создание таблицы содержания

Создание разделов руководства

Справка о справке

Об инструменте HTML Help Workshop

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

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

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

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

· Разделы справочного руководства создаются в Редакторе Word, привычном для большинства разработчиков. Здесь есть почти все необходимые для этого средства. Тем не менее, я рекомендую рассматривать Word только как промежуточный Редактор, используя FrontPage для окончательного редактирования. Дело в том, что не все файлы, созданные в Редакторе Word, будут без ошибок компилироваться и затем просматриваться в HTML Help Viewer. В моих экспериментах при компиляции таких файлов выдавались различные предупреждения о возможных ошибках. Хуже того, рисунки, вставленные в текст раздела, не просматривались при отображении справочного руководства. Последнее связано с тем, что Word вставляет рисунки в коллекцию Shapes. Элементы этой коллекции нормально просматриваются на Web-страницах как в самом приложении Word, так и в Intenet Explorer. Однако в HTML Help Viewer эти рисунки не просматриваются, поскольку там они должны быть представлены тегом Image.

· По-видимому, наиболее удобным Редактором для создания сложных разделов является FrontPage. Здесь легко и удобно создавать разделы, использующие все возможности Web-страниц, включая, например, изощренные мультимедийные средства. С другой стороны, файлы, созданные здесь, компилируются и просматриваются в HTML Help Viewer без каких либо ограничений, по крайней мере, в моих экспериментах.

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

В нем присутствуют два типа элементов - книги и страницы. С каждой книгой и страницей связан отдельный раздел - соответствующий HTML -файл. Книги отличаются тем, что в них могут быть вложены другие книги, о чем уже говорилось ранее. В приведенном выше тексте названия книг выделены жирным шрифтом, курсивом - названия страниц. В соответствии с этим планом наше руководство будет состоять из 10 разделов, составляющих на верхнем уровне две книги - "Microsoft HTML Help" и "Answer Wizard". В первую из этих книг, в свою очередь, вложены еще две книги.

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

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

Теперь, когда созданы разделы справочного руководства, можно приступить и к созданию файла, хранящего таблицу содержания (оглавление) нашего руководства. До этого этапа сама система HTML Help Workshop нам была не нужна, так как файлы разделов создавались в среде FrontPage, где возможности по созданию HTML -файлов гораздо шире. Но теперь, при создании таблицы содержания, необходимо войти в среду HTML Help Workshop. Главное меню, как обычно, содержит пункт File и работа, как обычно, начинается с того, что создается новый файл. Вот как выглядит диалоговое окно New, открываемое при выборе соответствующего пункта из меню File, позволяющее создавать в HTML Help Workshop файлы разного типа:

Рис. 8.1. Начальный шаг в процессе создания оглавления справочного руководства

Для создания таблицы содержания открывается соответствующее диалоговое окно:

Рис. 8.2. Диалоговое окно для создания таблицы содержания

В этом окне главное меню системы осталось без изменения, но слева появилась инструментальная панель с кнопками. Верхняя кнопкапоказывает свойства таблицы содержания. Еще две кнопкиипозволяют соответственно редактировать элемент оглавления или удалить его. Главную функциональную роль играют две кнопки -"heading" и "page". На первой изображен значок папки -, на второй - страницыЭти кнопки задают два уже упоминавшихся типа элементов оглавления - книг и страниц. Если на очередном этапе создания оглавления мы хотим задать книгу, в которой будут располагаться страницы и, возможно, другие книги, то выбирается кнопка "heading", в противном случае - "page".

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

В следующей серии диалоговых окон, которые появляются при выборе любой из кнопок, - Heading или Page, можно задать название пункта оглавления и связать его с ранее созданным файлом раздела. Вот как выглядит первое из этих окон, когда задано имя пункта оглавления и связано с ним имя файла раздела:

Рис. 8.3. Связывание пункта оглавления с файлом, содержащим соответствующий раздел руководства.

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

В случае, когда предполагается получать контекстные справки по тем или иным разделам, необходимо выполнить дополнительную работу. Суть этой работы состоит в том, что в справочное руководство включаются еще два раздела - MAP и ALIAS, позволяющие с каждым разделом связать числовой и символьный идентификатор. Техника вызова конкретного раздела справочного руководства, основанная на знании, прежде всего, числового идентификатора - HelpContextID - широко используется в работе с документами Office 2000. Эти вопросы будут подробно обсуждаться в следующей лекции. Сейчас же отмечу, что в тех случаях, когда справочное руководство вызывается, как единое целое, создание этих разделов не является обязательным.

Можно начинать создавать проект на пустом месте, когда никаких компонент еще нет. Но можно поступить так, как сделал я в данном примере, приступая к созданию файла проекта, когда значительная часть информации, необходимая в проекте, уже создана. Для создания файла проекта, также как и для любых файлов, создаваемых в среде HHW, в меню File нужно выбрать пункт New, а затем в появившемся окне выбрать нужный тип создаваемого файла. Соответствующий Мастер ведет нас на всех этапах создания проекта. Вот как выглядит диалоговое окно на первом шаге работы Мастера:

Рис. 8.4. Начальный шаг создания проекта "Справка о справке"

На последующих шагах работы Мастера указывается, какие компоненты уже созданы и где они хранятся. Я не буду останавливаться на деталях этого процесса, интерфейс на каждом шаге достаточно понятен и соответствует интуитивным представлениям. В моем случае я сообщил Мастеру, что уже созданы файлы разделов и файл с таблицей содержания, указал также место их хранения, так что все эти файлы автоматически были подключены к проекту. Замечу, что, конечно же, и после построения проекта в любое время можно вводить новые разделы и модифицировать оглавление. После того, как Мастер завершил создание проекта, следует выполнить компиляцию проекта, что я и сделал. Взгляните, как выглядит HHW после завершения компиляции проекта. Рис. 8.5. Результат компиляции проекта "Справка о справке" В левом окне отображаются данные о проекте, в правом - о результатах компиляции. В нашем случае никаких сообщений об ошибках компиляции не было, но сами понимаете, такие сообщения могут появляться. Указано время компиляции (3 секунды) и другая полезная статистика, в частности, число разделов, число локальных гиперссылок и ссылок Интернет, объем файла до и после сжатия. Замечу, что неверно подсчитывается число рисунков, встречающихся в разделах справочного руководства. Теперь первый вариант задуманного нами справочного руководства создан, - он хранится в откомпилированном файле с уточнением ".chm". Его можно просмотреть его в специальном обозревателе HTML Help Viewer, который, как мы говорили, использует компоненты Internet Explorer, хотя и не совпадает с ним полностью. Просмотреть справочное руководство непосредственно в HHW можно двояко, либо щелкнув по кнопке, расположенной на инструментальной панели, либо вызвав из пункта Test главного меню команду HtmlHelp API. В последнем случае используется уже упоминавшаяся функция HtmlHelp, входящая в состав элемента HTML Help ActiveX. Когда используется этот способ, то в открывающемся диалоговом окне следует выбрать команду HH_DISPLAY_TOPIC, позволяющую просматривать скомпилированный файл с уточнением ".chm"или любой из его разделов, указав имя соответствующего HTML-файла. Первый способ тестирования справочного руководства, конечно же, проще, но второй более универсален, поскольку обращение к функции API -может быть выполнено при необходимости и в процедуре, разработанной программистом. Пришла пора взглянуть на то, как выглядит созданное справочное руководство: Рис. 8.6. Справочное руководство "Справка о справке" и его оглавление Как видите, интерфейс справочного руководства выглядит вполне привычно для пользователей Office 2000 и напоминает справочную подсистему приложений Office. В левом окне показано оглавление, которое в данном случае полностью раскрыто и соответствует спроектированному нами плану. В правом окне отображается раздел, соответствующий выбранному пункту оглавления. В тексте раздела видны гиперссылки, которые позволяют организовать переходы из раздела в раздел или при необходимости начать бродить по сети Интернет, что также возможно. Но давайте поговорим об этом подробнее. Рисунки и ссылки Несомненным преимуществом создаваемого справочного руководства является то, что разделы справки создаются как HTML - файлы и, следовательно, обладают всеми возможностями Web-страниц. В частности, это могут быть активные страницы, использующие возможности DHTML и элементов ActiveX. В нашем примере я не стал использовать весь набор возможных средств, ограничившись исследованием двух элементов, наиболее часто используемых в справках, - рисунках и ссылках. Рисунки способствуют пониманию сложных понятий и потому часто используются в справочных системах. В разделе "Рисунки" показано отображение рисунков, представленных пятью наиболее употребительными графическими форматами - wmf, gif, jpeg, bmp и png. Все эти форматы отображаются без всяких помех. Вот как выглядят часть из отображаемых рисунков: Рис. 8.7. Отображение рисунков в справочной системе

Хотя, как видите, рисунки разных форматов отображаются без проблем, но хочу напомнить, что многое зависит и от того, в каком Редакторе создан файл с рисунками. Вначале я создал файл с рисунками в приложении Word. Этот файл без проблем отображался в Internet Explorer, однако Viewer системы HHW не отображал рисунки, поскольку не понимал тегов, созданных в приложении Word. Напомню, что в этом приложении рисунки помещаются в коллекцию Shapes и им не соответствуют теги Image. Никаких проблем с рисунками не возникает, если соответствующий раздел подготовлен в приложении FrontPage, возможно, путем копирования соответствующего документа Word.

Поговорим теперь о ссылках - еще одном важном элементе разделов справочной системы. В хорошей справочной системе разделы связаны ссылками, так что, зацепившись за один раздел, можно пройти по цепочке связанных разделов, получив всю нужную информацию. Нет никаких проблем создания гиперссылок в том же Редакторе FrontPage. Источником ссылки (якорем) может быть любое слово, фраза или рисунок, а целью (URL) может быть имя файла, задающего раздел справочной системы или адрес в Internet. Заметьте, что в приложении FrontPage можно указать адрес любого файла, но в справочной системе будут правильно работать ссылки только на разделы этой системы. В нашем примере гиперссылки появляются в нескольких разделах, что позволяет переходить из раздела в раздел. Большинство ссылок сосредоточено в разделе "Ссылки":

Рис. 8.8. Раздел "Ссылки" справочного руководства

Здесь есть различные ссылки, как локальные - на разделы справочной системы, так и глобальные, в частности, на домашнюю страницу Microsoft. В качестве якорей используются как фразы, так и рисунок совы, вставленный в раздел. Взгляните, как работает ссылка на страницу Microsoft:

Рис. 8.9. Выход в Internet из справочной системы

Таким образом, можно существенно расширить возможности справочной системы, поскольку не найдя нужной информации в ее разделах, можно перейти в Internet и попытаться найти там нужные сведения, например, на соответствующем узле Microsoft. Заметьте, что страницы Internet отображаются в окне справочной системы, что означает, что они просматриваются с помощью Viewer, а не Internet Explorer.

Хочу обратить внимание на одну важную особенность Viewer, - все-таки его возможности ограничены в сравнении с Internet Explorer. Он, в частности, не понимает русского языка и потому нельзя использовать в гиперссылках русские имена файлов. Так что есть серьезное ограничение - имена файлов, задающих разделы справочного руководства, должны быть в латинице, чтобы не было проблем со ссылками на эти разделы.