Documentation for Confluence 5.7.
Documentation for Confluence Cloud and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata
The Confluence page gadget allows you to show content from a page on your Confluence site in a gadget. You can optionally configure the gadget to display links to view and/or edit the page on your Confluence site. The page gadget can also be displayed in canvas view, so that it takes up all of the space provided by your dashboard.

(info) For instructions on how to use Confluence gadgets in your applications, please see Confluence Gadgets.

Macros that work with the page gadget

Please note, not all macros work with the page gadget. Please refer to the Working Macros section below for more information.

On this page:

Related pages:

Screenshot: The Confluence page gadget displaying a sample page


Confluence Page Gadget Properties

Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget.

Property

Required?

Default

Description

Space

No

None

Specify the space that your desired page is located in. Suggestions will display in a dropdown when you start typing.
(Note, this property is only used to make searching for pages easier. It is not required.)

Page

Yes

None

Specify the page that you want to display in your gadget. Suggestions will display in a dropdown when you start typing.

Show View Link

No

Yes

Select whether to display a link to view the page on your Confluence site. Clicking the link will open the page in Confluence.

Show Edit Link

No

No

Select whether to display a link to edit the page on your Confluence site. Clicking the link will open the page for editing in Confluence.

Refresh Interval

No

Never/false

Specify the time interval between each 'refresh' action undertaken by the page gadget. A refresh makes the activity stream gadget reflect any new activity that has been conducted on the Confluence site.

Working Macros

The Confluence page gadget will only render a subset of the macros that are used in Confluence correctly. Refer to the table below for the list of macros that work and do not work with the page gadget and known limitations.

Some of the issues with macros in the page gadget can be worked around, if you are comfortable developing in Confluence. Please see Troubleshooting Macros in the Page Gadget for more information.

Key:
(tick) Works with the page gadget
(tick) * Partially works with the page gadget
(error) Does not work with the page gadget

Macro

Works with page gadget?

Limitations

Activity Stream

(error)

You cannot have another gadget embedded within the Confluence Page Gadget

Anchor (within a page)

(tick) *

Opens in a new page

Attachments

(tick)

N/A

Blog Posts

(tick)

N/A

Chart

(tick)

N/A

Children Display

(tick)

N/A

Content By Label

(tick)

N/A

Content By User

(tick)

N/A

Excerpt

(tick)

N/A

Gallery

(tick)

N/A

Include Page

(tick)

N/A

Info

(tick)

N/A

Labels List

(tick)

N/A

Livesearch

(error)

N/A

Note

(tick)

N/A

Metadata

(tick)

N/A

Metadata Summary

(tick)

N/A

Pagetree Search

(error)

N/A

Pagetree

(tick)

N/A

Panel

(tick)

N/A

Quick Nav

(error)

You cannot have another gadget embedded within the Confluence Page Gadget

Recently Updated

(tick)

N/A

RSS Feed

(tick)

N/A

Section & Column

(tick)

N/A

Spaces List

(tick)

N/A

Table of Contents

(tick) *

Works, however links will be opened in a new browser window when clicked.

Team Calendars(error)

See here for the Improvement Request:

TEAMCAL-862 - Make Team Calendars display in a Confluence Page Gadget, for use on a JIRA Dashboard Reopened

View File (PDF or PPT)

(tick) *

Works, but you may need to refresh the gadget the first time (see CONF-19932).

Widget Connector

(tick) *

Only works for some content:

  • Works: blip.tv, Episodic, Flickr, Google Calendar, presentations on Google Docs, MySpace Video, Scribd, Skitch.com, SlideRocket, SlideShare, Viddler, Vimeo, YouTube, Dailymotion, Metacafe, FriendFeed, Yahoo Video, Wufoo HTML Form Builder
  • Does not work: FriendFeed, Google Gadgets, Google Video (consumer service discontinued), Twitter, Widgetbox, DabbleDB, BackType
  • No labels

5 Comments

  1. There may also be an issue with the Team Calendar's Macro working within the page gadget. I'm seeing a fair number of these:

    120313:2013-11-25 08:01:13,838 ERROR [http-8090-62] [xhtml.view.macro.ViewMacroMarshaller] marshal Exception executing macro: gadget, with message: You cannot view a Gadget inside the Page Gadget.

    120315:2013-11-25 08:01:13,971 ERROR [http-8090-98] [xhtml.view.macro.ViewMacroMarshaller] marshal Error rendering macro: calendar

     

     

  2. Exporting a page with the page gadget just shows as a string of code. Is there a way to make it so that it exports as an image on the page? This is a very limiting aspect of this otherwise great macro.

    1. Hi Alice, sorry gadgets do not export very well. There is an explanation of why, and some workaround suggestions in this issue.  CONF-17953 - Exporting a page as PDF having gadgets doesn't display the content properly Resolved .

  3. Is there a way to have an "auto height" or "height change" available for the Page Gadget?

    1. Hi Jonathan,

      Unfortunately no, there's no way to adjust the height via the UI. You could try using an include page macro, or ask over at answers to see if anyone else has any helpful ideas.