Confluence не работает якорь

Метки и теги

Чтобы облегчить поиск и систематизировать материал по определенной теме, рекомендуентся использовать единые метки (теги) в JIRA и Confluence.

Confluence метки

Добавление метки (labels) в Confluence

Метки в Confluence можно добавить к любой статье даже не открывая редактор:

Добавление меток происходит через пробел. Введите метки и нажмите кнопку Добавить:

Если статья открыта для редактирования, то для добавления меток необходимо нажать на иконку над названием статьи:

Макрос для вывода связанных по одной метке статей в Confluence

Чтобы вывести статьи с определенной меткой, добавьте макрос Содержимое по меткам.

В настройках макроса укажите метки, по которым выводить статьи:

Метки в JIRA

Добавление метки в задаче

Добавить метки в JIRA можно так же двумя способами:

• про создании задачи в поле Метки

Вывод задач по Метке из JIRA в Confluence странице

Чтобы вывести задачи JIRA с определенной меткой, необходимо добавить макрос Jira:

В настройках макроса нужно ввести labels= и в кавычках указать метку для вывода.

Источник

Вставить/Редактировать якорь

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

Например, если текст страницы очень объемный и состоит из нескольких подразделов, заголовок каждого из подразделов можно оформить в виде «якоря», задав каждому из «якорей» уникальные названия. Скажем, на странице «http://example/about» три раздела, каждый из них выделен в виде «якоря» с названиями «razdel-1», «razdel-2» и «rasdel-3», соответственно, чтобы пройти к любому из разделов, достаточно к адресу страницы дописать имя «якоря» через решетку — «http://example/about#razdel-3» — страница откроется именно в области третьего заголовка. При необходимости Вы можете сделать в начале документа оглавление, оформив ссылки на «якоря» в виде пунктов списка.

Рассмотрим, как можно вставить якорь в текст.

Шаг 1

Поместите курсор в то место, где Вы хотите разместить «якорь» или выделите текст, который хотите использовать в качестве «якоря» и нажмите на кнопку вставки якоря.

Шаг 2

Откроется окно вставки «якоря». Укажите название (оно будет использоваться в ссылке на «якорь») и нажмите «Вставить «.

Обратите внимание!

• Имя якоря может содержать только латинские буквы и цифры, при этом, имя якоря должно начинаться с буквы

Шаг 3

Чтобы вставить в текст ссылку на якорь, например, в оглавлении — воспользуйтесь обычной вставкой ссылки.

На вкладке «Информация о ссылке»:

• Выберите «Тип ссылки» — «Ссылка на якорь в тексте».
• Появится дополнительный параметр «Выберите якорь», где Вы сможете в списке «По имени» выбрать ранее созданный Вами якорь.

Источник

Как создать перекрестную ссылку с одной страницы Confluence на другую с помощью REST?

