It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

The Admin's tale - Adding an image to the page title

eleven-small.png

Once upon a time, the admin was asked once again for something, that Confluence was not providing out of the box.

A space administrator told him that his space includes pages belonging to five different topics. The space admin designed a great home page for his space and five logos for the five topics. People should recognize at a glance which topic each page belongs to. He wanted to add the images to the page title.

First, the admin tried to get rid of that requirement (he simply didn't have enough time, as always...). He told the space admin to add the logo to the page content itself. But soon, they found out that this was not the right place for a recurrent logo. The page design was terrible with that logo floating around somewhere and so, the admin had to think about the problem again. And this is what he found out:

What if one could add an image in front of the page title without changing the page title?

So, how can this be done? There is no built-in-feature like that and the admin didn't find a plugin that would do the trick. So he decided to create a small custom User Macro to implement this feature.

What are user macros? I explained this in my last article, so you can read it there, if you want to. 

The admin found out that the title of a Confluence page is displayed using a CSS style called "title-text". The idea was: Customizing this CSS style, so that not only the page title is displayed, but also a small image in front of the page title.

A space admin is able to adjust the CSS for the whole space globally but this did not work, because there should be different images for the different topics and also pages without images at all. There were some main requirements for implementing the solution:

  • Adding CSS directly with the editor is not allowed
  • There should be different images available for the page (or none)
  • The user must not know the URL of the images
  • Only predefined images should be used  

Implementing the macro

The admin created a new User Macro called "page_title_image":

usermacro1.png

 

The macro has no macro body, just one enum parameter for the image and values for each possible image. The different images were added as atttachments to a Confluence page, the "image store". The admin copied the URLs of these images from the attachments list of the page and added it to the User Macro as enumValues:

## @param 0:title=Image-URL|type=enum|enumValues=h t t p : / / wiki.example.de/download/attachments/492699664/Puzzle31.jpg,h t t p : / / wiki.example.de/download/attachments/492699664/Puzzle4.1.jpg,h t t p : / / wiki.example.de/download/attachments/492699664/Puzzle1.1.jpg|default=h t t p : / / wiki.example.de/download/attachments/492699664/Puzzle31.jpg

(I added blanks to the "http://" so they are not represented here as link)

And then, the user could select from the different available images as follows:

usermacro3.png

But how is this image added in front of the page title?

The admin performed a little bit of CSS magic, waved his wand and wrote the following User Macro Template to add the CSS to the page:

<style>
#title-text {
background-image: url('$param0');
background-repeat: no-repeat;
padding-left: 40px; /* width of image plus margin, may be different in other systems */
display: block;
}
</style>

 

  • This script is adding the stylesheet to the Confluence page.
  • The stylesheet puts the selected image in front of the page title.
  • The page title remains the same as before, of course.

And this is how it looks on the Confluence page:

usermacro4.png

 The space admin was happy, as well as the Confluence Admin and the User Macro was heavily used until now.

... and they all lived happily ever after.  

And here is another Admin's Tale: Fun with labels, not with flags

2 comments

Nice article Thomas..! I wanted to know if there is a possibility of having image uploaded from the local system like the files & images macro work. I tried using the url of the image I uploaded to a page. I am landing on the rendering error.

Error rendering macro 'page_title_image'

[com.ctc.wstx.exc.WstxLazyException] Unexpected character '=' (code 61); expected a semi-colon after the reference for entity 'modificationDate' at [row,col {unknown-source}]: [4,138]

Can you please  advise.

Thank you for the info.

And does the image show in the dropdown in the top-right Search??

Comment

Log in or Sign up to comment
Community showcase
Published in Confluence Cloud

What are your best tips for using Jira / Confluence together?

Hi Community! Jenn from Confluence Cloud PMM team here. Have you heard these tips for using Jira / Confluence together? Here are a few of our favorite tricks for making the most of your time. We...

380 views 2 10
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you