Автоматизация сборки и модификации разнородной компьютерной документации: модуль формирования документов для последующей конвертации в формат CHM Исполнитель: Утяшева О.А. Научный руководитель: к.фм.н. Винокур В.В.

Задача Цель: разработка приложения, позволяющего модифицировать документацию с последующей конвертацией в CHM-формат. Модуль реализует работу с форматами файлов HTML и CHM как наиболее популярными форматами документации. Основные задачи: 1.Настройка оформления документации. 2.Изменение содержания документации. 3.Импорт индексного файла. 4.Импорт файла содержимого. 5.Конвертирование документации в формат CHM.

Конкуренты DocToHelp, ActoStudio, Dr. Explain и другие. Но у них есть ряд недостатков. В основном приложения конкурентов нацелены на создание документации, но не на модификацию существующей. Разработанное решение устраняет эти недостатки.

Конкуренты Основные недостаки: Отсутсвует гибкая настройка оформления документации. Отсутствует импорт индексного файла. Не корректный импорт CHM и HTML файлов. Ограниченные возможности фильтрации и изменения содержания документации. И другие.

Решение Разработан модуль: модуль формирования документов для последующей конвертации в формат CHM. Решаемые задачи: Импорт компьютерной документации форматов HTML и CHM с возможностью корректного получения оглавления и индексного файла из исходной документации. Модификация компьютерной документации: настройка оформления, изменение содержания, фильтрация и модификация оглавления. Конвертирование компьютерной документации в формат CHM. Автоматизация процесса конвертирования и модификация компьютерной документации.

Импорт документации форматов CHM и HTML Подзадачи: 1.Распаковка файлов формата CHM. 2.Импорт индексов CHM-файлов. 3.Импорт файлов оглавления.

Модификация документации Подзадачи: 1.Настройка оформления (в том числе навигационной панели страниц). 2.Удаление, замена элементов содержания страниц докуменатции. 3.Удаление заголовков оглавления документации. 4.Модификация заголовков оглавления.

Конвертирование компьютерной документации в формат CHM Подзадачи: 1.Построение файла проекта (HHP). 2.Построение индексного файла (HHK). 3.Построение файла оглавления (HHC).

Автоматизация процесса конвертирования и модификация компьютерной документации Процедуру сборки документации необходимо проводить неоднократно, значит этот процесс этот необходимо автоматизировать. Для этой цели используется файл проектов.

Проектирование. Модульная структура

Модуль конфигурации Загрузка и сохранение проектного файла. Валидация проектного файла. Предоставление интерфейса для конфигурирования проектного файла.

Модуль генерации CHM-файла

Модуль модификации содержания документации В разработанной системе реализованы два вида модификаторов: Модификаторы оглавления документации. Модификаторы содержания документации.

Модуль модификации содержания документации. Задачи Основные функции модуля: Замена одних строк на другие. Замена HTML-узлов на указанный текст. Удаление строк. Применение шаблона форматирования к страницам документации.

Модуль модификации оглавления документации. Задачи Фильтрация оглавления документации. Модификация заголовков оглавления.

Заключение В результате данной работы разработан модуль модификации документации форматов HTML и CHM с возможностью конвертирования в CHM формат. Возможности модуля: Конвертирование CHM и HTML файлов. Импорт файлов форматов CHM, HTML. Форматирование документации с помощью HTML-шаблонов. Изменение содержания документации: замена и удаление строк по регулярным выражениями, выражениям на языке XPATH. Изменение оглавления документации: удаление заголовков, изменение названий заголовков оглавления (удаление нумерации, замена и удаление строк). Импорт индексных файлов. Импорт файлов оглавления. Конфигурирование конвертирования и модификации документации.