Платформа

Для портала документации мы используем вики-платформу Confluence, что привносит в работу с ним определенные особенности. Подробности о работе непосредственно с платформой вы можете найти в меню «Помощь». Чтобы открыть меню, на панели справа сверху  кликните «».

Пространства

Пространства, это разделы портала.

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

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

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

Может показаться неудобным искать нужное пространство в списке. Мы присвоили ключевым пространствам категории согласно продуктам Polymatica BI, а уже в них разместили ссылки на прочие пространства. Чтобы переключаться между категориями, используйте ссылки на боковой панели страницы, в блоке «Категории». Чтобы вернуться к списку всех пространств, кликните на боковой панели ссылку «Все пространства». Так же просматривать пространства по категориям можно на домашней странице пространства «Стартовый раздел». Для этого на странице есть виджет с переключателем. 

Страницы пространства

Каждое пространство включает в себя домашнюю страницу и вложенные страницы.

Особенность домашней страницы пространства, отличающая её от прочих страниц, в том, что вы всегда сможете попасть на неё, кликнув название или пиктограмму пространства на боковой панели. Поэтому на домашней странице пространства мы размещаем ключевую информацию этого пространства, – например, домашняя страница пространства «Стартовый раздел» содержит информацию о портале документации и виджет для просмотра пространств по категориям.

Любая страница пространства может содержать вложенные страницы. Чтобы увидеть дерево страниц, на боковой панели страницы кликните кнопку «» и выберите «Просмотр страниц». Откроется новая страница, на которой отображается виджет дерева страниц в свернутом до корневой страницы виде.

Вы можете видеть, на какой странице пространства находитесь, в пути над заголовком открытой страницы. Например, над заголовком этой страницы указан путь «Страницы / Начальная страница». Это значит, что эта страница вложена в страницу «Начальная страница». В конце пути всегда отображается страница, в которую вложена открытая страница, а в начале пути всегда отображается страница «Страницы». Если между началом и концом пути есть несколько вложенных друг в друга страниц, то в пути отображается многоточие, например «Страницы / … / Предыдущая страница». Кликните по многоточию в пути, чтобы развернуть его.

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

Поиск

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

Работа со страницей

Содержание

Когда на странице больше одного заголовка, то в правой её части отображается плавающее содержание.

По умолчанию содержание отображается развернутым и перемещается вслед за экраном при прокручивании. В таком виде оно занимает определенный процент пространства страницы и может мешать чтению. Чтобы содержание автоматически скрывалось, наведите на него курсор и кликните всплывающую кнопку «». Кнопка примет вид «», а текст страницы станет отображаться под содержанием. Когда вы уведете курсор с содержания, оно автоматически скроется. Чтобы вернуться к постоянному отображению, кликните «».

Ссылки

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