Confluence спойлер как сделать

Confluence спойлер как сделать

Expando Macro for Confluence: Collapse and Expand Headings

We have just released the public beta of a new add-on from the «little, useful and free helpers» category: The Expando Macro.

The Expando Macro makes headings clickable and expands or collapses the content that belongs to that heading, and it expands content based on a macro parameter or on the linked HTML anchor.

Another Expand Macro?

Our tech writers want to make use of Progressive Disclosure in our docs to help readers focus on the relevant content. They weren’t 100% happy with the standard Expand Macro that is shipped with Confluence, because they want to use headings to structure Confluence pages and collapse content without adding additional structural elements. Also, for FAQs and Glossaries they need to link and expand single entries (using HTML anchors).

An Example Glossary

The following page is an example from a glossary for a product:

As you can see the content is all displayed and even though there are only 4 entries there is a lot of potentially distracting content.

Let’s add the Expando Macro.

Add an Expando Macro to all headings that should operate as expandable/collapsible content sections. As a result of this, the sections below all headings are collapsed, or only selected sections are expanded:

This is the above screenshot, the content below the third heading is expanded because it’s anchor is referenced in the URL.

Get Started

The macro has been uploaded to the Atlassian Marketplace and can be simply installed via the UPM.

Please give it a try and let us know what you think!

Go ahead and try the Expando Macro. It’s free and available on the Atlassian Marketplace.
Let us know what you think of the macro and how you structure your content on a page level by commenting on this post!

Магия вне Хогвартса: 7 макросов в Confluence, которые автоматизируют и упрощают работу с документацией

Привет! Меня зовут Таня Дудо, и я уже 6 лет помогаю людям и командам обмениваться знаниями и строить рабочие процессы. Для этого использую Confluence. Да-да, ту самую wiki-систему, которую часто называют неудобной и несовременной. Сегодня выступлю ее адвокатом-обозревателем: расскажу про 7 полезных макросов для систематизации и оформления контента.

Навигация по тексту:

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

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

Рекомендую к прочтению тем, кто:

• только присматривается к этой системе хранения данных,
• недавно начал с ней работать,
• уже использует и ищет способы сделать работу с Confluence более комфортной.

Макросы — это программные алгоритмы действий, «упакованные»‎ в понятный графический интерфейс. Если проще, это внутренние инструменты Confluence, которые помогают делать документацию понятнее и удобнее.

Чем макросы круче текстовых редакторов?

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

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

В Confluence макросов много — больше 5 тысяч , но я сосредоточусь на трех группах. Это:

• форматирование контента,
• интеграция внутреннего контента,
• интеграция внешнего контента.

Их можно называть «группами быстрого улучшения»‎ — они помогут сделать вашу доку читабельнее всего за пару кликов.

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

Самые популярные макросы — например, «Оглавление»‎ и «Галерея»‎ — лежат в выпадающем меню. Больше возможностей скрываются за строчкой «Другие макросы»‎.

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

Если подходящего макроса не нашлось, через кнопку «Найти еще макросы…»‎ можно перейти в Atlassian Market и изучить платные и бесплатные дополнения, совместимые с вашей версией Confluence.

Макросы-блоки и макросы-рамки

Макрос может быть самодостаточным и не требовать вставки чего-то (например, текста, изображений или ссылок) внутри себя. В таком случае он выглядят как блок.

Если для работы макроса какой-то контент нужно поместить внутрь, он будет выглядеть как рамка.

Представьте: вам нужно спрятать под кат какой-то текст. Тогда можно использовать макрос «Раскрыть»‎: внутрь рамки помещаем текст, а после сохранения он окажется внутри раскрывающегося меню. В картинках ниже показываю это подробнее.

Внутрь одного макроса-рамки можно помещать сколько угодно других макросов. Главное, чтобы в пирамиде была логика. Так, например, можно сделать пирамиду из раскрывающихся пунктов или спрятать содержание статьи, если оно слишком объемное. Или добавить макрос форматирования текста.

Зачем нужны:

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

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

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

Наверняка вы видели, как в самом начале текста написано «ВНИМАНИЕ»‎, а после этого идет абзац красного текста. Или подсказка отмечена звездочкой, а пояснение дано внизу страницы курсивом.

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

Как использовать

В Confluence нашли изящное решение: унифицировали макросы «Подсказка»‎, «Предупреждение»‎, «Примечание»‎ и «Информация»‎.

В режиме редактирования они выглядят как макросы-рамки, внутри которых можно разместить текст.

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

