Автоматизация сборки и модификации разнородной компьютерной документации: модуль формирования документов для последующей конвертации в формат CHM Исполнитель: Утяшева О.А. Научный руководитель: к.фм.н. Винокур В.В.
Задача Цель: разработка приложения, позволяющего модифицировать документацию с последующей конвертацией в CHM-формат. Модуль реализует работу с форматами файлов HTML и CHM как наиболее популярными форматами документации. Основные задачи: 1.Настройка оформления документации. 2.Изменение содержания документации. 3.Импорт индексного файла. 4.Импорт файла оглавления. 5.Конвертирование документации в формат CHM.
Существующие решения DocToHelp, ActoStudio, Dr. Explain и другие. В основном приложения конкурентов нацелены на создание документации, но не на модификацию существующей.
Существующие решения Основные недостаки: Некорректный импорт CHM и HTML файлов. Ограниченные возможности фильтрации и изменения содержания документации. И другие.
Решаемые задачи Импорт компьютерной документации форматов HTML и CHM с возможностью корректного получения оглавления и индексного файла из исходной документации. Модификация компьютерной документации: настройка оформления, изменение содержания, фильтрация и модификация оглавления. Конвертирование компьютерной документации в формат CHM.
Импорт документации форматов CHM и HTML Подзадачи: 1.Распаковка файлов формата CHM. 2.Импорт индексов CHM-файлов. 3.Импорт файлов оглавления.
Модификация документации Подзадачи: 1.Настройка оформления (в том числе навигационной панели страниц). 2.Удаление элементов содержания страниц докуменатции. 3.Удаление заголовков оглавления документации. 4.Модификация заголовков оглавления.
Сохранение в формат CHM Подзадачи: 1.Построение файла проекта (HHP). 2.Построение индексного файла (HHK). 3.Построение файла оглавления (HHC).
Автоматизация процесса конвертирования и модификация компьютерной документации Процедуру сборки документации необходимо проводить неоднократно, значит этот процесс необходимо автоматизировать.
Cтруктура библиотеки
Заключение В результате данной работы разработан модуль модификации документации форматов HTML и CHM с возможностью конвертирования в CHM формат. Возможности библиотеки: Конвертирование CHM и HTML файлов в CHM формат. Импорт файлов форматов CHM, HTML. Форматирование документации с помощью HTML-шаблонов. Изменение содержания документации: замена и удаление строк по регулярным выражениями, выражениям на языке XPATH. Изменение оглавления документации: удаление заголовков, изменение названий заголовков оглавления (удаление нумерации, замена и удаление строк). Импорт индексных файлов. Импорт файлов оглавления. Конфигурирование конвертирования и модификации документации.