СОДЕРЖАНИЕ
ВВЕДЕНИЕ 2
1.2 Компьютерная документация: назначение 2
1.2 Выбор формата хранения компьютерной документации 2
ПРОЕКТИРОВАНИЕ И АНАЛИЗ ПРЕДМЕТНОЙ ОБЛАСТИ 7
2.1 Импорт компьютерной документации форматов HTML и CHM 7
2.2 Модификация компьютерной документации 8
2.3 Автоматизация конвертирования и модификации компьютерной документации. 8
2.4 Конвертирование компьютерной документации в формат CHM 8
2.4.1 Проектный файл 9
2.4.2 Параметры секции OPTIONS 10
2.4.3 Секция FILES 10
2.4.4 Оглавление и предметный указатель 11
2.5 Модульная структура 13
2.5.1 Модуль конфигурации 14
2.5.2 Модуль генерации CHM-файла 14
2.5.3 Модуль модификации содержания документации 15
2.5.4 Модуль модификации оглавления документации 15
3.1 Модуль конфигурации 16
3.2Модуль генерации CHM файлов 26
3.3Модуль модификации содержания документации 29
3.4Модуль модификации оглавления документации 36
3.5Модуль конвертирования источника во внутреннее представление 39
ЗАКЛЮЧЕНИЕ 42
СПИСОК ЛИТЕРАТУРЫ 43
ПРИЛОЖЕНИЕ 45
Пример конфигурации 45
ВВЕДЕНИЕ
Процессы разработки (сопровождения и т.д.) документации всегда и везде идут плечом к плечу с процессами разработки изделий, программных изделий, создания автоматизированных систем. В крупных компаниях в процессе разработки документации задействовано, как правило, значительное число специалистов различных подразделений. В мелких и средних компаниях техническая документация «составляется» узким кругом лиц, именующих себя техническими писателями.
Как бы то ни было, для большинства компаний процесс разработки (сопровождения и т.д.) документации остается занятием в немалой степени рутинным, трудоемким и ресурсоемким и, как правило, неблагодарным по отношению к непосредственным исполнителям.
1.2 Компьютерная документация: назначение
С каждым годом компьютерная информация играет все более важную роль в нашей жизни. Чем больше справочного материала в распоряжении пользователя, тем спокойнее он должен себя чувствовать. Но обилие материалов порождает другую проблему: как обеспечить пользователю быстрый и удобный доступ к конкретной теме, к конкретному термину и т.д. Создание электронной документации уже длительное время базируется на технологии гипертекста. Одно из важнейших его достоинств − наличие интерактивных ссылок, которые позволяют читателю перемещаться между темами почти в произвольном порядке. «Почти», потому что на самом деле возможные переходы определяются навигационной структурой документа, предложенной его создателем. Кроме того, определенные особенности в работе с документом обусловлены спецификой конкретного гипертекстового формата.
1.2 Выбор формата хранения компьютерной документации
В настоящее время для создания компьютерных документов применяются около десятка различных форматов, включая 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). Однако далеко не все из существующих форматов пригодны для создания справочников. Причины разные: одни форматы не обеспечивают приемлемую компактность итогового документа, другие не обладают достаточной функциональностью и выразительностью, третьи требуют установки на компьютеры пользователей дополнительного (причем дорогостоящего) программного обеспечения.
Одним из самых распространенных форматов документации является формат CHM. Множество компьютерных приложений имеют справочную документацию в этом формате.
Преимущества формата CHM:
Не требует специальных программ для просмотра. Это стандартный формат операционных систем семейства Windows. Файлы данного формата могут содержать в себе разнообразные элементы: элементы навигации, текст, FLASH (Adobe Flash), видео, музыку и другие элементы.
Наличие навигационного меню, расположенного наряду с окном просмотра, по которому можно с легкостью перемещаться по разделам.
Размер файла. Обычный текстовый формат, DJVU или PDF занимает большее место в сравнении с тем же содержимым, но в формате CHMфайла.
Доступность всех возможностей форматирования, которые есть в HTML и CSS.
Возможность полнотекстового поиска.
Возможность просмотра множества CHMфайлов в виде единого файла с общим содержанием и предметным указателем (в частности, ранняя версия MSDN Library предоставлялись в формате HTMLHelp).
Легкая интегрируемость с программным кодом создаваемого приложения.
1.3 Существующие решения
Часто возникает задача модификации документации. На текущий момент времени существуют приложения, позволяющие автоматизировать сборку и модификацию документации в формате CHM. Проведем анализ таких приложений. Для этого выделим ключевые параметры:
Импорт документации форматов CHM и HTML.
Корректность построения оглавления при импорте HTMLдокументации.
Фильтрация и изменение содержания документации.
Возможность добавления и изменения навигационной панели.
Стоимость.
Обновления и техническая поддержка.
Импорт индексов из CHMфайлов.
Скорость конвертирования документации.
Размер дистрибутива приложения.
Приложения протестированы на системе со следующими характеристиками:
AMD Phenom™ X4 Quad-Core Processor GP-9500 2.20 GHz, 4 GB.
На основе вышеперечисленных параметров проведено сравнение следующих компьютерных программ:
DocToHelp (http://www.doctohelp.com);
ActoStudio (http://www.softarex.com);
Dr. Explain (http://www.softarex.com).
Результаты представлены в таблице 1.
Таблица
Характеристика
|
DocToHelp
|
ActoStudio
|
Dr. Explain
|
Импорт документов форматов CHM и HTML
|
не поддерживает импорт документов формата CHM
|
импорт документации форматов CHM и HTML возможен
|
нет
|
Корректность построения оглавления при импорте HTML документации
|
оглавление строится не корректно
|
оглавления не строится
|
нет
|
Продолжение таблицы 1
Фильтрация и изменение содержания документации
|
фильтрация содержания отсутствует
|
Нет
|
нет
|
Возможность добавлять или изменять навигационную панель
|
Нет
|
Нет
|
есть возможность добавления навигационной панели
|
Стоимость
|
1300 долларов
|
393.34 евро
|
минимальная стоимость 165 долларов
|
Обновления и техническая поддержка
|
Да
|
Да
|
да
|
Импорт индексов при импорте CHM файлов
|
нет, так как отсутствует импорт CHM файлов
|
нет
|
нет
|
Скорость конвертации объемной документации формата CHM
|
25 минут
|
2-3 минуты
|
не тестировалось, так как нет возможности импорта CHM файлов
|
Размер дистрибутива приложения
|
81,5 МБ
|
43,2 МБ
|
28,7 МБ
|
Рассмотренные программы являются мощными решениями для работы с документацией, реализуют большой набор функций для создания и конвертирования компьютерной документацией, однако интересующие нас функции они не реализуют либо реализуют, но не полностью.
Из приведенного анализа следует вывод о необходимости разработки собственного программного решения, отвечающего нашим требованиям. Это решение должно выполнять следующие задачи:
Импорт компьютерной документации форматов HTML и CHM с возможностью получения оглавления и индексного файла из исходной документации.
Модификация содержания и оглавления компьютерной документации.
Фильтрация файлов оглавления компьютерной документации.
Автоматизация процесса конвертирования и модификации компьютерной документации.
Генерация файлов проекта, индексного файла и файла оглавления форматов HHP, HHK и HHC соответственно для компиляции HTML страниц в единый CHMфайл.
В магистерской диссертации была разработана библиотека SomeToCHM для модификации и конвертирования документов форматов HTML и CHM в формат CHM. В сети Интернет опубликована web-страница с описанием реализованной библиотеки (http://code.google.com/p/html2chm).
|
