Using Standard Page Decorators

Purpose of the Standard Page Decorators

Atlassian applications support standard page decorators, allowing your plugin to generate new web pages with consistent decoration by the host application across the Atlassian products.

Specifying a Decorator

Specify the decorator with an HTML meta tag in your head element:

<html>
  <head>
    <meta name="decorator" content="atl.general"/>
  </head>

The following decorators are available.

Decorator

Description

Version of Atlassian Plugin Framework

atl.admin

For application administration pages.

2.1 and later

atl.general

For the header and footer of general pages outside the administration UI.

2.1 and later

atl.popup

For content that you want placed in a new browser popup window.

2.3 and later

atl.userprofile

For content on a page in the user profile.
This decorator will generally be accompanied by a web item link or tab. The tab, if applicable, should be specified by the tab meta tag. For example:

<html>
  <head>
    <meta name="decorator" content="atl.userprofile"/>
    <meta name="tab" content="foo.bar">
  </head>
</html>

In the above example, the value of the content attribute is the ID of the tab. Since plugins can be shared among applications, we recommend that cross-application plugins define their own tab to ensure the same ID will be used everywhere.

Note: The profile decorator is still experimental. In some applications it may function in the same way as atl.general. Tabs are not yet supported by all Atlassian applications. If not supported, the tab will simply be ignored.

2.3 and later

Limitations on Standard Page Decoration in Confluence

In this version of Confluence, the standard page decorators are only available on the following URL patterns:

  • *.action
  • *.vm
  • /display/*
  • /label/*

Other URLs do not pass through the Sitemesh decoration filter, so the HTML they return will not be decorated.

RELATED TOPICS

Writing Confluence Plugins

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport