Let's start by reviewing the conventional methods. Check out the posts below for more background if you aren't already familiar with the options and process.
- Styling Confluence with CSS
While these options do work, they are not ideal and in some cases (like the HTML Macro), should be avoided at all costs. So let's review the cons associated with each of these approaches.
Global Stylesheets and Space Stylesheets allow Confluence administrators or space administrators to insert specific CSS styles into Confluence globally, or within a specific space. This helps eliminate the security risk posed by HTML Macros, because:
- It only renders CSS
- It can only be modified/inserted by administrators
However, changes to stylesheets have a space-wide or global impact to Confluence, and the stylesheet cannot be confined to just a single page. (Unlike HTML Macros that allow you to insert the script/stylesheet to just a single page).
Unlike Global/Space Stylesheets, Custom HTML only has a global configuration, at
Confluence Administration >> Look and Feel >> Custom HTML.
So all changes made here will be applied globally. There is no way at all to confine this to a single page.
Solution: User Macros
The safest alternative to the three options above is User Macros, which can be easily created via
Confluence Administration >> User Macros.
User Macros are:
- Safer - Only Confluence Administrators can define User Macros in the Global Administration Settings
- Configurable - Confluence Administrators can configure the user macro's visibility (in the macro browser) to be visible to all users, or only System Administrators
Here are a few examples of what you can do with User Macros.
Allows users to search for child pages of the current page:
It takes one argument: which is the Placeholder value (see the "Search Staffing" example above)
|Visibility||Visible to all users in the Macro Browser|
|Macro Title||Search Child Pages|
|Macro Body Processing||Rendered|
The example above shows a simple User Macro that allows you to style the default Page Tree Search macro (which doesn't fit our design sketch initially), with:
And, in addition to that, the User Macro also takes in a parameter (or a set of parameters, if you desire) that users can add when inserting the macro. These parameters can be used to alter the final output, as in the example here where we determine the value of the Placeholder via the user's input.
And finally, User Macros are also able to render Confluence Macros, as you can see from this example:
(I actually use this to render virtually all macros imaginable on the Confluence sidebar - note that Confluence's sidebar usually only takes Wiki Markup macros - More on this in future blogs)
Hope you found this information to be helpful; if so, please let us know in the comments section.
As an authorized training partner, ServiceRocket has provided official Atlassian courses to over 50,000 Atlassian product admins, users and power users. We're ready to help your team drive software adoption and the effective use of technology.
We've got your back.
Build expert proficiency faster with ServiceRocket's Atlassian Training