Skip to main content

Confluence: 5 quick things that you need

As part of my work experiments, this week I would like to write down the things that one needs to know in confluence that can up-skill their documentation works. I will cover the following 5 things,

  1. How to Anchor link a title?
  2. How to Anchor link to a section?
  3. How to create a dashing dashboard?
    1. Panel - Confluence Macro
    2. Layouts - Confluence Tools
    3. Content by Label - Confluence Macro

1. How to Anchor link a title?

This is the most required thing. Most useful when one has to refer to a section internally on the same confluence page.

Let's consider you have a page with three different sections and titles as shown below,



In this, if you want to add an internal anchor from a text in paragraph 3 to a title in paragraph 1, you can add it as follows,
  • Choose the word that needs Anchor
  • Click on the link icon from the Toolbar above
  • In the link box, enter #Page Title 1
  • Click Insert

That is it. Your anchor from the selected text to Page Title 1 is ready. This can be tested out in the preview itself.

2. How to Anchor link to a section?

To do this, you need to add an anchor from the Macro as follows,
  • Place your cursor to where the link should navigate to
  • Click on the "+" menu in the toolbar > Choose Other macros

  • In the appearing popup, search for "anchor" and choose it in the appearing result
  • Now, on the appearing screen, type an anchor name and click Insert


  • Once done, choose a word as mentioned in the first section to create the link and click on the insert link option from the toolbar, in the appearing link box, type as shown in the below screenshot:

Tada. Your anchor to the desired section is ready.

3. Creating a dashing dashboard

To create a dashing dashboard on confluence, all that we need is a couple of built-in macros as follows,
  1. Panel
  2. Layouts
  3. Content by Label
With the help of the three of the macros above, we will build a cool dashboard down this article. Before we start, let us consider the following content on our page,

3.1 Panel - Confluence Macro

First, let us look at creating a Panel in a confluence page. This panel will help you categorize anything on your dashboard page. To add a panel, follow the steps below,
  • Select the text you need to put inside a panel
  • Click on the plus available on the toolbar above and choose "Other macros" as indicated below,
  • In the appearing window, search for Panel and choose the indicated one in the following screenshot
  • For the panel configuration, I will fill some of them and preview as indicated in the below screenshot,
  • When this is done, we can remove the Bookmarks title from the page as it comes with the panel itself and preview the page as shown in the below screenshots,


  • To get contrasting colours of the same shade, you can use any online colour palette. I use: https://www.color-hex.com/color-palettes/
  • We will first add all four of the sections with similar panels following the above steps:


There we go. We've successfully setup the panels for our unorganised links. 

3.2 Layouts - Confluence Tools

Although we have the panels in place to separate each section, there is a lot of free-space that can be made use of. Therefore, we shall try to use confluence layouts to organize them.
  • Edit the dashboard and click on Layouts icon from the Toolbar
  • A default layout is setup for the whole page and a sub-toolbar appears
  • Now, click on + Add Section and then ęś› Move up
  • The newly appearing section can be split using the split sub-tools. I will split into 3 equal sections
  • Once done, we shall drag and drop the 3 panels into each of these split sections as shown below,

At this point, I would like to extend my thanks to Adam Ranganathan, from whose dashboards this dashboard was inspired.

3.3 Content by Label - Confluence Macro

We already have a neat dashboard of links. We shall now try to use this macro to automatically pull in links to other confluence pages based on their labels.
  • We will first split the Second Layout into two using the Layout Sub-tool
  • Once done, create an empty panel as shown below,
  • Now that we have created a panel, let us add a Content by Label Macro inside
  • To do so, click inside the panel and add the following Macro,
  • Let us suppose you have classified some of the confluences as meetings-wiki by adding labels. You also have additional label called meetings-wiki-review for the documents under review. Now, in your dashboard, you need handy links for all the confluences under meetings-wiki that are not under review. To get that done, we shall do the following,
  • In the above screenshot, to include the wikis, I've added the label: meetings-wiki
  • Similarly, to exclude the wikis under review, I've added the label with a negate: -meetigns-wiki-review
  • One can also choose to Add other filters and also customise how it should look. I prefer the default settings for them.
  • Once inserted, this is how it appears in the page,
  • When published, you can see the wiki links appearing as follows,

So, those are the five top of the mind things about confluence I wanted to share with everyone. 

Comments

Popular posts from this blog

WebRTC - What the heck?

Over the past few weeks, I happened to work on stuff that enabled me to understand what WebRTC is and how useful it is.  The full form? Web R eal- T ime C ommunication The history It's first release was by 2011. If you want to know more, well, please read the wikipedia . WebRTC  has been a boon to web developers who want to build streaming applications or video calling applications. As you move downward, you'll just may be understand how WebRTC works but nothing technicals.  The story Let's begin with a short story. Long long ago, so long ago, nobody knew how long ago, there lived two shop keeper farmers John & Finch. It was that old point in time when barter system was a thing and money wasn't invented.  These shopkeepers lived in different cities across a river and the cities were connected by a rock solid bridge. Like how the golden gate connects the San Francisco city and the Marin County. Finch is a very private person and takes hard time to trust people. John

Git - How to drop a commit in history?

Back after a while with another git magic. We already have seen how to get rid of the top most commit in this article ->  Git magic - Make commits disappear First of all, it's one of the not so recommended way of doing it and more than that, it can only get rid of sequential commits from latest. I recently happened to get into a scenario where I had to drop a commit in the history by keeping the latest ones. As part of that exploration, presenting you this article. /**  *  @disclaimer  * Please read this post fully before executing any command. My scenario might not be same as yours. */ To my greatest surprise, I didn't know a git rebase could do this. Please continue to read to know how. The steps are simple, Count until the commit line you need to drop using git log Do an interactive rebase and you're done.  Let me explain step by step. 1. Look at the commit log & count commits This is the first step. First let's list the commits using the following command,  

Git - Removing a file from a commit

Once again, another git magic that might be of help to some of you. This research came up when I accidentally added a couple of unwanted files and wanted to remove them from a commit. We all know that to update an existing commit, we shall follow this git magic to amend commits . However, how do we drop changes to a particular file in a commit? While that is easy, it is also tricky. This blog post covers scenarios and respective commands that help you understand what should be done. /**  *  @disclaimer  * Please read this post fully before executing any command. My scenario might not be the same as yours. */ There are two scenarios to be handled here, Remove a newly added file Remove changes to an existing file Let's look at them separately, Remove a newly added file This is the scenario where an unwanted file added to the commit. This file might be some config.json that got generated while doing a research on a new testing tool or a bundling tool. Such scenarios are easier. 1. Re