Еще один классный макрос, который поможет сделать доку более удобной и читаемой — блок кода. Он не только форматирует текст, но и подсвечивает синтаксис языка, на котором код написан. Кроме того, подходит для размещения небольших отрывков кода внутри статьи. Например, если пишете инструкцию по созданию формы обратной связи.

Зачем нужны:

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

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

Выборка — это небольшой отрывок из исходной статьи, а страница — полное «зеркало»‎ всего текста.

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

Чтобы включить цитату из одной статьи в другую, нужно:

• перейти в режим редактирования на той странице, где содержится необходимая информация,
• выделить предложение, абзац или несколько абзацев, которые надо процитировать,
• вставить макрос «Выборка»‎.

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

Теперь открываем ту статью, которая будет содержать эту цитату и вставляем макрос «Включить выборку»‎. Вуаля — цитата появилась на странице. Если исходный текст цитаты поменяется, он обновится автоматически во всех статьях, где будет включена эта выборка.

Если нужно процитировать статью целиком, то на помощь придет макрос «Включить страницу»‎. Здесь после выбора макроса нужно ввести название статьи, которую будем транслировать на этой странице. Дополнительно включать выборку на исходной не нужно.

Как создать шаблон в Confluence

Хотите помочь своей команде вывести новый проект на новый уровень? Использование правильного шаблона Confluence упростит ваше рабочее пространство и упорядочит важную информацию, чтобы ее было легко найти и понять. Это не только упростит вашу рабочую неделю, но и поможет вам чувствовать себя более уверенно при решении новых задач с помощью шаблонов Confluence.

Продолжайте читать, чтобы узнать, как создать шаблон, идеально соответствующий вашим рабочим требованиям.

Работа с шаблонами страниц

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

Что Are Sтемп Tшаблоны и G общие Tшаблоны

Confluence поставляется с двумя различными вариантами шаблонов страниц:

• Шаблоны пространств

Участники рабочей группы могут использовать эти шаблоны только в определенном пространстве Confluence. Если вы являетесь администратором пространства, вы сможете редактировать или создавать шаблоны в Confluence Cloud и выбирать их на экране управления пространством.

• Глобальные шаблоны

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

Как создать шаблон в Confluence

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

Чтобы добавить новый шаблон пространства:

Введите соответствующий пробел и найдите ‘’инструменты Space’’ в нижней части панели инструментов.

1. Нажмите ‘’Инструменты работы с контентом’’
   
2. Выберите ‘’Шаблоны’’
   
3. Выберите ‘’Создать новый шаблон’’
   

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

Чтобы создать новый глобальный шаблон, войдите в свое облако Confluence Cloud и выполните следующие действия:

1. Найдите значок колесика настроек в правом верхнем углу экрана. Выберите его, чтобы открыть настройки веб-сайта.
   
2. Перейдите на панель инструментов и найдите «Конфигурация». step3″>Выберите ‘’Глобальные шаблоны и схемы’’
   
3. Выберите “Добавить глобальный шаблон страницы”.’’
   

Как добавить описание шаблона

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

Чтобы включить или изменить описание глобального шаблона:

1. Откройте настройки.
   
2. Выберите ‘’Глобальные чертежи и Шаблоны’’
   
3. Выберите маленькую кнопку с карандашом.

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

Как добавить переменные в шаблон Confluence

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

Чтобы вставить переменную:

1. Выберите ‘’Шаблоны’’ на панели инструментов.
   
2. Выберите ‘’Новая переменная’ ; или выберите уже существующий.
   
3. Введите переменную’ имя пользователя.
   
4. Нажмите клавишу Enter, чтобы создать однострочное текстовое поле.
   

Если вы хотите изменить тип переменной, выберите заполнитель. Откроется окно панели свойств. Здесь вы можете выбрать между ‘’Текст’’ ‘’Многострочный текст’’ и ‘’Список’’

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

Кроме того, когда вы выбираете ‘’Многострочный текст’’ вы сможете настроить количество строк, необходимых для ввода. Если щелкнуть ‘’Список’ открывает окно для ввода доступных параметров, разделяя их запятой.

Как добавить метки в шаблон Confluence

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

Если вы хотите добавить метки в шаблон с помощью устаревшего редактора:

1. Перейдите к верхней части страницы и выберите значок ярлыков рядом с навигационными крошками.
   
2. Появится всплывающее окно. Введите метки и разделите их клавишей пробела.
   
3. Нажмите &lsquo ;’Добавить’’
   
4. Выберите ‘&rsquo ;Закрыть’’ чтобы завершить действие.
   

Если вы хотите добавить ярлыки через новый редактор:

1. Нажмите значок хлебных крошек и выберите ‘’Добавить ярлыки’’
   
2. Введите метки и разделите их клавишей пробела в поле.
   
