Один из самых интересных форматов — и тот, которым славится Документерра, — это онлайн-публикация. Это самый многофункциональный формат среди всех других. И в отличие от других форматов, онлайн-публикации размещаются на наших серверах и доступны на вашем портале сразу после завершения публикации.
Вам не нужно думать о доставке ваших публикаций читателям — они увидят документацию на домашней странице вашего портала и смогут получить к ней доступ по прямым ссылкам. Со временем она также станет доступена в поисковых системах, таких как Google, если только вы не запретите это или не ограничите свои публикации, то есть не защитите их паролем.
- Читательский интерфейс
- Создание онлайн-публикации
- Обновление онлайн-публикации
- Ограничение доступа к онлайн-публикациям
Читательский интерфейс
Тот контент, который вы создаёте, в итоговой публикации помещается в интерфейс, сильно отличающийся от авторского. Несмотря на то, что стилизация контента сохраняется, окружающие эленты интерфеса становятся другими. Читательский интерфейс обладает широким функционалом, который позволяет улучшить навигацию по страницам, собрать обратную связь от пользователей, добавить поиск, и т.д.
При использовании различных Шаблонов читательского интерфейса ширина контента обычно меньше, чем при просмотре в Редакторе в авторском интерфейсе. Это означает, что некоторые элементы, например, широкие изображения, таблицы, образцы кода, и т.д. могут иначе отображаться для читателей. Чтобы проверить как контент выглядит для читателя, вы можете воспользоваться функцией предпросмотра.
Создание онлайн-публикации
Публикация готового руководства и создание онлайн-версии проекта - это вопрос нескольких кликов: Создание публикации.
| Вы можете публиковать столько версий своего руководства, сколько захотите — количество онлайн-публикаций, которые может иметь один проект, не ограничено. |
При создании публикации система автоматически генерирует идентификатор публикации на основе имени публикации, вы можете изменить идентификатор во время процесса публикации. Идентификатор публикации используется как часть URL-адреса опубликованных страниц. Помните, что идентификаторы публикаций должны быть уникальными для всего портала — они также не могут совпадать с идентификаторами проектов.
Публикации задуманы быть максимально статичными, чтобы внесение изменений в проект не затрагивало их. Поэтому, при создании публикации, система создаёт папку в файловом хранилище, имя которой содержит идентификатор публикации. Все файлы из папки соответствующего проекта, включая стили и скрипты, копируются туда.
Например, если вы начнете создавать публикацию с именем Руководство пользователя 2.0, система автоматически сгенерирует идентификатор rukovodstvo-polzovatelya-2-0. Затем Документерра создаст папку с тем же именем. Таким образом, раздел "Getting Started" в этой публикации будет иметь следующий URL-адрес: https://yourportalname.documenterra.net/articles/#!rukovodstvo-polzovatelya-2-0/getting-started |
Публикации в Документерре могут быть:
- Открытыми - доступными всем, даже анонимным пользователям
- Закрытыми - доступными только выбранным авторизованным читателям и авторам после авторизации
- Приватными - доступными только выбранным авторам после авторизации
Обновление онлайн-публикации
После создания публикации вы можете обновить ее в любое время, чтобы она соответствовала вашему проекту. Вы можете полностью заменить существующую публикацию содержимым вашего проекта в несколько кликов. Или вы можете обновить только её часть — отдельную страницу или набор страниц — используя нашу функцию частичного обновления. Частичное обновление позволяет перенести изменения, внесенные в проект, в публикацию, затрагивая только выбранные страницы, оставляя другие нетронутыми. Это позволяет ускорить доставку готовых документов — вы можете публиковать отдельные страницы как только они будут готовы, не дожидаясь завершения всего проекта.
Чтобы начать работу с частичным обновлением, ознакомьтесь с этими ресурсами:
- Режим частичного обновления публикации
- Частичное обновление — алгоритм обновления элементов дерева страниц
Также можно редактировать страницы в публикации напрямую. И хотя это может быть полезно для быстрого исправления, если вы не внесете те же изменения в проект, система может перезаписать их при следующем обновлении публикации.
Ограничение доступа к онлайн-публикациям
Вы можете настроить закрытый доступ, если хотите, чтобы ваши онлайн-руководства были доступны только для зарегистрированных пользователей. Только авторизованные читатели — пользователи с учетной записью на вашем портале Документерры, которым вы предоставили доступ к определенной публикации, смогут открыть эту публикацию. Подробнее о создании ограниченных руководств читайте здесь: Руководства пользователя с закрытым доступом.
Для читателей нет необходимости запоминать отдельный набор учетных данных, уникальных для портала Документерры, поскольку вы можете настроить аутентификацию с помощью одного из поставщиков SSO или аутентификации на основе токенов.
Кроме того, вы можете сделать публикацию приватной, чтобы доступ к ней имели только авторы и рецензенты, что может быть полезно, например, для внутренней проверки.
Но создание приватных и закрытых публикаций - не единственный способ защитить вашу документацию в Документерре. Есть и другие методы.