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

Смарт-ссылки

Смарт-ссылки позволяют вам не тратить слишком много времени на точечное управление ссылками и предоставляют разработчикам рабочую ссылку еще до публикации. Они всегда приводят к последней опубликованной версии страницы, доступной данному пользователю.

Например:

У вас есть проект A с двумя публикациями: Публикация X (общедоступная, обновлена 23 марта 2021 г.) и публикация Y (с ограниченным доступом, обновлена 4 апреля 2022 г.). 

Читатель A — анонимный неавторизованный читатель. Читатели такого типа переходят по смарт-ссылке на одну из страниц проекта A. У них нет доступа к публикации Y, самой последней публикации. Таким образом, система отображает им раздел из публикации X, которая является последней опубликованной версией страницы, доступной читателю A.

Читатель B — авторизованный читатель, имеющий доступ ко всем публикациям с ограниченным доступом. Читатели данного типа переходят по той же смарт-ссылке. У них есть доступ к Публикации Y, поэтому система отображает страницу из этой публикации — это последняя опубликованная версия страницы, доступная читателю B.

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

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

  • В вашем проекте нет публикаций, но вам нужна ссылка на страницу, которую вы можете предоставить разработчикам. В этом случае вы можете предоставить им смарт-ссылку. Затем, после публикации проекта, команде разработчиков не нужно будет обновлять приложение — смарт-ссылка укажет на вашу только что созданную публикацию. 
  • В вашем проекте есть несколько публикаций, но ссылка всегда должна указывать на самую последнюю. Вам не нужно обновлять ссылки на своем веб-сайте или в приложении — смарт-ссылка всегда указывает на ту публикацию, которую вы обновили последней. 

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

  • Когда вы добавляете ссылку на страницу из другого проекта в контент страницы.
  • В пунктах меню читателя, когда вы ссылаетесь на страницу в проекте. 
  • В контекстной справке.   Созданные HTML-сниппеты используют смарт-ссылки для ссылок на страницы справки. Поскольку это часто делается до публикации проекта, смарт-ссылки являются логичным выбором для таких сценариев. По умолчанию такие сниппеты будут ссылаться на последнюю опубликованную версию страницы справки. Однако предположим, что вам это не нужно и вместо этого вам необходимо сослаться на страницу из конкретной публикации. В этом случае вам следует изменить URL-адрес страницы во HTML-сниппете, созданном Документеррой, прежде чем вставлять сниппет на страницы вашего приложения/сайта. 

Смарт-ссылку легко идентифицировать по содержащейся в ней части /smart/: https://%portal-name%.documenterra.co/smart/project-id/topic-id.