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

Условные теги

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

Определение условных тегов

У каждого условного тега есть имя — это просто текстовая единица. Вы можете создать столько условных тегов, сколько необходимо, перейдя в Настройки → Cоздание документации из единого источника Условные теги. Имена условных тегов используются для настройки динамических элементов в различных местах. Указывая условные теги для этих элементов, вы управляете тем, как данные элементы будут вести себя, когда указанный условный тег будет выбран во время публикации.

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

Какие элементы используют условные теги

Ниже приведен список элементов, которыми вы можете управлять с помощью условных тегов:

  • Условный контент
    При вставке блоков включения или исключения можно указать условные теги, которые активируют эти блоки при создании публикации.
  • CSS-файлы и скрипт-файлы проекта.
    В настройках проекта можно просмотреть список CSS и скрипт-файлов. Нет необходимости включать каждый файл в каждый тип условной публикации — печатные документы обычно имеют другой дизайн по сравнению с онлайн-документами. Этим можно управлять, изменив режим публикации для каждого из этих файлов.
  • Элементы Дерева страниц.
    Набор элементов Дерева страниц также является условным — в меню свойств страницы можно указать режим публикации. Это может быть полезно, когда вы создаете несколько онлайн-документов для одного и того же проекта: Руководства администратора и оператора; руководства на английском и испанском языках и т.д. Изменение значений элементов Дерева страниц, заданных в итоговой публикации, помогает сохранить контент в одном проекте, а не разбивать его на несколько проектов.

Установка условного тега при публикации

Когда вы завершите создание контента и запустите мастер публикации, вы сможете указать условный тег, который будет использоваться для данного процесса публикации:

Указание условных тегов в Мастере публикаций

В зависимости от выбранного условного тега система Документерра определит все условные элементы во время публикации.