GOSTGen предлагает решение главного вопроса подготовки печатной документации по данным вики-систем — как устранить информационный разрыв между вашим Сonfluence и переданным заказчику документом? Этот разрыв, то есть расхождение информации в выходном документе и исходными статьями в Confluence, возникает сразу же, как только технический писатель добавляет хоть что-то в текстовом редакторе подготовки документа, что отсутствует в Confluence. И это отнюдь не редактирование информации по существу, а всего лишь совершение простейших действий по форматированию документа:

• стилизация печатной документации согласно ГОСТ-подобному шаблону. Как указать в Confluence применение того или иного стиля именно вашего шаблона ODT-документа для того или иного элемента на странице Confluence? Никак.
• организация ссылок внутри выходного документа на его разделы, пункты, рисунки, таблицы, сноски, приложения и т.д. Как в Confluence обеспечить сквозную нумерацию разделов статьи, нумерацию таблиц, рисунков и приложений, да еще и организовать ссылки по тексту статьи на определенный номер (не текст, а номер) заголовка, на номер таблицы или рисунка? Тоже никак.
• приведение эстетического восприятия документа к приемлемому в части размеров рисунков и ширины колонок таблиц. Да, вы можете попробовать договориться с командой о стандартизации размеров включаемых в Confluence изображений, о требовании явного указания размера каждого вида рисунка. Можете попробовать стандартизировать форматирование таблиц в Confluence, отказавшись от адаптивного стиля таблиц. Но это не работает. Через пару месяцев, особенно в цейтноте согласования документов на закрытии очередной фазы проекта, все об этом забудут. И что делать?

В решении этих проблем вам не поможет даже мощнейший Scroll for Confluence, тем более, что он не поддерживает Open Document Format, а предлагает использовать ныне непопулярный Microsoft Word. Только GOSTGen на сегодняшний день может изящно решить все описанные выше задачи, и сделать ваш Confluence реальным единым источником истины для команды разработки и группы технических писателей, поможет устранить вероятность возникновения ошибок, связанных с ручным копированием и форматированием информации, так как устраняет саму необходимость редактирования выходного документа по существу. А теперь подробнее:

Стилизация

Общий принцип применения стилей в выходном ODT-документе к элементам страницы Confluence основан на формировании матрицы соответствия стилей Confluence-ODT. Однако, это соответствие не устанавливается напрямую, а используется промежуточный стиль, присваиваемый элементам страницы Confluence процессором GOSTGen. Перечень промежуточных стилей GOSTGen строго фиксирован, что дает возможность привести инвариантность оформления страниц Confluence к набору стилей, который диктуют общие правила оформления ГОСТ-подобной документации. Адаптация вывода в ODT-документ под шаблон, используемый заказчиком, осуществляется установкой соответствия стилей данного конкретного шаблона стилям GOSTGen. Таблица соответствия стилей настраивается пользователем системы для каждого семейства ODT-шаблонов. Это позволяет единообразно стилизованный HTML-вывод системы трансформировать в стилистически различные шаблоны ODT.

В итоге, в исходной статье Confluence не нужно дополнительно заботиться о стилизации текста, рисунков, таблиц и прочих элементов страницы. Просто пользуйтесь теми возможностями, которые предоставляет Confluence, а остальное система сделает сама.

Ссылочная целостность документа

Согласно принятым в различных ГОСТ приемам оформления разделов, пунктов, рисунков, таблиц, сносок и приложений в документе должна использоваться либо полностью сквозная нумерация, либо сквозная нумерация в рамках основного текста документа и в рамках приложений. Соответственно и ссылки на все эти элементы документа должны содержать номер референциального объекта, но не его название или заголовок. Например, ссылка на раздел документа может выглядеть так: «в разделе 2.1» или, ссылка на пункт — «в пункте 3.4.2». Но как обеспечить ведение нумерации перечисленных объектов в Confluence, особенно если выходной документ состоит более, чем из одной страницы, или когда даже нумерация разделов документа может быть заранее неизвестна?

GOSTGen предлагает несколько простейших приемов по организации таких ссылок на основе поддерживаемых Confluence механизмов, и несколько простых макросов для организации разметки  и нумерации рисунков, таблиц, сносок, пунктов и приложений. При этом не потребуется следить за последовательностью нумерации объектов, достаточно чтобы они были уникальны в рамках одной страницы Confluence. Дальше GOSTGen разберется сам и со сквозной нумерацией объектов, и подставит в ссылке вместо названия пункта или раздела его реальный номер в документе, и предупредит, что в Confluence какая-то ссылка стала нерабочей.

Эстетика документа

Стилизация документа и обеспечение его ссылочной целостности недостаточны для разрешения проблемы эстетического восприятия печатного документа по сравнению с тем, как эта же информация сверстана в Confluence. Если форматирование текстовой информации в документе строго фиксировано и определяется стилями шаблона, то размеры рисунков на экране Confluence и в документе LibreOffice не будут выглядеть эквивалентно из-за различия между разрешением экрана монитора (96 DPI) и печатной страницы (300 DPI). Скриншот, который приемлемо смотрится на мониторе, при переносе в документ будет выглядеть меньше, чем хотелось бы — в LibreOffice его потребуется увеличить.  Тоже самое, с точностью до наоборот, можно сказать и об отображении текста в браузере и в документе LibreOffice: на мониторе с шрифтом 16px при средней ширине экрана около 1920 пикселей (например, Full HD) в строке уместится 192-240 символов, а на листе A4 со шрифтом 12pt, с учётом стандартных полей, у нас остается приблизительно 80 символов на строку. Это не критично для параграфов, но в таблицах с числом колонок уже более трех, в документе LibreOffice приходится ювелирно выгадывать миллиметры в установке их ширины, дабы сделать таблицу читаемой. Вряд ли возможно предложить хороший автоматический способ решения этих проблем эстетики восприятия. Но есть альтернатива.

GOSTGen предлагает ассиметричное решение — это обратный перенос форматирования из предыдущей версии документа при генерации нового. Техническому писателю достаточно привести в LibreOffice размеры рисунков и ширину колонок таблиц к приемлемым, а затем загрузить отредактированный документ в Confluence. Дальше  система все сделает сама и при генерации нового документа эти внесенные изменения будут учтены. Естественно, система сообщит, если в новой версии исходных страниц Confluence изменилось количество рисунков, таблиц или число колонок в таблицах.