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

Публикация из единого источника и Динамическая условная публикация

При создании онлайн-документации в системе Документерра первым шагом является создание Проекта. После создания проекта вы переходите к следующему шагу - теперь нужно заполнить только что созданный Проект контентом. И, наконец, когда весь контент загружен, вы создаете Публикацию для читателей. Обратите внимание, что Публикация - это один из форматов Проекта. Содержание Публикации может отличаться от содержания Проекта. То есть, имея один проект, вы можете создать несколько различных публикаций.   Данная методика разработки документации называется публикацией из единого источника (Single-Sourcing).

Публикация из единого источника

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

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

На первом скриншоте показано Дерево страниц Проекта. Обратите внимание, что присутствует элемент «Сниппет футера».

Дерево страниц в проекте

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

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

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

Исключение условного блока в режиме «Дизайн»

А вот как будет выглядеть Публикация данного Проекта для пользователей. Условный блок отсутствует, он был исключен при публикации, поскольку использовался условный тег pro.

Публикация без исключения условного блока

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