Цель работы — создание web-ориентированной системы для редактирования DocBook документов, которая в настоящее время справляется с существующими недостатками в DocBook редакторах. Система состоит из трех основных функций: совместное редактирование, преобразование кода DocBook XML в PDF файл и предварительный просмотр ожидаемого PDF документа в реальном времени. Выполнено планирование и определение требований к системе на основе анализа существующих DocBook редакторов. Выполнено проектирование системы, в результате которого было создано визуальное UI/UX представление системы, после чего система была реализована и проведено тестирование и исправление выявленных ошибок. Результатом работы стал полнофункциональный web-ориентированный DocBook редактор с открытым исходным кодом и поддержкой совместного редактирования под названием «DarkDuck», который преодолевает ограничения существующих DocBook редакторов и добавляет набор новых полезных недостающих функций. DarkDuck был разработан, чтобы помочь множеству людей с разными интересами создавать документы DocBook совместно и легко, без необходимости иметь дело с другими редакторами.

This paper aims to create a web-based system for DocBook documents editing to overcome the drawbacks of the existing nowadays Doc-Book editors. The system has three main features: collaborative editing, transform DocBook XML code into a PDF file, and a real-time preview of the expected final PDF document. Agile software development methodology was used to create this system, starting with planning and system requirement elicitation based on analyzing already existing DocBook editors, followed by system design in which a UI/UX system representation was created, reaching the start of the implementation phase, and finally ending with system testing and maintenance. The outcome of this paper is a fully functional open-source online DocBook collaborative editor called “DarkDuck”, which overcomes the limitations of the already existing DocBook editors and adds many new useful missing features. DarkDuck was designed to help a variety of people with different interests to write DocBook documents collaboratively and efficiently with-out dealing with details happening under the hood.

• Перечень условных обозначений, терминов и сокращений
• ВВЕДЕНИЕ
• 1. ОБЗОР И АНАЛИЗ СУЩЕСТВУЮЩИХ DOCBOOK СРЕДСТВ
  • 1.1. Критерии сравнения DocBook редакторов
  • 1.2. Обзор существующих DocBook преобразователей
  • 1.3. Подведение итогов обзора
  • 1.4. Выводы по разделу
• 2. ПОСТАНОВКА ЗАДАЧИ И ВЫБОР ПУТИ ЕЕ РЕШЕНИЯ
  • 2.1. Постановка задачи
  • 2.2. Анализ задачи и выбор пути ее решения
  • 2.3. Выводы по разделу
• 3. ТЕХНОЛОГИЯ РАЗРАБОТКИ WEB-ВЕРСИИ DOCBOOK РЕДАКТОРА
  • 3.1. Технология разработки DocBook web-редактора
    • 3.1.1. Компоненты системы
    • 3.1.2. Взаимосвязи компонентов
  • 3.2. Структура страниц DocBook web-редактора
    • 3.2.1. Целевая страница (landing page)
    • 3.2.2. Страница проектов
    • 3.2.3. Страница DocBook редактора
    • 3.2.4. Страница профиля
  • 3.3. Выводы по разделу
• 4. РЕАЛИЗАЦИЯ WEB-ВЕРСИИ DOCBOOK РЕДАКТОРА
  • 4.1. Методология разработки системы
  • 4.2. Дизайн пользовательского интерфейса
  • 4.3. Frontend часть (клиентская часть)
    • 4.3.1. XML интерфейс
    • 4.3.2. Интерфейс предварительного просмотра
    • 4.3.3. Загрузка XML и HTML файлов
  • 4.4. Backend часть (серверная часть)
    • 4.4.1. Firebase authentication (Аутентификация)
    • 4.4.2. Firebase Realtime база данных
    • 4.4.3. Firebase Hosting (Хостинг)
    • 4.4.4. Google Cloud Storage (Облачное Хранилище)
    • 4.4.5. Google Cloud Functions (Облачные Функции)
  • 4.5. Выводы по разделу
• 5. ТЕСТИРОВАНИЕ И АНАЛИЗ РЕЗУЛЬТАТОВ
  • 5.1. Функции, подлежащие тестированию
  • 5.2. Методика тестирования
  • 5.3. Проведение тестов и анализ результатов.
  • 5.4. Выводы по разделу:
• ЗАКЛЮЧЕНИЕ
• Список использованных источников
• Таблица сравнения между существующими DocBook средствами
• Структура базы данных «Firebase Realtime Database»
• Листинг «Firebase Realtime Database Security Rules»
• Листинг «Firebase Cloud Storage Security Rules»
• Листинг функции преобразования XML в HTML «xmlToHtml»
• Листинг функции преобразования XML в PDF «xmlToPdf»
• Листинг функции приглашения нового пользователя «inviteUser»
• Трансформация разных по размеру XML документов в HTML
• Процесс трансформации DocBook XML в PDF файл
• Демонстрация функции совместного редактирования
• Разные интерфейсы страницы редактора на устройствах с разными экранами