Архитектура
В описании архитектуры системы GOSTGen используется следующая терминология:
| Термин | Определение |
|---|---|
| Выходной документ | ODT-файл LibreOffice Writer, сформированный из композитного документа |
| Композитный документ | Результат вывода в единый последовательный HTML-поток основного текста (тело документа и приложения), использованных терминов и аббревиатур, аннотации и произвольно заданных таблиц, например, истории версий для заполнения листа изменений |
| Основной текст | Результат вывода в единый последовательный HTML-поток всех страниц Confluence, собранных макросами Confluence и GOSTGen для включения контента одной страницы/выборки страницы в другую, начиная от стартовой. Основной текст разбивается на тело документа и приложения к документу, размеченных макросами «ODT Приложение к документу». |
| Сборка документа | Процесс трансформации страниц(ы) Confluence в композитный документ для дальнейшей обработки |
| Сборочная страница | Страница Confluence, созданная по определенным правилам для указания значений переменных управления создания композитного документа, и с которой осуществляется запуск его сборки композитного документа |
| Семейство шаблонов (выходного документа) | Файлы шаблонов выходных документов, содержащих идентичный набор определения стилей LibreOffice Writer, но которые могут различаться содержанием, иметь различный перечень пользовательских полей документа и различную разметку для вывода в выходной документ составляющих композитного документа |
| Стартовая страница | Страница Confluence, с которой осуществляется запуск сборки композитного документа. Стартовая страница не обязательно содержит переменных для управления экспортом, а использует настройки GOSTGen заданные по умолчанию |
| Шаблон (выходного документа) | ODT-файл, содержащий разметку для вывода в выходной документ различных составляющих композитного документа |
Основное назначение системы подготовки документации GOSTGen — это автоматизация формирования документов в формате ODT LibreOffice Writer из содержимого статей Atlassian Confluence Data Center.
Система включает в себя:
- Сервер GOSTGen, осуществляющий генерацию выходного документа;
- Плагин GOSTGen для организации взаимодействия пользователя Confluence с сервисом GOSTGen и включающий набор макросов Confluence для разметки страницы в соответствии с требованиями ГОСТ по оформлению проектной документации;
- методологию оформления статей Confluence для обеспечения автоматизированного формирования выходных документов и правила создания и настройки шаблонов, используемых для формирования выходных документов.
Диаграмма ниже иллюстрирует взаимодействие между администратором Confluence, пользователями Confluence, плагином GOSTGen и сервером GOSTGen в среде Atlassian Confluence Data Center:
Администратор Confluence: Устанавливает и настраивает плагин GOSTGen, включая адрес сервера GOSTGen.
Пользователь Confluence: Использует макросы GOSTGen при создании контента, ведет словари терминов и сокращений, создает сборочные страницы выходных документов, настраивает порядок экспорта документа и запрашивает этот экспорт.
Плагин GOSTGen: Интегрируется с Atlassian Confluence Data Center, предоставляя возможности для работы с документами.
Сервер GOSTGen: Обрабатывает запросы пользователя Confluence на формирование HTML-представления документа, экспорта в формат ODT или сохранение твердой копии документа.
Плагин GOSTGen
Плагин GOST Generator for Confluence разработан в соответствии cо стандартами, изложенными в Atlassian Confluence Data Center Developer Documentation https://developer.atlassian.com/server/confluence/.
Краткое наименование плагина — «GOSTGen».
Полное наименование — «GOST Generator for Confluence».
Иконка плагина:
После установки плагина в Confluence создаются страницы его настройки, пункты меню вызова сервиса и устанавливаются макросы GOSTGen:
Макросы GOSTGen
Макросы GOSTGen устанавливаются в Confluence и становятся доступны для использования. Помимо стандартного способа вставки макросов, используя меню вставки прочего контента 
и выбора пункта «Другие макросы» (Ctrl + Shift+A), возможна быстрая вставка макросов GOSTGen из контекстного меню редактора при наборе следующей комбинации: { odt
Настройки плагина
В разделе «Администрирование Confluence» в разделе «Конфигурация» создается пункт меню «Сервер GOSTGen», где необходимо указать доменный адрес сервера GOSTGen, используемый по умолчанию для всех пользователей Confluence. Начальное значение параметру не задается.
В профиле пользователя в разделе «Настройки» в разделе «Ваши Установки» создается пункт меню «Сервер GOSTGen», где пользователь может переопределить доменный адрес сервера GOSTGen, заданный для всех пользователей по умолчанию в настройках администрирования Confluence:
Вызов сервиса GOSTGen
Если в настройках пользователя или настройках администрирования Confluence указан адрес сервера GOSTGen, то для страниц Confluence активируется возможность вызова сервиса GOSTGen.
В меню страницы Confluence первым пунктом добавляется «Экспорт в ODT», при нажатии на который происходит обращение к сервису для текущей страницы.
На самой странице в режиме просмотра становятся доступны результаты работы некоторых макросов GOSTGen: «Нумератор таблиц», «Список приложений», и, если вы используете расширение для обработки Yogi Requirements Macro — макрос «Таблица соотнесения требований». При нажатии мышью на эти макросы будет выведен результат их работы. Это особенно полезно при проверке настройки фильтров таблиц.