Confluence 4.2 has reached end of life
Check out the [latest version] of the documentation
The Widget macro, or Widget Connector, allows you to embed certain multimedia content from other web sites into your Confluence page.
It supports the following content:
- Gadgets and other widgets: Google Gadgets, Widgetbox.
- Videos: YouTube, MySpace Video, Yahoo Video, Dailymotion, Episodic, Vimeo, Metacafe, blip.tv, Viddler.
- Photos and images: Flickr, Skitch.com.
- Micro-blogging: Twitter, FriendFeed, BackType.
- Documents and presentations: SlideShare, SlideRocket, Scribd, presentations on Google Docs.
- Calendars: Google Calendar.
- Forms and online databases: Wufoo HTML Form Builder, Dabble DB.
- Support and customer satisfaction: Get Satisfaction.
There are live examples of many of these on the widget examples page. If you wish to extend the functionality of this plugin, please see Extending the Widget Connector.
On this page:
Using the Widget Connector
To add the Widget Connector to a page:
Speeding up macro entry with autocomplete: To edit an existing macro: Click the macro placeholder and choose Edit. This will display the parameters of the macro in the Macro Browser.
Parameters
Parameters are options that you can set to control the content or format of the macro output.
Parameter | Description |
---|---|
Web Site's Widget URL | This is the URL provided by the external web site for embedding content from that web site onto another web page. |
Pixel Height (Value Only) | Specify the height of the display, in pixels. |
Pixel Width (Value Only) | Specify the width of the display, in pixels. |
Live Example of Flickr Photos
This example displays all photos from Flickr with the tag 'Atlassian'. It uses this URL: http://www.flickr.com/photos/tags/atlassian/
Live Example of Google Gadget
This example lets you play with a Google Gadget, Gadzi's Monkey Virtual Pet. It uses this URL: http://www.google.com/ig/directory?synd=open&num=24&url=http://www.gadzi.com/gadgets/monkey.xml&output=html
More Examples of Macro Code
Google Gadgets
You need to find the URL for the Google Gadget you want to display.
Here is one way to find a gadget's URL:
- Go to the Google Gadgets directory.
- Find the gadget you want then click its name, such as 'Spider'.
The gadget's summary page will open. Copy the URL from your browser's address bar. The URL looks something like this one:
http://www.google.com/ig/directory?synd=open&num=24&url=http://abowman.googlepages.com/spider.xml&output=html
You can also use the URL of the 'add gadget' page. The page is called 'Add "gadgetx" to your iGoogle page':
- There are a couple of ways to get to the 'add gadget' page:
- Click a '+Google' button underneath the gadget when displayed on a page somewhere.
- Or click 'Add Stuff' on your iGoogle page.
Copy the URL from your browser's address bar. The URL would look something like this one:
http://www.google.com/ig/adde?synd=open&source=ggyp&moduleurl=abowman.googlepages.com/spider.xml
Widgetbox widgets
You will need to find the URL for the Widgetbox widget you want to display.
Here is one way to find a widget's URL:
- Ensure you are logged in to Widgetbox and that you are viewing the Widgetbox Gallery.
- Find the widget you want then click its name, such as 'cyber-pet'.
- The widget's summary page will open. Within the Get Widget section, click the Atlassian Confluence icon
If you cannot see this icon, click the more... link to reveal it.
. The Widgetbox Add to Confluence dialog box appears, containing the URL required for the Widget Macro. - In the Widgetbox Add to Confluence dialog box, click Copy.
Copy the URL from your browser's address bar. The URL looks something like this one:
http://widgetbox.com/confluence/b8327e33-c8eb-4a38-b842-fba866ffdd28
YouTube
You will need to find the URL for the YouTube video that you want to display.
To find a YouTube video's URL:
- Go to YouTube and search for the video you want.
- Click the title of the video, such as 'Wikis in Plain English'.
The video's summary page will open. Copy the URL from your browser's address bar. The URL looks something like this one:
http://au.youtube.com/watch?v=-dnL00TdmLY
MySpace Videos
You will need to find the URL for the MySpace video that you want to display.
To find a MySpace video's URL:
- Go to MySpace Video and search for the video you want.
- Click the title of the video, such as 'Glacier Creek Confluence Time Lapse'.
The video's summary page will open. Copy the URL from your browser's address bar. The URL looks something like this one:
http://vids.myspace.com/index.cfm?fuseaction=vids.individual&videoid=3376248&searchid=20c789f6-1ae9-459a-bfec-75efcfc2847c
Yahoo Video
You will need to find the URL for the Yahoo video that you want to display.
To find a Yahoo video's URL:
- Go to Yahoo Video and search for the video you want.
- Click the title of the video, such as 'Wiki Technology Trend: Past, Now and Future'.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this:
http://video.yahoo.com/watch/423158/2424140
If you are unable to obtain a unique URL from your browser's address bar, click the envelope (Share) icon on the lower section of the video screen and copy the contents of the Link field.
Dailymotion Video
You will need to find the URL for the Dailymotion video that you want to display.
To find a Dailymotion video's URL:
- Go to Dailymotion and search for the video you want.
- Click the title of the video, such as 'Wiki Technology Trend: Past, Now and Future'.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this:
http://www.dailymotion.com/user/spacevidcast/video/x7zevj_spacevidcast-2009-promo-video_tech
If you are unable to obtain a unique URL from your browser's address bar, click Menu at the lower right section of the video screen, select URL & Embed Code and copy the contents of the Link field.
Episodic
You will need an Episodic user account if you want to create and distribute videos via Episodic.
To embed an Episodic video onto a Confluence page:
Find the video and copy the URL from the address bar of your browser. The URL looks something like this:
http://app.episodic.com/shows/13/episodes/493
- Paste the URL into the Web Site's Widget URL box in the Macro Browser.
Vimeo
You will need to find the URL for the Vimeo video that you want to display.
To find a Vimeo video's URL:
- Go to Vimeo and search for the video you want.
- Click the title of the video, such as 'The Wiki Show - Allison the Russian High Kicker'.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://www.vimeo.com/909808
Metacafe
You will need to find the URL for the Metacafe video that you want to display.
To find a Metacafe video's URL:
- Go to Metacafe and search for the video you want.
- Click the title of the video, such as 'Wikis In Plain English (How To)'.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://www.metacafe.com/watch/679493/wikis_in_plain_english_how_to/
blip.tv
You will need to find the URL for the blip.tv video that you want to display.
To find a blip.tv video's URL:
- Go to blip.tv and search for the video you want.
- Click the title of the video, such as 'River cruising on the Rhine'.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://blip.tv/file/996864/
Viddler
You will need to find the URL for the Viddler video that you want to display.
To find a Viddler video's URL:
- Go to Viddler and search for the video you want.
- Click the title of the video.
The video's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://www.viddler.com/explore/Markus_Z/videos/1/
Flickr
You can embed a slide show of photos from Flickr by supplying a URL that specifies one of the following:
- Photos with a specific tag.
- Photos belonging to the photostream of a specific Flickr user.
- A set of photos as defined by the Flickr user.
- A user's photostream starting at a specific photo.
If you want to do something else, we suggest that you try any Flickr URL. It should work.
Below are some examples of the Widget macro code for embedding Flickr images.
Flickr Photos with a Specific Tag
This URL displays a slide show of Flickr photos that are tagged with the word 'Atlassian' http://www.flickr.com/photos/tags/atlassian/
Flickr Photos from a Specific User
This URL displays a slide show of photos from the Flickr photostream of user 'Atlassian': http://www.flickr.com/photos/atlassian/
Flickr Photos from a Specific Set
This URL displays a slide show of Flickr photos from the set 'Melbourne Cup - November 2008' created by user 'Atlassian': http://www.flickr.com/photos/atlassian/sets/72157608657271078/
A Specific Flickr Photo
This URL displays a slide show of photos from the Flickr photostream of the user 'Atlassian', starting with a specific photo: http://www.flickr.com/photos/atlassian/3003538919/
Skitch.com
You will need to find the URL for the Skitch image that you want to display.
To embed a Skitch image onto a Confluence page:
- Go to Skitch.com.
Find the image and copy the URL from the address bar of your browser. The URL looks something like this:
http://skitch.com/atlassian/411g/example-image
Use a Twitter link in the Widget macro to display a dynamic list of the latest tweets sent by a user or matching a Twitter search.
To display the latest messages from a Twitter user, add the user's Twitter link as the URL in the Widget macro.
http://twitter.com/username
This URL will display Mike Cannon-Brooke's Twitter messages: http://twitter.com/mcannonbrookes
To display the latest messages resulting from a Twitter search, add the Twitter search link as a URL in the Widget macro.
Make sure you use the supported format of the search URL:
http://search.twitter.com/search?q=my search term
The following format is notsupported:
http://twitter.com/#search?q=my search term
- The '#' tag is not supported (not even in its URL-encoded form
%23
).
This URL will display the most recent tweets containing the word 'AtlassianDragons': http://search.twitter.com/search?q=AtlassianDragons
FriendFeed
To display the latest messages from a FriendFeed user, add the user's FriendFeed link as the URL in the Widget macro. For example:
BackType
To display the latest blog or website comments from a BackType user, add the user's BackType widget link as the URL in the Widget macro. For example:
SlideShare
You will need to find the URL for the SlideShare presentation that you want to display.
To find a SlideShare presentation's URL:
- Go to SlideShare and search for the presentation you want.
- Click the title of the presentation, such as 'Using JIRA & Greenhopper for Agile Development'.
The presentation's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://www.slideshare.net/jleyser/using-jira-greenhopper-for-agile-development-presentation
SlideRocket
You will need to find the URL for the SlideRocket presentation that you want to display.
To find a SlideRocket presentation's URL:
- Log in to SlideRocket and go to your library of presentations.
Copy the 'web link' for the presentation you want to display. This will give you a URL that looks something like this one:
http://app.sliderocket.com/app/FullPlayer.aspx?id=132f9db7-b0fb-4f51-b974-36652774971b
- Paste the URL into the Widget macro code on your Confluence page.
Scribd
You will need to find the URL for the Scribd presentation that you want to display.
To find a Scribd presentation's URL:
- Go to Scribd and search for the presentation you want.
- Click the title of the presentation, such as 'My Sea Friends Coloring Book'.
The presentation's summary page will open. Copy the URL from the address bar of your browser. The URL looks something like this one:
http://www.scribd.com/doc/5683554/My-Sea-Friends-Coloring-Book
- Paste the URL into the Widget macro code on your Confluence page.
Google Docs Presentations
You can embed presentations from Google Docs, but not other document types. You will need to find the URL for the Google Docs presentation that you want to display.
To find the URL of a Google Docs presentation:
- Publish your presentation in Google Docs.
View your published document, then copy the URL from your browser's address bar. The URL will look something like this:
http://docs.google.com/Presentation?docid=ddpqn8g5_0fx96zmmq&mm=en_GB
- Paste the URL into the Widget macro code on your Confluence page.
Google Calendar
You can embed a Google Calendar into your page and to do this, you will need to add the URL for the Google Calendar that you want to display.
To find the URL for a Google Calendar:
- Log in to Google Calendar.
- In the calendar list on the left side of the page, ensure the appropriate calendar is selected, click the down-arrow button next to the calendar name and then select the Calendar settings option.
(Alternatively, if available, click the Manage Calendars link at the bottom of the calendar list and then click the name of the appropriate calendar.) - In the Calendar Address section, click the HTML button. A pop-up message with your calendar's public URL appears.
Copy the URL from this pop-up message. The URL looks something like this:
http://www.google.com/calendar/embed?src=somebody%40example.com&ctz=Australia/Sydney
- Paste the URL into the Widget macro code on your Confluence page.
Wufoo HTML Form Builder
To display an HTML form built in the Wufoo HTML Form Builder, add the form's link as a URL to the Widget Macro. For example:
http://examples.wufoo.com/forms/contact-form/
Dabble DB online database builder
To display a shared page built in Dabble DB, add the page's link as a URL to the Widget Macro. For example:
https://confluence-sample.dabbledb.com/page/confluence-sample/nSQqdgIg
The Widget Macro supports shared Dabble DB view and form pages. You can insert a Dabble DB data entry form into a Confluence page. On the same page or another page, you can use a a Dabble DB view to display data submitted via the form.
Get Satisfaction social support application
To display a feedback form for a Get Satisfaction community, add the community or company link as a URL to the Widget Macro. For example:
http://getsatisfaction.com/atlassian
Troubleshooting
If the URL given in the Widget Connector macro does not work, the macro displays an icon and the base URL.
For example, the following code:
http://example.com/invalid
will result in an image like the one below:
Related Topics
Take me back to the Confluence User's Guide.