3. Выберите ’Добавить’’
   
4. После того, как вы ввели все ярлыки, выберите ‘’Закрыть’’ чтобы сохранить их в шаблоне.
   

Как добавить текст-заполнитель в Шаблон слияния

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

Если вы используете устаревший редактор:

1. Выберите ‘’+’, затем нажмите ‘’Текст-заполнитель’’
   
2. Введите текст в поле и нажмите Enter.
   

При использовании нового редактора сделайте следующее:

1. Введите “ /заполнитель” где вы хотите, чтобы люди видели текст, затем нажмите Enter.
   
2. Введите текст и снова нажмите Enter.
   

Как продвигать шаблон

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

Если вы хотите продвигать шаблон:

1. Введите свое пространство в Confluence Cloud.
   
2. Найдите панель инструментов и нажмите ‘’Настройки пространства’’
   
3. Откройте ‘’Внешний вид’’ карточку, затем выберите «Шаблоны».
   
4. Просмотрите список и выберите нужный шаблон.
   
5. Выберите &lsquo ;’Продвижение’’ чтобы завершить действие.
   

Как удалить шаблон

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

Если вы хотите сделать шаблон недоступным, выполните следующие действия:

1. получите доступ к своему пространству в Confluence Cloud.
   
2. Выберите ‘’Настройки пространства’’ на боковой панели.
   
3. Нажмите ‘’Шаблоны’’ в разделе ‘’Посмотри и почувствуй’’ карта.
   
4. Выберите шаблон, который хотите удалить, и нажмите ‘’Удалить.&rsquo ;’
   

Уверенная работа с Confluence

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

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

How to hide certain contents of a Confluence page from or show them to users

Visibility is an app developed by ServiceRocket and available on the Atlassian Marketplace. It allows one to display or hide sections of the contents of a Confluence page from a user according to different criteria, such as rights, group membership, page ownership, and even display mode and web browser properties.

The Visibility plugin has changed a lot since its first release. Many macros have disappeared in order to refocus on the essentials with “show-if” and “hide-if”. As their names indicate, these macros allow one to show or hide the contents of a page if certain conditions are satisfied.

The fact that it is free and has many use cases has made this app popular and widely used in implementations. You can decide to display parts of a page based on a team’s group membership, or simply leave instructions invisible in reading mode. Hidden information remains accessible via the “view source” action, so it is not a safe solution for hiding sensitive information.

But since January 2019, and version 5.0, Visibility has become a paid app. So if you are a user, be aware that when you reach the end of your license (or its renewal date), your app will not work unless you buy it. Fortunately it’s still affordable at $150 for 250 users, $1,000 for 10,000 users, and $1,500 for unlimited users.

If you prefer an alternative to this app, be aware that much of the functionality provided by Visibility can be natively covered with user macros.

The implementation achieved by these user macros does not entirely cover the scope offered by the Visibility app.

Here are the features included:

• Named users
• Group membership
• Rights for a page or space
• The type of display—Be careful, as only the PDF export will be available with the “printable” option
• All conditions / one condition

A user macro is a macro that has been declared and defined by the Confluence administrator, and that can process content or display additional content. Creating a user macro requires some skill in development and knowing how to read the Java API.

Here we reveal how to replace Visibility with a native solution.

1. First of all, you will have to disable the Visibility app, since it will be replaced by user macros
2. You will have to modify the CSS to be able to choose to hide certain parts of the Confluence page during PDF export
3. Finally, you will have to create 2 user macros

Let’s get to the heart of the action now.

Creating the “Hide-if” user macro

MODIFYING THE CSS

CREATING THE USER MACRO

Follow the instructions for creating a new user macro using the following settings:

Name of the macro: hide-if

Visibility: Visible to all users in the macro browser

Title of the macro: Hide-If

Description: Hide content when conditions are met

Categories: Confluence Content

Macro body processing: Rendered

Template

That’s it—your users can now hide parts of a Confluence page according to the conditions that they choose.

Creating the “Show-if” user macro

MODIFYING THE CSS

CREATING THE USER MACRO

Follow the instructions for creating a new user macro using the following settings:

Name of the macro: Show-if

Visibility: Visible to all users in the macro browser

Title of the macro: Show-if

Description: Show content when conditions are met

Categories: Confluence Content

Macro body processing: Rendered

Template

You will now be able to show content only if certain conditions are met.

The choice is yours

As you may have understood, depending on your situation and your internal resources, you can either buy the Visibility app or create a workaround by making two user macros that will provide you with essentially the same functionalites.

If you have any questions, don’t hesitate to contact our Atlassian Certified Consultants.