Структурированные документы

Перед вами Руководство пользователя Структурированные документы. До того, как вы начнете изучение данного руководства, рекомендуется пройти Быстрый старт со структурированными документами. Это позволит вам ознакомиться с концепцией и базовыми приемами работы со структурированными документами.

Введение

Структурированный документ – документ, сочетающий в себе гибкость синтаксиса markdown и возможность задания сложной структуры содержания документа. Структурированный документ является комплексным объектом, состоящим из отдельных структурных компонентов (абзац, раздел, нумерованный список и другие), расположенных в заданном порядке. Каждый компонент документа является отдельной сущностью (экземпляром соответствующего класса) и может вступать в отношения с любыми другими объектами системы. Результатом рендеринга такого документа является интерактивный документ, имеющий заданную структуру и визуальное представление, определенное пользователем. Механизм формирования структурированного документа можно представить в виде последовательности:

Структурированный документ строится из отдельных компонентов путем добавления, редактирования их содержимого и изменения их расположения. Компоненты следуют друг за другом, при этом компоненты-контейнеры могут включать в себя другие компоненты.

Создание структурированного документа

Создание нового структурированного документа выполняется в реестре Структурированные документы. Для перехода в реестр:

1. На Панели навигации платформы OSA перейдите в раздел Документы
2. Выберите пункт Структурированные документы

Общие функции работы с реестрами описаны в разделе Работа с реестрами.

Для создания нового структурированного документа:

1. Нажмите на кнопку Создать структурированный документ на Панели инструментов реестра

2. Выберите тип создаваемого документа - Структурированный документ

3. В открывшейся форме (карточке нового структурированного документа):

   1. Заполните поле Наименование
   2. При необходимости, в поле Шаблон документа выберите соответствующий шаблон для создания документа по шаблону. По умолчанию, с установленным значением Без шаблона, будет создан произвольный документ
   3. При необходимости, заполните прочие поля

   Информация

   По вопросам разработки новых шаблонов структурированных документов или модификации существующих, обратитесь к администратору платформы OSA.

Созданный документ будет сохранен автоматически.

Копирование структурированного документа

Функция копирования позволяет создать новый структурированный документ, полностью повторяющий содержимое существующего документа. Автором копии становится пользователь, выполнивший копирование.

Для копирования структурированного документа:

1. В реестре Структурированные документы или в карточке документа нажмите на кнопку Копировать документ (функция доступна пользователям с правом редактирования документа)
2. Подтвердите выполнение операции в диалоге
3. Для перехода к созданной копии нажмите на кнопку Открыть

Копия документа откроется в режиме просмотра.

Далее смотрите раздел Редактирование структурированного документа.