Фильтр по содержимому

Экспериментальная функция

Включите ее на главной странице в блоке «Экспериментальные функции».

Фильтрация используется, если для одного каталога необходимо создать несколько сборок документации: например, сборки по роли читателя или типу продукта. Фильтровать можно статьи и абзацы текста.

Создать фильтр

Для начала создайте свойство, которое будет использоваться для фильтрации, и выберите его тип: «Флаг», «Один из списка» или «Несколько из списка».

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

Например, для каталога с проектом внедрения можно создать свойство с ролями сотрудников:

  • KAM — «Для аккаунт-менеджеров».

  • Dev — «Для разработчиков».

  • All — «Весь каталог».

После этого укажите это свойство в настройках каталога.

Задать фильтры

На статьях

На всех в статьях в каталоге необходимо указать свойство, в каких сборках эта статья отобразится.

  • Фильтр не наследуется: необходимо указывать как для раздела, так и для всех статей в разделе.

  • Если фильтр не указан — статья не отобразится ни в одной из сборок.

  • Если статья должна попасть во все сборки — необходимо указать все фильтры.

Статья попадет в сборки «Для разработчиков» и «Весь каталог». Но не попадет в сборку «Для аккаунт-менеджеров»

На абзацах

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

  • Если название вкладки отличается от названия фильтра («dev» вместо «Dev»), фильтрация не сработает.

  • Если есть только одна вкладка — она отобразится только в одной сборке.

Статья доступна во всех сборках, но вводная информация о регламенте поддержки доступна только в сборке «Для аккаунт-менеджеров»

Включить фильтр

Вы можете проверить фильтрацию контента прямо в приложении: в правой панели кликните «Фильтр» и выберите название сборки.

  • Фильтр можно включить в приложении и на портале для чтения.

  • Указание на выбранный фильтр добавляется в URL каталога.

Выбран фильтр «Для аккаунт-менеджеров»
Экспорт с учетом фильтра

Экспорт в PDF или DOCX учитывает выбранный фильтр. В файл попадут только отфильтрованные статьи и абзацы.

Известные ограничения

Функции «Фильтрация» и «Публикация в облако Gramax» — экспериментальные. Если вы публикуете каталог в облако Gramax, необходимо на портале в консоли прописать window.localStorage.setItem("enabled-features", "filtered-catalog") — только после этого фильтры станут доступны для переключения.

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