Как использовать макросы в Confluence, чтобы систематизировать и оформить документацию по продукту и процессам?
Привет, Хабр! Меня зовут Таня Дудо, и я уже 6 лет помогаю людям и командам обмениваться знаниями внутри компаний. Для этого использую Confluence. Да-да, ту самую wiki-систему, которую часто называют неудобной и несовременной. Сегодня выступлю ее адвокатом-обозревателем: расскажу про 7 полезных макросов для систематизации и оформления контента и наглядно покажу, как они работают.
Дисклеймер: с марта Atlassian не продают лицензии в Россию напрямую. Но если у вас уже есть, никто не запрещает ей пользоваться. На сайте Atlassian есть развернутая документация по установке Confluence и Jira. Она охватывает практически все аспекты. Вот, например, одна из статей.
В чем проблема с Confluence или почему я решила написать этот текст
Часто вижу в разных компаниях, что документация в Confluence живет своей жизнью: команды оформляют и хранят данные как хотят, никто сильно не погружается в работу этой системы. Из-за этого она кажется неповоротливой, вызывает раздражение и жаркие споры о том, какой инструмент лучше подойдет для накопления и передачи знаний.
Не буду утверждать, что Confluence — самый лучший в мире инструмент для работы с документацией. Все-таки, это дело привычки, вкуса и корпоративных ограничений. Наоборот, в тексте сосредоточусь на прикладных знаниях о том, как ласково приручить этого непростого зверя и покажу, как документация может преобразиться с использованием конкретных макросов.
- недавно начал с ней работать,
- уже использует и ищет способы сделать работу с Confluence более комфортной.
Что такое макросы и зачем они нужны
Макросы — это программные алгоритмы действий, «упакованные» в понятный графический интерфейс. Если проще, это внутренние инструменты Confluence, которые помогают делать документацию понятнее и удобнее.
Чем макросы круче текстовых редакторов?
Базовая комплектация текстового редактора выполняет простые операции по редактированию. Например, там можно выделить текст жирным или курсивом, изменить цвет символов, выровнять столбцы по середине или по краю.
Макросы эти возможности расширяют: интегрируют контент из внешних источников, помогают настроить навигацию внутри большой базы знаний или сформировать единый тон визуального оформления документации.
- форматирование контента,
- интеграция внутреннего контента,
- интеграция внешнего контента.
Где находятся макросы
Макросы можно добавить в статью в режиме редактирования. Они прячутся в верхней панели инструментов, за кнопкой с названием «Вставить прочий контент».
Самые популярные макросы — например, «Оглавление» и «Галерея» — лежат в выпадающем меню. Больше возможностей скрываются за строчкой «Другие макросы».
В библиотеке макросы рассортированы по группам. В левой части интерфейса можно сразу перейти к нужной группе.
Если подходящего макроса не нашлось, через кнопку «Найти еще макросы…» можно перейти в Atlassian Market и изучить платные и бесплатные дополнения, совместимые с вашей версией Confluence.
Макросы-блоки и макросы-рамки
Макрос может быть самодостаточным и не требовать вставки чего-то (например, текста, изображений или ссылок) внутри себя. В таком случае он выглядят как блок.
Макросы-блоки выполняют сложные операции вроде составления оглавления, интеграции контента и формирования диаграмм.
Если для работы макроса что-то нужно поместить внутрь, он выглядит как рамка.
Режим редактирования. Внутри рамки макроса — текст, который будет в раскрывающемся меню.
После сохранения страница будет выглядеть так.
Внутрь одного макроса-рамки можно помещать сколько угодно других макросов. Главное, чтобы в пирамиде была логика. Так, например, можно сделать пирамиду из раскрывающихся пунктов, или спрятать содержание статьи, если оно слишком объемное. Или добавить макрос форматирования текста.
Возможно, эти тексты тоже вас заинтересуют:
Макросы форматирования: подсказка, предупреждение, примечание и блок кода
- делают важные текстовые вставки заметными,
- задают единый тон визуального оформления,
- позволяют вставить код в статью и подсветить синтаксис.
Пожалуй, самый распространенный пример разноформатного подхода — это выделение подсказки, предупреждения и примечания.
Опасность разного оформления в том, что при беглом прочтении такие акценты могут проскользнуть мимо внимания читателя. А еще к ним будет сложно вернуться и придется перечитывать текст заново.
Как использовать
В Confluence нашли изящное решение: унифицировали макросы «Подсказка», «Предупреждение», «Примечание» и «Информация».
Описание этой группы макросов в Confluence.
В режиме редактирования они выглядят как макросы-рамки, внутри которых можно разместить текст.
После публикации блоки с выделенной информацией становятся заметнее, и, главное, выглядят однообразно в разных статьях.
Текст до использования макроса:
Текст после. В итоге примечание выглядит аккуратно и имеет необходимый по смыслу визуальный акцент:
Еще один классный макрос, который поможет сделать доку более удобной и читаемой — блок кода. Он не только форматирует текст, но и подсвечивает синтаксис языка, на котором код написан. Кроме того, подходит для размещения небольших отрывков кода внутри статьи. Например, если пишете инструкцию по созданию формы обратной связи.
После добавления макроса информация стала более заметной и читаемой.
Макросы для интеграции внутреннего контента
- создают «зеркало» статьи или ее отрывка в другом пространстве,
- поддерживают автообновление: достаточно внести правки в оригинал, и все интеграции обновятся сами,
- помогают быстро перейти из «зеркала» в оригинальную статью и углубиться в нужный материал.
Главный профит этого макроса в обновлении: если в исходной статье что-то поменяется, цитата или страница-зеркало изменится вместе с ней. Это намного эффективнее ручного обновления скопипащенного отрывка.
- перейти в режим редактирования на той странице, где содержится необходимая информация,
- выделить предложение, абзац или несколько абзацев, которые надо процитировать,
- вставить макрос «Выборка».
Теперь открываем ту статью, которая будет содержать эту цитату и вставляем макрос «Включить выборку». Вуаля — цитата появилась на странице. Если исходный текст цитаты поменяется, он обновится автоматически во всех статьях, где будет включена эта выборка.
Если нужно процитировать статью целиком, то на помощь придет макрос «Включить страницу». Здесь после выбора макроса нужно ввести название статьи, которую будем транслировать на этой странице. Дополнительно включать выборку на исходной не нужно.
Макросы интеграции внешнего контента
- позволяют размещать контент из внешних источников без дополнительных авторизаций,
- можно вставить задачи из Jira и видеть актуальный статус, не переходя в таск трекер,
- взаимодействие с интерактивным виджетом происходит прямо в Confluence.
Самый простой пример такой внешней интеграции — добавление на страницу задач из Jira.
Таски добавляются через макрос «Фильтр\проблема Jira» — достаточно ввести код проекта и номер задачи. В Confluence подтянется ее название и актуальный статус.
На этой странице собрана часть задач по созданию кластера Managed Kubernetes. Видно название задачи, ее код в таск-трекере, а также статус в реальном времени. По клику по коду задачи можно перейти в Jira и посмотреть подробности.
Еще один полезный макрос интеграции внешнего контента — «Коннектор виджета». С его помощью на страницу можно добавить любой контент из интернета, будь то видео с YouTube, Google-документ или таблица. Все будет отображаться прямо в Confluence без дополнительных авторизаций.
Например, можно собрать галерею из выступлений коллег. На скриншоте — наша подборка докладов сотрудников Selectel.
Где больше узнать про макросы
У Confluence есть много возможностей для работы с контентом. И этот текст, конечно же, не является исчерпывающим руководством.
Если макросов «базовой комплектации» не хватает, то на помощь придет Atlassian Market. В нем можно выбрать из тысячи решений именно то, которое подойдет под потребности вашего проекта. Среди дополнений есть предложения и самого Atlassian, и сторонних разработчиков, которые делали макросы для себя, а после удачного запуска представили их широкой аудитории.
Больше полезной информации по работе с Confluence можно найти в корпоративном университете Atlassian Univercity или на ютуб-канале Atlassian.
Confluence в жизни аналитика — Часть 1
Последние несколько митапов выявили, что Вики-система Confluence является одним из весьма популярных инструментов среди некоторых белорусских аналитиков и что способы его использования всё ещё недостаточно широко известны и вызывают массу любопытства у многих наших коллег.
Как известно, если есть интерес, то поступает и предложение 🙂
В этой статье я не буду писать о том, какой инструмент подходит лучше для работы с требованиями или, например, почему надо выбрать для этого именно Confluence. Мы не будем раскрывать тему стандартных преимуществ wiki-систем вроде централизованного доступа к актуальным материалам, версионности и возможностей совместной работы.
Статья ориентирована на тех читателей, кто уже сделал свой выбор (или выбор уже сделан за них), а также на тех, кто желает попробовать использовать Confluence в работе.
В первой части мы познакомимся с системой, попробуем разрушить некоторые стереотипы и показать, что этот зверь не только не страшный, но и очень даже полезный – почти такой же полезный, как ваш кот.
Вторая часть статьи будет ориентирована больше для работы, чем для знакомства. В ней рассмотрим некоторые лайфхаки, которые существенно упрощают жизнь BA, SA, PM, QA, …(добавьте свой вариант). Постараюсь не забыть о возможностях Confluence, без которых мне было бы уже трудно представить приятную работу.
Не обойдётся и без порции Рождественской Магии в канун праздников…
Модульность Confluence и Atlassian Market
“Базовая комплектация” Confluence вполне себе позволяет выполнять простые операции по управлению требованиями с достаточной степенью комфорта. Тем не менее, много-много радостей от работы доставят платные и бесплатные дополнения. У Atlassian есть собственный маркет, в котором можно выбрать add-on на ваш вкус, в соответствии с потребностями вашего процесса или особенностями проекта. Среди дополнений, которые можно скачать и установить, встречаются как наработки Atlassian, так и предложения сторонних разработчиков, которые, по всей видимости, изначально разработали дополнения для себя, а затем представили его широкой аудитории.
Обзор каждого из дополнений для Confluence – это тема для отдельной статьи, но я всё же не удержусь от упоминания самых-самых, которые использую сам.
Любителям MS Word!
Первый из указанных выше митапов выявил одно из популярных заблуждений о том, что Confluence не настолько удобен для редактирования текстов и, в частности, для оформления требований, как старый добрый и махровый MS Word.
Если ваша задача в том, чтобы оформить документ для печати с использованием специально заданных шрифтов, требований к отступам и полям – то действительно, навряд ли вам стоит рассматривать какую-либо вики в принципе. Однако, если же от вас ожидают не более чем аккуратно оформленные и читабельные требования, которые, возможно, потом захочется сохранить файлом для отправки, печати, прочтения и подписи – смело работайте в Confluence, сохранив все традиционные преимущества wiki.
Итак, давайте рассмотрим случай, когда вам прислали MS Word документ с начальными требованиями и администратор создал пустой (или не совсем пустой) спэйс (Space или пространство имён) для вашего проекта.
Кстати, изобретатели вики придумали пространство имён для того, чтобы позволить создавать статьи с одинаковым именем в нескольких разных областях знаний. Например, википедия объясняет этот термин следующим образом.
Во избежание путаницы, именам в одном пространстве имён не дают более одного значения. Например, в пространстве имён улиц любого города названия улиц, как правило, не повторяются.
Для нас с вами такие пространства удобно использовать как разделы для проектов: каждому проекту свой раздел, своё пространство 🙂 Так, в каждом проекте могут быть страницы с одинаковым именем, которое может встречаться и в другом проекте, как например “Страница входа в систему”, описание которой есть, наверняка найдётся в каждом проекте.
У вас есть документ. Есть вики. Вы смотрите на документ. Смотрите на вики. Смотрите снова на документ. Смотрите снова на вики. Думаете. Ещё думаете. Вики смотрит на вас… Что с ними делать?
Иногда начинающие пользователи просто берут и прикрепляют документ как приложение к страничке вики. Если при этом было установлено и включено бесплатное дополнение Office Connector, которое включено в базовую комплектацию, то довольный пользователь радостно обнаруживает текст загруженного документа встроенным прямо в страничку, с кнопкой для редактирования.
Это уже прикольно и весело, но для управления требованиями не годится. Также как не годится, например, устроить пикник прямо в комнате, не выходя на улицу. Пикник вроде бы и есть, но понарошку, не настоящий.
Надо отметить, что если ваша задача в том, чтобы показать/прикрепить/опубликовать в сети презентацию, то описанное решение не так уж плохо и может быть вполне уместно: пользователю не нужно будет ничего скачивать, контент прикреплённого документа будет виден сразу на странице.
Такой подход НЕ предполагает удобное редактирование.
Однако, если мы хотим в дальнейшем как-то работать с текстом из любого стороннего документа, то лучше всего его перенести непосредственно в вики. Для того, чтобы это сделать, можно предложить как минимум два способа.
а) Импорт документа. Про него ниже.
б) Способ “от кэпа” – копирование контента из документа. На самом деле, может быть вполне оправдано, когда вы хотите правильно сформулировать и оформить требования, “пропустив исходный текст через себя”.
При должном форматировании документа Confluence позволит даже создать отдельную страничку для каждой секции, найденной в word файле, до уровня заголовков, нужного вам. Таким образом, структура импортированных в вики страниц будет совпадать со структурой оригинального документа.
Форматирование – переформатирование..
Текст перенесён. Теперь перед нами встала задача его редактирования. Могу ошибиться, но предположу, что первое, что отличает текстовый редактор MS Word от текстового редактора Блокнот, – это, пожалуй, возможность “богатого” форматирования текста, призванного сделать текст более читабельным: Жирность, Курсив, Подчёркнутость, Заголовки, Списки…
Все эти базовые приёмы форматирования текста также хорошо и на лету работают в Confluence, как в редакторе от Майкрософт.
Подозреваю, что даже ещё более «на лету», чем в самом Ворде 🙂
С одной стороны, как обычно, присутствует панель WYSIWYG редактора с привычными опциями форматирования и для любителей горячих клавиш и быстрого набора красивых текстов сочетания Ctrl+B, Ctrl+U, Ctrl+I и автонумерацию никто не отменял.
С другой стороны – доступна вся мощь работы с wiki markup language…
Ссылки – гиперссылки и что такое wiki markup language
Так вот, в отличие от работы в MS Word, вы можете добавлять ссылки на существующую страницу даже без обращения к опции меню “добавить ссылку”. Не обязательно ходить в разные там меню: когда вы работаете в вики, ссылки можно вставлять прямо по ходу написания текста, открыв квадратную скобку “[…” и начав писать имя страницы, на которую вы хотите сделать ссылку. Confluence подскажет вам выпадающим списком, какие страницы уже созданы, и вы можете выбрать существующую страницу, на которую должна указывать ссылка.
А ещё вы можете написать заголовок несуществующей страницы и закрыть скобку “]”. Такая ссылка будет подсвечена по-особенному: нажав на неё, Confluence предложит создать новую страницу с заголовком, соответствующим введённому тексту. Заголовок страницы вы, впрочем, можете изменить, изменив заодно и URL, но все встречающиеся в вики ссылки на вашу страницу при этом сохранятся, что может быть неожиданным, но приятным сюрпризом!
Квадратная скобка – это наследие wiki markup языка, который был основным в ранних версиях продукта. Сейчас он уже не используется в явном виде, как в былые времена, однако некоторые его элементы всё ещё работают и поддерживаются, существенно упрощая редактирование текста и создание требований.
Ветераны помнят время, когда можно было переключиться в режим wiki markup и насладиться работой в plain text редакторе с использованием олдскульной разметки во всей красе, как показано на фотографии.
Сегодня аналогичный контент в режиме редактирования выглядит примерно так, как и финальный вариант отображения страницы. Atlassian подарили пользователям такую долгожданную реалистичность в 4-й версии Confluence, полностью переработав редактор и лишив тем самым фанатов удовольствия ковыряния в вики разметке.
Так выглядит результат редактирования.
Возможности быстрого форматирования удачнее всего, на мой взгляд, иллюстрирует видео от производителя, выпущенное в преддверии той версии, когда был отменён wiki markup в своём классическом смысле:
А как сделать ссылку на конкретное место на странице?
А очень просто. Как мы с вами уже знаем, ссылка записывается, например, вот так: “[ссылка на страницу A]”. И так: “[ссылка на страницу A|Текст ссылки]”.
Если вы хотите сделать ссылку на секцию на вашей странице, то добавьте к заголовку секции решётку “[#Секция]” или так “[#Секция|Текст ссылки на Секцию]”.
А если вы хотите сделать ссылку на произвольное место на странице – используйте макрос
Кроме этого, если вы хотите вставить ссылку, которая, например, обязательно должна открыться в новом окне, то на такой случай предусмотрено бесплатное скачиваемое дополнение Linking.
Что ещё за макросы?
Макросы — это встроенные возможности Confluence, придуманные для облегчения жизни пользователям и для открытия доступа к бесконечным возможностям работы! Очень часто дополнения, представленные для Confluence в Atlassian маркете, – это именно возможности использования макросов. В языке вики-разметки макрос начинается открывающей фигурной скобкой “<“ и заканчивается закрывающей “>”. Есть и такие, которые подгружают к странице целые компоненты сторонних систем, как например макрос
Некоторые популярные макросы:
Макросы для вставки документов: excel, word, pdf,
Макросы для интеграции с EverNote, Google Drive, Dropbox
Макросы для работы с таблицами
Надеюсь, если вы ещё не пробовали Confluence, то теперь вам наверняка захочется его попробовать. Если же пробовали и всё равно нашли что-то новое и полезное, то я буду считать миссию этой части статьи выполненной.
В следующей части мы рассмотрим, как же применить возможности Confluence к работе аналитика:
как аналитик вносит требования в систему, как между ними можно выстраивать связи и управлять изменениями, нужна ли аналитику матрица трассировки требований
рассмотрим способ организации требований и существующие подходы к структуре
и раскроем некоторые секреты про то, как Confluence помогает во взаимодействии с командой и с заказчиком.
Магия вне Хогвартса: 7 макросов в Confluence, которые автоматизируют и упрощают работу с документацией
Привет! Меня зовут Таня Дудо, и я уже 6 лет помогаю людям и командам обмениваться знаниями и строить рабочие процессы. Для этого использую Confluence. Да-да, ту самую wiki-систему, которую часто называют неудобной и несовременной. Сегодня выступлю ее адвокатом-обозревателем: расскажу про 7 полезных макросов для систематизации и оформления контента.
Навигация по тексту:
Часто вижу в разных компаниях, что документация в Confluence живет своей жизнью. Команды оформляют и хранят данные как хотят, никто сильно не погружается в работу этой системы. Из-за этого она кажется неповоротливой, вызывает раздражение и жаркие споры о том, какой инструмент лучше подойдет для накопления и передачи знаний.
Не буду утверждать, что Confluence — самый лучший в мире инструмент для работы с документацией. Все-таки, это дело привычки, вкуса и корпоративных ограничений. Наоборот, в тексте сосредоточусь на прикладных знаниях о том, как ласково приручить этого непростого зверя и покажу, как документация может преобразиться с использованием конкретных макросов.
Рекомендую к прочтению тем, кто:
- только присматривается к этой системе хранения данных,
- недавно начал с ней работать,
- уже использует и ищет способы сделать работу с Confluence более комфортной.
Макросы — это программные алгоритмы действий, «упакованные» в понятный графический интерфейс. Если проще, это внутренние инструменты Confluence, которые помогают делать документацию понятнее и удобнее.
Чем макросы круче текстовых редакторов?
Базовая комплектация текстового редактора выполняет простые операции по редактированию. Например, можно выделить текст жирным или курсивом, изменить цвет символов, выровнять столбцы по середине или краю.
Макросы эти возможности расширяют: интегрируют контент из внешних источников, помогают настроить навигацию внутри большой базы знаний или сформировать единый тон визуального оформления документации.
В Confluence макросов много — больше 5 тысяч , но я сосредоточусь на трех группах. Это:
- форматирование контента,
- интеграция внутреннего контента,
- интеграция внешнего контента.
Их можно называть «группами быстрого улучшения» — они помогут сделать вашу доку читабельнее всего за пару кликов.
Макросы можно добавить в статью в режиме редактирования. Они прячутся в верхней панели инструментов, за кнопкой с названием «Вставить прочий контент».
Самые популярные макросы — например, «Оглавление» и «Галерея» — лежат в выпадающем меню. Больше возможностей скрываются за строчкой «Другие макросы».
В библиотеке макросы рассортированы по группам. В левой части интерфейса можно сразу перейти к нужной группе.
Если подходящего макроса не нашлось, через кнопку «Найти еще макросы…» можно перейти в Atlassian Market и изучить платные и бесплатные дополнения, совместимые с вашей версией Confluence.
Макросы-блоки и макросы-рамки
Макрос может быть самодостаточным и не требовать вставки чего-то (например, текста, изображений или ссылок) внутри себя. В таком случае он выглядят как блок.
Если для работы макроса какой-то контент нужно поместить внутрь, он будет выглядеть как рамка.
Представьте: вам нужно спрятать под кат какой-то текст. Тогда можно использовать макрос «Раскрыть»: внутрь рамки помещаем текст, а после сохранения он окажется внутри раскрывающегося меню. В картинках ниже показываю это подробнее.
Внутрь одного макроса-рамки можно помещать сколько угодно других макросов. Главное, чтобы в пирамиде была логика. Так, например, можно сделать пирамиду из раскрывающихся пунктов или спрятать содержание статьи, если оно слишком объемное. Или добавить макрос форматирования текста.
Зачем нужны:
- делают важные текстовые вставки заметными,
- задают единый тон визуального оформления,
- позволяют вставить код в статью и подсветить синтаксис.
В работе с документацией в разных компаниях я часто замечала одну и ту же деталь: для внутренней продуктовой документации нет единых правил форматирования. В пространствах может быть отлично настроено дерево страниц, для доки созданы отдельные разделы, могут быть даже ключевые вопросы или примерный план-содержание, но внутри тексты разных статей на одну и ту же тему будут отличаться.
Пожалуй, самый распространенный пример разноформатного подхода — это выделение подсказки, предупреждения и примечания.
Наверняка вы видели, как в самом начале текста написано «ВНИМАНИЕ», а после этого идет абзац красного текста. Или подсказка отмечена звездочкой, а пояснение дано внизу страницы курсивом.
Опасность разного оформления в том, что при беглом прочтении такие акценты могут проскользнуть мимо внимания читателя. А еще к ним будет сложно вернуться и придется перечитывать текст заново.
Как использовать
В Confluence нашли изящное решение: унифицировали макросы «Подсказка», «Предупреждение», «Примечание» и «Информация».
В режиме редактирования они выглядят как макросы-рамки, внутри которых можно разместить текст.
После публикации блоки с выделенной информацией становятся заметнее, и, главное, выглядят однообразно в разных статьях.
Еще один классный макрос, который поможет сделать доку более удобной и читаемой — блок кода. Он не только форматирует текст, но и подсвечивает синтаксис языка, на котором код написан. Кроме того, подходит для размещения небольших отрывков кода внутри статьи. Например, если пишете инструкцию по созданию формы обратной связи.
Зачем нужны:
- создают «зеркало» статьи или ее отрывка в другом пространстве,
- поддерживают автообновление. Достаточно внести правки в оригинал, и все интеграции обновятся сами,
- помогают быстро перейти из «зеркала» в оригинальную статью и углубиться в нужный материал.
Бывает, что одна статья полезна для нескольких команд. Чтобы не дублировать ее в разных пространствах, можно использовать макросы «Включить выборку» и «Включить страницу».
Выборка — это небольшой отрывок из исходной статьи, а страница — полное «зеркало» всего текста.
Главный профит этого макроса в обновлении: если в исходной статье что-то поменяется, цитата или страница-зеркало изменится вместе с ней. Это намного эффективнее ручного обновления скопипащенного отрывка.
Чтобы включить цитату из одной статьи в другую, нужно:
- перейти в режим редактирования на той странице, где содержится необходимая информация,
- выделить предложение, абзац или несколько абзацев, которые надо процитировать,
- вставить макрос «Выборка».
Выделенный текст окажется внутри рамки макроса. После сохранения страница в режиме просмотра будет выглядеть так, будто ничего не произошло, но мы-то знаем, что внутри нее есть цитата.
Теперь открываем ту статью, которая будет содержать эту цитату и вставляем макрос «Включить выборку». Вуаля — цитата появилась на странице. Если исходный текст цитаты поменяется, он обновится автоматически во всех статьях, где будет включена эта выборка.
Если нужно процитировать статью целиком, то на помощь придет макрос «Включить страницу». Здесь после выбора макроса нужно ввести название статьи, которую будем транслировать на этой странице. Дополнительно включать выборку на исходной не нужно.
Confluence как сделать раскрывающийся текст
Проектирование в Confluence
- Вы создаете шаблон для информации определенного типа.
- В этот шаблон добавляете метки и свойства страницы в макросе.
- В любом удобном месте создаете корневую страницу с кнопкой, по клику на которую создается дочерняя страница из шаблона.
- Пускаете на корневую страницу пользователей, которые потенциально будут генерировать нужную информацию (по нужному шаблону, нажимая на кнопку).
- Собираете себе отчет по свойствам страницы через метки, которые вы указали в шаблоне.
- Радуетесь: у вас есть вся нужная информация в удобном формате.
- Если вы решите поменять названия или состав свойств страницы, вам придется проапдейтить все уже созданные объекты, чтобы их данные корректно подтянулись в сводный отчет. Это печально, но, с другой стороны, заставляет детально продумать «архитектуру» вашего набора информации, что является весьма интересной задачей.
- Вам придется написать приличное количество инструкций о том, как заполнять информационные таблицы и пользоваться тегами. Но, с другой стороны, вы можете просто кинуть во всех нужных людей этой статьей.
Expand Macro
This macro is available in Confluence Server and Data Center . Learn about the macros available in Confluence Cloud .
Add the Expand macro to your page to provide content in an expandable / collapsible section.
This is one of Confluence’s most popular macros. It’s great for:
- visually reducing the amount of information on a page
- breaking process information down into clickable steps
- hiding background or obsolete information, while still keeping it on the page for future reference.
The macro is collapsed by default, people need to click each one to expand it. There’s no way to expand all macros on a page at once, however all Expand macros are automatically expanded when you print or export the page to PDF.
On this page:
Screenshot: page showing four expand macros. Two are collapsed, and two are expanded.
Add this macro to your page
To add the Expand macro to a page:
From the editor toolbar, choose Insert > Other Macros.
You can then publish your page to see the macro in action.
Screenshot: The expand macro in the editor
Change the macro parameters
Macro parameters are used to change the behaviour of a macro.
To change the macro parameters:
- In the editor, click the macro placeholder and choose Edit.
- Update the parameters as required then choose Insert.
Here’s a list of the parameters available in this macro.
Title
Click here to expand.
Defines the text that appears next to the expand/collapse icon.
Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets ( example ).
Other ways to add this macro
Add this macro as you type
Add this macro using wiki markup
This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.
Macro name: expand
Macro body: Accepts rich text.
Notes
- Text is expanded in PDF and HTML exports. When you export the page to PDF or HTML, the text between the macro tags is expanded so that readers can see it in the PDF and HTML versions of the page.
- Nesting your Expand macros. You can put one Expand macro inside another, and Confluence will correctly show and hide the contents of all Expand macros, including the nested ones.
- Using the Confluence Cloud editor? This macro may not be available in the new editor. See Expand macro for more information.
Do more with Confluence
Extend Confluence with one of the hundreds of other macros in the Atlassian Marketplace, such as: