Confluence Docs 3.3 : Widget Macro
This page last changed on Mar 11, 2010 by alui.
The Widget macro, or Widget Connector, allows you to embed multi-media content from other web sites into your Confluence page. It supports content such as:
On this page: Usage with the Macro BrowserTo insert the Widget macro into a page using the Macro Browser,
Once you've found the Widget macro and have added the required parameter values, click 'insert' to add it to your page. Usage with the Wiki Markup EditorJust type the word 'widget' in curly brackets, and give it the URL (web address) of the thing you want to display. {widget:url=http://example.com/my-location} If the web-widget alias is enabled on your Confluence site, you can use web-widget instead of widget. See below. ParametersParameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro. Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).
Live Example of Flickr PhotosThis example shows the Widget macro in action. It displays all photos from Flickr with the tag 'Atlassian'. What You Need to Type{widget:url=http://www.flickr.com/photos/tags/atlassian} What You Will GetLive Example of Google GadgetThis example shows the Widget macro in action. It lets you play with a Google Gadget, Gadzi's Monkey Virtual Pet. What You Need to Type{widget:url=http://www.google.com/ig/adde?synd=open&source=ggyp&moduleurl=www.gadzi.com/gadgets/monkey.xml|width=250} What You Will GetMore Examples of Macro CodeGoogle GadgetsYou will need to find the URL for the Google Gadget you want to display. Here is one way to find a gadget's URL:
You can also use the URL of the 'add gadget' page. The page is called 'Add "gadgetx" to your iGoogle page':
Here is an example of the Widget macro code for embedding a Google Gadget: {widget:url=http://www.google.com/ig/adde?synd=open&source=ggyp&moduleurl=abowman.googlepages.com/spider.xml} Widgetbox widgetsYou will need to find the URL for the Widgetbox widget you want to display. Here is one way to find a widget's URL:
Here is an example of the Widget macro code for embedding a Widgetbox widget: {widget:url=http://widgetbox.com/confluence/b8327e33-c8eb-4a38-b842-fba866ffdd28} YouTubeYou will need to find the URL for the YouTube video that you want to display. To find a YouTube video's URL:
Here is an example of the Widget macro code for embedding a YouTube video: {widget:url=http://au.youtube.com/watch?v=-dnL00TdmLY} MySpace VideosYou will need to find the URL for the MySpace video that you want to display. To find a MySpace video's URL:
Here is an example of the Widget macro code for embedding a MySpace video: {widget:url=http://vids.myspace.com/index.cfm?fuseaction=vids.individual&videoid=3376248&searchid=20c789f6-1ae9-459a-bfec-75efcfc2847c} Google VideoYou will need to find the URL for the Google video that you want to display. To find a Google video's URL:
Here is an example of the Widget macro code for embedding a Google video: {widget:url=http://video.google.com/videoplay?docid=-7739076742312910146&ei=nJAfSbrzPIWOwgOhv_GKDA&q=An+Evening+With+Wiki+Inventor+Ward+Cunningham+in+Conversation&emb=1} Yahoo VideoYou will need to find the URL for the Yahoo video that you want to display. To find a Yahoo video's URL:
Here is an example of the Widget macro code for embedding a Yahoo video: {widget:url=http://video.yahoo.com/watch/423158/2424140} Dailymotion VideoYou will need to find the URL for the Dailymotion video that you want to display. To find a Dailymotion video's URL:
Here is an example of the Widget macro code for embedding a Dailymotion video: {widget:http://www.dailymotion.com/user/spacevidcast/video/x7zevj_spacevidcast-2009-promo-video_tech} EpisodicYou 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:
Here is an example of the Widget macro code for embedding an Episodic video: {widget:url=http://app.episodic.com/shows/13/episodes/493} VimeoYou will need to find the URL for the Vimeo video that you want to display. To find a Vimeo video's URL:
Here is an example of the Widget macro code for embedding a Vimeo video: {widget:url=http://www.vimeo.com/909808} MetacafeYou will need to find the URL for the Metacafe video that you want to display. To find a Metacafe video's URL:
Here is an example of the Widget macro code for embedding a Metacafe video: {widget:url=http://www.metacafe.com/watch/679493/wikis_in_plain_english_how_to/} blip.tvYou will need to find the URL for the blip.tv video that you want to display. To find a blip.tv video's URL:
Here is an example of the Widget macro code for embedding a blip.tv video: {widget:url=http://blip.tv/file/996864/} ViddlerYou will need to find the URL for the Viddler video that you want to display. To find a Viddler video's URL:
Here is an example of the Widget macro code for embedding a Viddler video: {widget:url=http://www.viddler.com/explore/Markus_Z/videos/1/} FlickrYou can embed a slide show of photos from Flickr by supplying a URL that specifies one of the following:
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 TagThis example displays a slide show of Flickr photos that are tagged with the word 'Atlassian'. {widget:url=http://www.flickr.com/photos/tags/atlassian/} Flickr Photos from a Specific UserThis example displays a slide show of photos from the Flickr photostream of user 'Atlassian'. {widget:url=http://www.flickr.com/photos/atlassian/} Flickr Photos from a Specific SetThis example displays a slide show of Flickr photos from the set 'Melbourne Cup - November 2008' created by user 'Atlassian'. {widget:url=http://www.flickr.com/photos/atlassian/sets/72157608657271078/} A Specific Flickr PhotoThis example displays a slide show of photos from the Flickr photostream of the user 'Atlassian', starting with a specific photo. {widget:url=http://www.flickr.com/photos/atlassian/3003538919/} Skitch.comYou will need to find the URL for the Skitch image that you want to display. To embed a Skitch image onto a Confluence page:
Here is an example of the Widget macro code for embedding a Skitch image: {widget:url=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 a URL in the Widget macro. {widget:url=http://twitter.com/username} The example below will display Mike Cannon-Brooke's Twitter messages: {widget:url=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.
Format: {widget:url=http://search.twitter.com/search?q=my search term} The example below will display the most recent tweets containing the word 'AtlassianDragons': {widget:url=http://search.twitter.com/search?q=AtlassianDragons} FriendFeedTo display the latest messages from a FriendFeed user, add the user's FriendFeed link as a URL in the Widget macro. For example: {widget:url=http://friendfeed.com/myname} BackTypeTo display the latest blog or website comments from a BackType user, add the user's BackType widget link as a URL in the Widget macro. For example: {widget:url=http://www.backtype.com/myname} SlideShareYou will need to find the URL for the SlideShare presentation that you want to display. To find a SlideShare presentation's URL:
Here is an example of the Widget macro code for embedding a SlideShare presentation: {widget:url=http://www.slideshare.net/jleyser/using-jira-greenhopper-for-agile-development-presentation} SlideRocketYou will need to find the URL for the SlideRocket presentation that you want to display. To find a SlideRocket presentation's URL:
Here is an example of the Widget macro code for embedding a SlideRocket presentation: {widget:url=http://app.sliderocket.com/app/FullPlayer.aspx?id=132f9db7-b0fb-4f51-b974-36652774971b} ScribdYou will need to find the URL for the Scribd presentation that you want to display. To find a Scribd presentation's URL:
Here is an example of the Widget macro code for embedding a Scribd presentation and displaying it with a height of 600 pixels: {widget:url=http://www.scribd.com/doc/5683554/My-Sea-Friends-Coloring-Book|height=600px} Google Docs PresentationsYou 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:
Here is an example of the Widget macro code for embedding a Google Docs presentation {widget:url=http://docs.google.com/Presentation?docid=ddpqn8g5_0fx96zmmq&mm=en_GB} Google CalendarYou 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:
Here is an example of the Widget macro code for embedding a Google Calendar: {widget:url=http://www.google.com/calendar/embed?src=somebody%40example.com&ctz=Australia/Sydney} Wufoo HTML Form BuilderTo 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: {widget:url=http://examples.wufoo.com/forms/contact-form/} Dabble DB online database builderTo display a shared page built in Dabble DB, add the page's link as a URL to the Widget Macro. For example: {widget:url=https://confluence-sample.dabbledb.com/page/confluence-sample/nSQqdgIg}
About the Web-Widget and Widget MacrosConfluence supports web-widget as an alias for widget. Your System Administrator can enable or disable one or both these macro names. The alias is useful for Confluence sites which use Adaptavist's Community Bubbles plugin, to avoid conflict with the 'widget' macro supplied by that plugin. If the web-widget alias is enabled on your Confluence site, you can use web-widget instead of widget in all the examples above. TroubleshootingIf the URL given in the Widget macro does not work, the Widget macro displays an icon and the base URL. The icon will be linked to the full URL given in the macro code. For example, the following code: {widget:url=http://example.com/invalid} will result in an image like the one below:
example.com
RELATED TOPICSTake me back to the Confluence User's Guide. |
![]() |
Document generated by Confluence on Jul 09, 2010 01:08 |