To insert the Widget macro into a page using the Macro Browser,
Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.
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 Editor
Just 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.
Parameters
Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.
Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).
Parameter
Required
Default
Description
Web Sites Widget URL
(url)
yes
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)
(height)
no
Specify the height of the display, in pixels (default) or as a percentage of the window's height. For example, to specify a height of 200 pixels:
Specify the width of the display, in pixels (default) or as a percentage of the window's width. For example, to specify a width and height of 200 pixels:
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 . The Widgetbox Add to Confluence dialog box appears, containing the URL required for the Widget Macro. If you cannot see this icon, click the more... link to reveal it.
In the Widgetbox Add to Confluence dialog box, click the Copy button.
Copy the URL from your browser's address bar. The URL looks something like this one:
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.
Paste the URL into the Widget macro code on your Confluence page.
Here is an example of the Widget macro code for embedding a Yahoo video:
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.
Paste the URL into the Widget macro code on your Confluence page.
Here is an example of the Widget macro code for embedding a Dailymotion video:
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/
Paste the URL into the Widget macro code on your Confluence page.
Here is an example of the Widget macro code for embedding a blip.tv video:
{widget:url=http://blip.tv/file/996864/}
The Widget Connector packaged with Confluence 3.0 currently possesses issues rendering blip.tv videos on Confluence pages. This problem has already been recorded in CONF-15667.
Viddler
You will need to find the URL for the Viddler video that you want to display.
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.
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:
The Widget Macro supports shared Dabble DB view and form pages. Hence, it is possible to insert a Dabble DB data entry form into a Confluence page. Any data submitted via this form can be displayed on the same or another page via a Dabble DB view.
About the Web-Widget and Widget Macros
Confluence 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.
Troubleshooting
If 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.