Исполнитель: Утяшева О.А. Научный руководитель: к.фм.н. Винокур В.В.
Цель: разработка библиотеки, позволяющей модифицировать документацию с последующей конвертацией в CHM-формат. Основные задачи: 1. Настройка оформления документации. 2. Настройка содержания документации. 3. Настройка оглавления документации. 4. Импорт индексного файла. 5. Импорт файла оглавления. 6. Конвертирование документации в формат CHM.
Основной целевой аудиторией являются авторы документации, которым необходимо выпустить облегчённую или, например, с изменённым оформлением версию своей документации.
DocToHelp, ActoStudio, Dr. Explain, Help&Manual и др. Все они являются полезными и сложными системами, которые поддерживают большинство задач по работе с компьютерной документацией. Но они имеют множество нецелевой для нас функциональности и не решают многих из поставленных задач.
Импорт. Распаковка файлов формата CHM. Импорт индексов CHM-файла. Импорт файла оглавления. Модификация. Настройка оформления (в том числе навигационной панели страниц). Удаление элементов содержания страниц документации. Удаление заголовков оглавления документации. Настройка заголовков оглавления. Сохранение в CHM формат. Построение файла проекта (HHP). Построение индексного файла (HHK). Построение файла оглавления (HHC).
Используемые библиотеки и технологии: Unity; Reactive Extension for.NET (RX); Html Agility Pack (HAP); GoF; IoC; Dependency Injection.
В результате данной работы разработана библиотека для модификации документации форматов HTML и CHM с возможностью конвертирования в CHM формат. Возможности библиотеки: Конвертирование CHM и HTML файлов в CHM формат. Импорт файлов форматов CHM, HTML. Форматирование документации с помощью HTML-шаблонов. Изменение содержания документации: замена и удаление строк по регулярным выражениями, выражениям на языке XPATH. Изменение оглавления документации: удаление заголовков, изменение названий заголовков оглавления (удаление нумерации, замена и удаление строк). Импорт индексных файлов. Импорт файлов оглавления. Конфигурирование конвертирования и модификации документации.