Фролова доклад. Программы для создания helpфайлов, их функционал, сравнение
 Скачать 1.19 Mb.
|
|
ФЕДЕРАЛЬНОЕ АГЕНТСТВО СВЯЗИ Ордена Трудового Красного Знамени федеральное государственное бюджетное образовательное учреждение высшего образования Московский технический университет связи и информатики Кафедра информационных систем ДОКЛАД по дисциплине Программная инженерия Тема: «Программы для создания help-файлов, их функционал, сравнение» Выполнил: Жанибек к Н., Потемкина Яна; группа ББИ1601 Принял: доцент, к.т.н. Ванина М.Ф. Москва, 2019 Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для просмотра CHM-файлов есть во всех версиях Windows10. Более того, наличие справки в приложении часто рассматривается как один из показателей качества приложения. В этой статье я расскажу о том, как создать справку в формате CHM. Справка в формате HTML Help (CHM) представляет собой скомпилированный HTML — автономный веб-сайт, сжатый и упакованный в файл формата CHM. Наряду со стандартным функционалом, таким как динамическое оглавление, указатель и полнотекстовый поиск, HTML Help может содержать и дополнительный функционал, например, избранное и т.д. Подробное описание формата можно посмотреть в статье Формат HTML Help. Создать CHM справку можно при помощи специальных программ, как платных, так и бесплатных. Бесплатные программы для создания CHM-справки MS HTML Help Workshop. Компания Microsoft, разработчик формата CHM, предоставила для создания справки бесплатный инструмент, HTML Help Workshop. Его можно свободно скачать с сайта компании. В составе программы имеется максимально подробный файл справки на английском языке. На сайте есть подробное описание формата, также в оригинале. Не будем приводить пошаговые инструкции по работе с данной программой. С 1997 года их прилично накопилось в сети Интернет. В печатном виде с пошаговыми инструкциями можно ознакомиться в книге А. Гультяева «Help. Разработка справочных систем» на страницах 187-208. Очевидный, и, на мой взгляд, единственный плюс программы HTML Help Workshop — бесплатность. Создание более-менее серьезной справки в HTML Help Workshop — очень трудоемкая задача, выполнение которой растягивается на многие месяцы. При этом вы получите справку с базовыми возможностями формата CHM: текст, рисунки, ссылки. Регулярное обновление справки на базе проекта, созданного в HTML Help Workshop, практически нереально. Я пользуюсь данной программой исключительно для компиляции / декомпиляции CHM-файлов. В более продвинутых бесплатных и профессиональных программах, предназначенных для разработки справочных систем, HTML Help Workshop используется в качестве компилятора (Компиляция — сборка программы, включающая трансляцию всех модулей программы). Это говорит о солидном потенциале формата, скрывающемся под непростым пользовательским интерфейсом инструмента. Рассмотрим еще несколько более продвинутых программ, при помощи которых можно создать справку в формате CHM, то есть HelpNDoc и Help+Manual. HelpNDoc HelpNDoc — это условно-бесплатная программа от французского разработчика, компании IBE Software. Пользовательский интерфейс программы выполнен в стиле MS Office, поэтому работу с программой можно быстро и легко освоить. Для работы с текстом, рисунками, таблицами, ссылками и другим контентом в HelpNDoc используется простой и интуитивно понятный визуальный редактор. HelpNDoc работает по принципу единого источника и поддерживает экспорт проекта в ряд форматов справки, в том числе, CHM. На момент написания статьи выпускается 3 редакции программы: Standard — платная редакция, позволяющая генерировать CHM и Web-Help в коммерческих целях. Выходные файлы в остальных форматах (DOCX, PDF, EPUB и др.) будет содержать отметку о том, что они созданы некоммерческой версии программы. Professional — платная редакция без отметок во всех выходных форматах. Personal — полнофункциональная программа, бесплатная для личного, некоммерческого использования. Во всех выходных форматах в нижней части всех страниц добавляется отметка о том, что файл создан с использованием некоммерческой версии HelpNDoc.  Существует множество пошаговых инструкций, как при помощи HelpNDoc создать справку в формате CHM. Они есть и в текстовом формате, и в формате видео уроков на английском и на русском языках. Так, канал разработчика HelpNDoc на YOUTUBE содержит порядка 60 обучающих видео с пошаговыми инструкциями на английском языке. На русском языке можно рекомендовать работы Стремнева А.Ю., например, статью «Разработка электронных учебных пособий в системе HelpNDoc» (Высшее образование в России, №11, 2015 г.) и другие. HelpNDoc позволяет быстро написать с нуля и оперативно обновлять справку в различных форматах. Во время работы с программой не хватает возможности вставки в документацию элементов, характерных для электронных форматов: раскрывающихся блоков с контентом, адаптивных изображений, размер которых автоматически подстраивается под размер окна и т.п. Разумеется, все это можно реализовать, используя готовые или написанные самостоятельно стили и скрипты, но это отрывает технического писателя от главной задачи: разработка и обновление справки. Как создать профессиональную справку в формате CHM. Help+Manual 7 – это программный комплекс, в котором есть всё необходимое для автора пользовательской документации. Он предназначен для разработки и локализации профессиональных справочных систем, руководств пользователя, баз знаний, электронных книг и другой документации в форматах CHM, WebHelp, PDF, DOCX, EPUB, MOBI и др. для настольных и мобильных приложений, iOS и Android, Windows и Linux. Общая характеристика. Чем больше справочного материала в распоряжении пользователя, тем спокойнее он должен себя чувствовать. Но обилие материалов порождает другую проблему: как обеспечить пользователю быстрый и удобный доступ к конкретной теме, к конкретному термину и т.д. Создание электронной документации уже длительное время базируется на технологии гипертекста. Одно из важнейших его достоинств - наличие интерактивных ссылок, которые позволяют читателю перемещаться между темами почти в произвольном порядке. "Почти", потому что на самом деле возможные переходы определяются навигационной структурой документа, предложенной его создателем. Кроме того, определенные особенности в работе с документом обусловлены спецификой конкретного гипертекстового формата. В настоящее время для создания гипертекстовых документов применяются около десятка различных форматов, включая PDF (Portable Document Format), RTF (Rich Text Format), DOC (Document Word) и WinHelp (Windows Help), а также целое семейство языков гипертекстовой разметки, самыми популярными из которых можно считать HTML (Hypertext Markup Language) и XML (eXtensible Markup Language). Сюда же следует добавить и специализированный формат CHM (Compiled HTML). Однако далеко не все из существующих форматов пригодны для создания справочников. Причины разные: одни форматы не обеспечивают приемлемую компактность итогового документа, другие не обладают достаточной функциональностью и выразительностью, третьи требуют установки на компьютеры пользователей дополнительного (причем дорогостоящего) программного обеспечения.  Файл справочной системы в формате PDF. Доступ к справочнику может быть реализован несколькими способами. Наиболее распространенный из них - явный вызов посредством соответствующей команды меню справка, но возможны также использование специальной кнопки на панели инструментов или вызов через контекстное меню значка конкретного объекта. Итак, для того чтобы формат электронного документа был пригоден для создания справочника, он (формат) должен обладать следующими свойствами: обеспечивать приемлемую компактность итогового документа; обладать достаточной функциональностью (в частности, поддерживать полнотекстовый поиск); поддерживать возможность представления мультимедийной информации (графики, видео, звука); не требовать установки на компьютеры пользователей дополнительного программного обеспечения; достаточно легко интегрироваться с программным кодом создаваемого приложения. Для приложений, разрабатываемых под Windows, на сегодняшний день большинству их перечисленных выше требований отвечают три формата: WinHelp, HTML, HTML Help (CHM). За время, прошедшее с момента появления Help Workshop (а затем - HTML Help Workshop), сторонними разработчиками было предложено немало инструментов предназначенных для создания справочников. Однако все они для генерации выходных файлов (.hlp и .chm) используют движки от Help Workshop и HTML Help Workshop. В одних продуктах задействованы только компиляторы соответствующих форматов, в других разработчику справочника предоставлялся полный доступ к интерфейсу Help Workshop и HTML Help Workshop. Таким образом, когда встает вопрос о выборе наиболее подходящего инструмента, имеет смысл принимать во внимание следующие факторы: Какие выходные форматы справочников он поддерживает; Насколько полно он использует те возможности, которые предоставляет формат справочника; Насколько удобны средства управления параметрами проекта; Имеются ли в составе инструмента средства тестирования гипертекстовых ссылок; Позволяет ли инструмент работать с исходными форматами данных (RTF - для WinHelp и HTML - для HTML Help); Насколько удобно реализовано взаимодействие с дополнительными инструментами, необходимыми для подготовки мультимедийных материалов; Какова степень (или возможность) интеграции со средой разработки приложения, для которой создается справочник. При создании справочников на русском языке существенным фактором является также то, насколько корректно инструмент работает с кириллицей (хотя сами форматы WinHelp и HTML Help никаких ограничений в этом отношении не накладывают.) Microsoft Help Workshop Справочные системы в формате WinHelp появились практически одновременно с созданием первых приложений для Windows 3.*, получив с тех пор широкое распространение. Немалую роль в этом сыграло наличие весьма удобного и совершенно бесплатного инструмента для разработки справочников в формате HLP - Microsoft Help Workshop. Основные особенности формата WinHelp: Формат WinHelp позволяет готовить исходный текстовый материал для справочника в любом текстовым редакторе, что, в свою очередь, позволяет привлекать к работе специалистов в соответствующей предметной области без дополнительной подготовки. Справочник в формате WinHelp существенно (в несколько раз) компактнее аналогичного по объему документа в формате DOC и компактнее исходного файла в формате RTF. Специальная программа просмотра HLP-файлов (WinHelp) входит в состав Windows, не требует установки и при необходимости может быть просто скопирована на компьютер пользователя (файл WINHLP32.EXE имеет небольшой размер - всего около 300 Кбайт). Формат WinHelp обладает поистине широчайшей функциональностью, в том числе: возможностью иерархической организации документа в сочетании с удобными средствами навигации; поддержкой графики, видео и звука; возможностью полнотекстового поиска по ключевым словам и тематического поиска по разделам, возможностью создания индексной базы данных и многим другим. В настоящее время операционные системы семейства Windows поддерживают три версии формата WinHelp: WinHelp 3 (16-разрядная версия для Windous 3.*), WinHelp 4 (32-разрядная версия для Windous 9*) и WinHelp 2000 (модифицированная 32-разрядная версия от компании eHelp). Help Workshop используется исключительно на создании справочников в формате WinHelp. Причем последняя версия продукта (Help Workshop 4.0) поставляется только с компилятором HCRTF (файл HCRTF.EXE), который обеспечивает создание справочника в формате WinHelp 4. (Для создания справочника в формате WinHelp 3 требуется компилятор HCP.EXE) С точки зрения файловой системы справочник в формате WinHelp представляет собой файл специального формата с расширением .hlp. Такой файл создается путем компиляции предварительно подготовленного и специальным образом размеченного текстового файла в формате RTF. Компиляцию выполняют с помощью соответствующих инструментальных средств, в частности, с помощью программы Help Workshop, входящей в состав пакета Visual Studio и доступный (в свободном доступе для скачивания) на сайте Microsoft. Если для работы со справочником предусмотрено окно навигации с вкладкой Содержание, то на компьютер пользователя дополнительно должен быть перенесен одноименный файл с расширением .cnt (Help Contents File), хранящий описание структуры (оглавление) справочника. При первом обращении к справочнику в той же папке генерируется одноименный файл конфигурации с расширение .gid (по умолчанию для него установлен атрибут Скрытый). Если для работы со справочником предусмотрена вкладка поиск, то при первом обращении пользователя к функции полнотекстового поиска будет сгенерирован файл словарной базы справочника с расширением .fts (аббревиатура от Full-Text Search). Сам файл проекта имеет расширение .hpj (Help Project File). Следует отметить, что пакет Help Workshop снабжен весьма подробной справкой, которая содержит сведения не только о самом инструменте, но также описание технологии создания справочника в формате WinHelp, справочник по макросам WinHelp и другую полезную информацию. WinHelp 2000 Формат WinHelp 2000 был разработан не компанией Microsoft, а создателем пакета RoboHelp, компанией eHelp Corporation. По организации интерфейса и функциональным возможностям формат WinHelp 2000 близок к Microsoft HLP Help. Основное визуальное отличие справочника в формате WinHelp 2000 от предшествующих форматов состоит в том, что панель навигации справочника реализована в виде фрейма, входящего в состав единого окна справочника. Благодаря этому пользователи получили возможность видеть одновременно и средства навигации в справочнике, и собственно справочную информацию. Помимо указанной выше особенности, формат WinHelp 2000 поддерживает некоторые дополнительные функциональные возможности. В панели инструментов окна справочника появилась интеллектуальная кнопка "Смотри также". Эта кнопка обеспечивает доступ к связанным темам следующим образом: если выбранная пользователем тема входит в группу тем, связанных с некоторым ключевым словом, то щелчок на кнопке открывает список всех относящихся к этому ключевому слову тем. WinHelp 2000 позволяет создавать на страницах справочника ссылки на локальные HTML-файлы, а также на файлы, размещенные в Интернете или Интранете. Когда пользователь щелкает на такой ссылке, вызываемая страница отображается в окне справочника. WinHelp 2000 позволяет присоединять к страницам справочника графический фон с водяными знаками. Это позволяет создать для справочника в целом либо для отдельных его разделов определенное стилевое оформление и сделать тем самым его узнаваемым для пользователей. При всех перечисленных достоинствах у формата WinHelp 200 есть один (по крайней мере) недостаток: пока он не является стандартным для операционных систем семейства Windows. Чтобы реализовать присущие этому формату возможности, справочная система должна устанавливаться на компьютеры пользователей вместе с дополнительными динамическими библиотеками (необходимые DLL-файлы помещаются в папку Windows/System). Если необходимая библиотека на компьютере пользователя отсутствует, при попытке открыть файл справки на экран будет выведено соответствующее сообщение. После которого файл справки буде открыт в формате WinHelp 4. Справочник на языке HTML. Технология создания такого справочника практически не отличается от технологии создания веб-сайта и предполагает наличие у разработчика соответствующих знаний и навыков, а также знакомство с инструментами веб-дизайна. Достоинства: Независимость от платформы, на которой работают потенциальные пользователи. Возможность использовать при создании справочника все средства, которые поддерживаются языками HTML 4 и Dynamic HTML, в том числе: интерактивность, основанная на включении в страницы справочника разнообразных элементов управления и связанных с ними сценариев; стилевое оформление страниц справочника на основе технологии CSS (Cascading Style Sheets); наполнение страниц справочника различными мультимедийными элементами (анимацией, Flash-роликами, видео, звуковым рядом); удобная интеграция с удаленной (сетевой) службой технической поддержки от компании-производителя программного обеспечения. Многие программисты владеют инструментами веб-дизайна значительно лучше, чем менее популярными специализированными средствами создания справочных систем. То есть создание HTML-справочника избавляет многих авторов от необходимости освоения новых инструментов и технологий. Недостатки: Для просмотра HTML-справочников требуется дополнительное программное обеспечение - Интернет-браузер. Что может доставить многим пользователям определенные неудобства: пользователь совсем не обязательно должен иметь на своем компьютере установленный браузер, и уж тем более он не обязан уметь работать с ним; практически все современные браузеры предоставляют пользователям широкие полномочия по управлению их работой (например, многие пользователи отключают в браузерах загрузку графики, звука, запрещают использование сценариев, Java-апплетов, таблиц CSS и т.д., причем вряд ли такой пользователь захочет изменят настройки, чтобы просмотреть справочник, и что он тогда сможет увидеть или услышать?); совсем не обязательно разработчик справочника является хорошим веб-дизайнером, способным унифицировать верстку справочника для всех популярных браузеров, а ведь каждый из них имеет определенные особенности в интерпретации HTML-документов - в результате часть пользователей может увидеть на экране совсем не то, что предполагал автор. Любой HTML-справочник - это совокупность достаточно большого числа самостоятельных и притом совершенно разнотипных файлов. Это не только затрудняет распространение справочника среди пользователей, но и снижает его надежность: стоит только потерять или испортить одну папку (или даже один файл), и часть справочной информации окажется недоступной пользователям. Отследить же своевременно такую потерю бывает очень сложно. Для HTML-справочника невозможен полнотекстовый поиск штатными средствами браузера, что существенно снижает эффективность применения такого справочника. |