Автоматически сгенерированные страницы
В системе Документерра некоторые страницы содержат контент, не созданный, а импортированный, например, с расширением .json или .yaml, содержащий файл OpenAPI. Такие автоматически сгенерированные страницы называются авто-страницами.
В настоящее время существует только один формат, который приводит к созданию авто-страниц: OpenAPI. Итак, когда при импорте файла OpenAPI/Swagger в Документерру система создаетнабор авто-страниц, объединенных единым родительским узлом.
| Можно импортировать несколько файлов OpenAPI в один проект — каждый из них будет относиться к разным родительским узлам с набором прикрепленных авто-страниц. |
Авто-страницы, сгенерированные из одного файла, представляют собой группу и имеют особый вид в Дереве страниц, что позволяет выделить их на общем фоне.
Как родительские узлы для авто-страниц, так и сами авто-страницы имеют специальные иконки, чтобы их можно было легко идентифицировать в Дереве страниц проекта. Кроме того, заголовки авто-страниц в Дереве страниц могут содержать соответствующую иконку HTTP-команды справа. Эти иконки можно стилизовать с помощью Branding.css, и они сохраняются при экспорте в WebHelp.
| Иконки HTTP-команд были добавлены в версииBlossom, поэтому для документации, созданной до Blossom, нужно повторно импортировать файл Open API, чтобы они появились. |
Родительский узел для автоматически сгенерированных страниц(или родительский узел для авто-страниц) — это страница корневого уровня, которая является родительской для всех автоматических страниц, созданных из определенного файла. Имя данного файла — в основе имени узла. При создании он содержит плейсхолдер, который можно редактировать. Родительский узел для авто-страниц обладает большинством функций обычных страниц, поэтому его также можно перемещать по Дереву страниц, удалять (при этом также удаляются дочерние страницы), изменять его свойства, изменять поля рабочего процесса и т.д.
Единственным ограничением является то, что нельзя вручную создавать новые дочерние страницы в родительском узле.
| Если при публикации контента вы используете опцию Опубликовать только готовые страницы, не забудьте отметить родительский узел какГотовый. В противном случае дочерние страницы не будут опубликованы. |
Авто-страницы создаются как дочерние страницы родительского узла. Они содержат фактическую информацию из файла. Они отображаются в результатах полнотекстового поиска, и по ним рассчитываются статистика и метрики, но, в отличие от большинства страниц и родительских узлов, они не редактируется.
Кроме того, они имеют определенные ограничения:
- Для них доступен только глобальный поиск. Функция глобального поиска и замены недоступна.
- Их нельзя перевести.
- Их стиль нельзя изменить с помощью редактора, так как они не редактируются, но можно изменить с помощьюCSS-файла проекта.
- Авто-страницы нельзя перемещать, удалять или создавать для них дочерние страницы / подстраницы. Можно перемещать/обновлять/удалять только весь набор авто-страниц, привязанных к одному родительскому узлу.
- Авто-страницы наследуют все свойства родительского узла, кромезаголовка страницы и идентификатора страницы.
- Авто-страницы всегда имеют статус рабочего процесса Готово.
- Поля рабочего процесса Исполнителя и Владельца открываются для пользователя, который импортировал файл, и не могут быть изменены.
- Авто-страницы нельзя копировать из одного проекта в другой.
- Авто-страницы нельзя повторно использовать в качестве сниппетов.
- История версий, настройки печатных публикаций, ключевые слова, настройки шаблона страницы, обзор комментариев,иСписок задач для них недоступны.
- Из загружаемых форматов для авто-страниц доступны толькоWebHelp и HTML. В обоих случаях для отображения авто-страниц архив необходимо развернуть как веб-сайт.
- Авто-страницы не отображаются в печатной публикации.