Я пытаюсь опубликовать кучу автоматически созданных страниц для Confluence, используя REST. Страницы содержат перекрестные ссылки друг на друга, которые являются простыми тегами, для которых я в настоящее время увлекаюсь URL-адресом на основе целевого имени (» http://confluence.url/display/[space]/[name ] «или что-то с идентификатором).

В этом есть несколько недостатков:

Я предполагаю URL-адрес, который включает в себя логику кода, где я не хочу этого URL-адрес, который я угадываю, может измениться при активации аддона, такого как Scroll Viewport Возможно, система не может различать гиперссылку (страница-внешняя) и перекрестная ссылка (страница-страница), например. для обнаружения неопределенных или осиротевших страниц.

Я ищу способ создания правильной перекрестной ссылки с одной страницы на другую при создании/обновлении этих страниц через REST. Я пробовал:

Регулярная гиперссылка HTML на URL-адрес страницы, который я предполагаю, не желаемый по причинам, описанным выше. Используя синтаксис ««, это просто отображает квадратные скобки на странице и не создает ссылку Поиск макроса для использования, но, похоже, для этого нет макроса. Макрос Якоря не то, что я ищу, поскольку это будет работать только для целей ссылки на одной странице.

Я думаю, что смогу разрешить все необходимые идентификаторы страницы. Кроме того, макросы, похоже, поддерживаются REST, поэтому макрос для перекрестных ссылок кажется идеальным.

Источник

Как мы используем Confluence для разработки требований к продукту

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

Все изменения в требованиях к новой фиче на одной странице

Мы разрабатываем сложные Enterprise-продукты, которые тиражируются для сотен корпоративных заказчиков. В одном из наших продуктов больше ста функциональных модулей и у каждого модуля есть отдельный документ с требованиями. Фичи нового релиза, как правило, затрагивают несколько (от 3 до 20) функциональных модулей.

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

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

Примерно так это выглядит в жизни:

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

Технически это реализовано с помощью плагина Multi Excerpt, который позволяет вставлять части одного документа в разные документы.

В документе с требованиями к функциональному модулю:
Текст изменившейся части требований обрамляется макросом MultiExcerpt. Если изменение небольшое (например, поменялась какая-то одна цифра или небольшое предложение), мы добавляем в макрос немного текста вокруг этого изменения, чтобы читатель понимал контекст.

На странице документа с новой функциональностью:
Добавляем макрос Multiexcerpt include. В нём указываем, какой блок из какой страницы нужно вставлять:

Готовая страница фичи в режиме редактирования выглядит примерно так:

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

Делается это с помощью стандартных макросов «Отчёт о свойствах страницы» и «Свойства страницы».

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

А на страницу фичи добавляется макрос «Отчет по свойствам страницы», в нем указывается метка фичи, а также список свойств, которые необходимо отображать.

«Трассировка» требований

Изменения в требованиях к одному функциональному модулю могут потребовать изменений и в других модулях. Если забыть про связанные изменения на этапе проработки требований, скорее всего, это станет известно на более позднем этапе (например, во время тестирования) и повлияет на сроки сдачи релиза. К сожалению, у нас бывали такие прецеденты.

Чтобы отследить влияние функциональных модулей друг на друга и не забывать о связанных изменениях в требованиях, мы используем функциональные возможности меток (тэгирование). Получается своего рода трассировка требований, но с крупным шагом: на уровне функциональных модулей, а не атомарных требований.

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

Для этого мы используем стандартную функциональность меток в Confluence и макрос «Результаты поиска».

На примере функционального модуля «Карточка Персоны»:

• Находим все функциональные модули, на которые может повлиять изменения требований к карточке Персоны
• Добавляем в них соответствующий тег (в нашем случае это #person)
• Добавляем макрос «Результаты поиска» на странице требований к карточке Персоны

В режиме редактирования это выглядит так:

А читатель видит так:

Версионирование требований по релизам

Confluence в паре с плагином Scroll Versions позволяет для каждого нового релиза делать отдельную ветку требований, при этом у всех документов в каждом релизе остается собственная история изменений. Переключение между версиями релизов выполняется в пару кликов. Кроме того, можно сравнивать между собой требования как разных релизов, так и разных версий одного документа внутри одного релиза.

Так выглядит в жизни переключение между версиями релизов:

Комментирование

Для работы с комментариями мы используем плагин Talk.

• Можно видеть комментарии и отвечать на них в режиме редактирования документа. Это очень удобно, когда надо вносить правки в требования по результатам ревью
• Нет проблем с параллельным комментированием (особенно если вы планируете переход с MS Word + Sharepoint: не нужно блокировать документ целиком), требования может рецензировать одновременно вся проектная команда
• Если комментарий оставляют на странице с фичей в блоке с Multi Excerpt, он автоматически появляется в исходном документе требований

Кроме этого, у него есть приятные функции, такие как выделение комментариев разными цветами, управление видимостью для разных пользователей и лайки.

От стандартного функционала комментирования в Confluence мы отказались, потому что у него были критичные для нас минусы:

• Нельзя использовать в связке с плагином Multi Excerpt
• Не видно комментариев в режиме редактирования документа (UPD: в новых версиях Confluence этот недостаток устранили)
• Пропадают комментарии, если изменить текст, к которому они были привязаны

Создание диаграмм и мокапов

Сначала мы использовали MS Visio и экспортировали схемы в растровый формат, а затем загружали в Confluence. Такой подход был неудобен — актуальность схем приходится поддерживать в двух местах, для этого нужно слишком много действий.

Как оказалось, в Confluence есть множество плагинов для работы с разного рода графическими объектами (диаграммы, схемы, мокапы и пр). Balsamiq Wireframes for Confluence и Draw.io Diagrams for Confluence позволяют редактировать графические объекты, не выходя из Confluence. На данный момент эти плагины почти полностью покрывают наши потребности.

Базовые возможности

Кратко расскажу о базовых возможностях, которые предоставляет Confluence (как и большинство других вики-систем). Чтобы не пересказывать документацию, ограничусь списком того, чем мы в основном пользуемся:

• Сравнение версий документов. Можно быстро понять, как менялась функциональность от релиза к релизу.
• Параллельное редактирование одного документа и автоматическое разрешение конфликтов. Ревью документа могут делать одновременно несколько человек и при этом не нужно ждать своей очереди, пока документ заблокирован на редактирование другим сотрудником (как было, когда мы использовали Sharepoint и требования хранились в виде Word-файлов).
• Шаблоны документов. Мы создали шаблоны по всем основным типам документов (функциональный модуль, фича, протокол совещания)
• Гибкие возможности разграничения доступа (вплоть до уровня страницы). Это удобно, например, для аутсорсных сотрудников, которым нельзя предоставлять доступ сразу ко всем требованиям
• Экспорт документов в различные форматы. Очень выручает в тех редких случаях, когда возникает необходимость передачи документов наружу.
• Интеграция с JIRA. Можно автоматически вставлять статус задач, сроки согласований и прочей информации из тикетов JIRA.

Переход с MS Word

Есть несколько неочевидных вещей, с которыми почти сразу сталкиваешься после перехода с Word на Confluence.

Нумерация заголовков

Чтобы добавить автоматическую нумерацию заголовков, нужно обрамить текст макросом Numbering headings.

Гиперссылка на раздел

Чтобы внутри документа сослаться на какую-нибудь часть документа или заголовок раздела, нужно сначала добавить макроc Anchor (в русской локализации он называется «Анкер»), а затем добавить гиперссылку на него из нужной части документа.

Добавляем макрос Anchor и указываем его имя (Вставить -> Другие макросы -> «Anchor»):

Так он выглядит в документе в режиме редактирования:

Затем вставляем ссылку на этот якорь в документе (Вставить -> Ссылка -> Дополнительно):

• Для создания ссылки на другой документ перед названием якоря указываем название документа, на который нужно сослаться, затем символ «#» и после него название якоря.
• Для создания ссылки на текущий документ перед названием якоря просто указываем символ «#».

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

Цвет фона текста

Сделать нестандартное визуальное оформление текста, в частности выделить фон текста
заливкой, можно с помощью Markdown-разметки (Вставить -> Разметка, Markdown).

Для заливки мы используем такой код:

Подставьте RGB-код нужного вам цвета.

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

Это не очень удобно, но другого способа выделять текст заливкой мы пока не нашли.
Из минусов:

• Копирование и вставка из буфера обмена размеченного таким образом текста как правило ведет к потере разметки.
• Изменить разметку можно только в режиме редактирования исходного кода страницы.

На этом всё. Задавайте вопросы в комментариях!

Источник