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

Условный контент

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

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

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

Вы можете легко управлять блоками условного контента с помощью режима «Дизайн». Specifically, the Single-Sourcing section of the Insert tab in the ribbon.

Elements in the Single-Sourcing section

Three options here are related to the conditional blocks:

  1. Insert Conditional Block — Inserts a conditional block with either the default content or with the selected content.
  2. Сделать включением/Сделать исключением — делает условным текущий активный элемент или общий родительский элемент.
  3. Очистить условия — отменяет условия для активного в данный момент элемента или для общего родительского элемента.

Both Insert Conditional Block and Make Conditional options can be either Including or Excluding.

  • The content with the Including type condition applied will be included in publication only if the project is published with the specified output tag(s).
  • The content with the Excluding type condition applied will not be included in publication if the project is published with the specified output tag(s). 

Insert Conditional Block

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

Вставка условного блока по умолчанию в текст

Если вы выделили элемент и нажали одну из этих двух опций, контент выделенного элемента заменит контент по умолчанию в условном блоке.

Make Conditional

Данная команда нужна не для вставки нового контента, а для того, чтобы сделать существующий контент условным.

Если выделения нет, условие будет применено к текущему активному элементу. Текущий активный элемент отображается в Инспекторе тегов:

Просмотр текущего активного элемента в Инспекторе тегов

При наведении курсора на любую из опций Сделать включением / исключением происходит выделение элемента, который будет преобразован в условный.

Преобразование текущего элемента в условный контент

Если выбрать несколько элементов, условие будет применено к общему родительскому элементу блокового уровня.

Очистить условия

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

Вы также можете отменить условия, нажав кнопку Развернуть в Инспекторе тегов или в контекстном меню:

Опция «Отменить условия» в контекстном меню

Добавление условий через исходный код

Вы также можете добавить условия к любым тегам HTML и Документерры, добавив атрибут в исходном коде. Пример:

HTML
<p ch:include="OnlineDoc,First">A paragraph</p>

Вам нужно будет добавить атрибуты ch:include или ch:exclude. Можно добавить несколько тегов через запятую.

Предпросмотр публикации с условными блоками

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

  1. Переключитесь в режим Предпросмотра в редакторе. 
  2. В верхней панели выберите вкладку Просмотр.
  3. Click in the Output Tags selection box and select the output tags you want to preview with.
  4. Click Apply.

Вы увидите публикацию, сгенерированную для выбранного условного тега с учетом переменных, сниппетов и условных блоков.

Распространенные сценарии

Некоторые из часто задаваемых вопросов и ответов об использовании условных тегов можно найти в следующем разделе Базы знаний:  Использование условного контента в распространенных сценариях.