Notation Guide

Print Help Tips
External Content

Ways to include, summarise or refer to content from other servers.

Notation Comment
{jiraissues:url=http://jira.xml.url}

{jiraissues:url=http://jira.xml.url|
columns=type;key;summary}

{jiraissues:url=http://jira.xml.url|
count=true}

{jiraissues:url=http://jira.xml.url|
cache=off}

{jiraissues:url=http://jira.xml.url?
os_username=johnsmith&os_password=secret}

{jiraissues:url=http://jira.xml.url|
anonymous=true}
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details.

To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters.

You can control how wide the {jiraissues} macro renders by specifying a width parameter. To specify the width in percentage, use width=XX%. To specify the width in pixels, use width=XXpx. If unspecified, the width will be 100%.

Not specifying columns will lead into the default column list and order.

Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, status, resolution.

Specifying count=true will cause the macro to just print out how many issues were in the list, without printing the list.

Using cache=off will force the macro to refresh its internal cache of Jira issues.

Note: Certain filters may require a logged-in user in order to work. If a trust association has been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your jira issues URL.

You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously.

Example:

Atlassian JIRA (This file is an XML representation of some issues)
Key Summary Assignee Status Res Updated
TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

{jiraissues:url=http://jira.xml.url}

{jiraissues:url=http://jira.xml.url|
columns=type;key;summary}

{jiraissues:url=http://jira.xml.url|
count=true}

{jiraissues:url=http://jira.xml.url|
cache=off}

{jiraissues:url=http://jira.xml.url?
os_username=johnsmith&os_password=secret}

{jiraissues:url=http://jira.xml.url|
anonymous=true}
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details.

To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters.

You can control how wide the {jiraissues} macro renders by specifying a width parameter. To specify the width in percentage, use width=XX%. To specify the width in pixels, use width=XXpx. If unspecified, the width will be 100%.

Not specifying columns will lead into the default column list and order.

Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, status, resolution.

Specifying count=true will cause the macro to just print out how many issues were in the list, without printing the list.

Using cache=off will force the macro to refresh its internal cache of Jira issues.

Note: Certain filters may require a logged-in user in order to work. If a trust association has been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your jira issues URL.

You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously.

Example:

Atlassian JIRA (This file is an XML representation of some issues)
Key Summary Assignee Status Res Updated
TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

{jiraportlet:url=http://jira.portlet.url} Imports and displays JIRA 3 portlet into a Confluence page.

You can get the URL for the portlet by configuring the portlet into your JIRA dashboard. While in configuration mode, you can copy the portlet URL from the top of the portlet display.

Note: Certain filters may require a logged-in user in order to work. Hence you may need to append:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your portlet url.

{collapsiblerss}

Displays an rss feed within a page that can be hidden (by each user) until there is a new item to display.

  • url the url of the feed to display
  • maxItems (optional) the maximum number of feed entries to display.
  • showTitlesOnly (optional) If true only the feed titles will be displayed, defaults to false.

{im:myscreenname|service=AIM}
{im:me@hotmail.com|service=MSN|showid=false}

Displays a graphic indication of whether an IM user is online. You must supply a valid user ID as the default argument and the desired service.

Parameters

  • (default) - The user id/screen name.
  • service - The name of the service to check. May be 'aim', 'gtalk', 'icq', 'jabber', 'msn', 'sametime', 'skype', 'wildfire' or 'yahoo'.
  • showid - (optional) If 'false', the user's id will not be shown.

{slide-share:id=123456|doc=some-doc-here-1234567890123456-7|align=left}

{slide-share:id=123456|doc=some-doc-here-1234567890123456-7|align=center}
You can upload your PowerPoint, OpenOffice and PDF Presentations to SlideShare ( http://www.slideshare.net/ ) and use this Macro to view it Embed in your Confluence pages.

Copy Embed in your blog code and fill its first div's id to first parameter of this macro and embed tags src atribute url's doc to doc parameter.
{you-tube:id=123456|align=left}

{you-tube:id=123456|align=center}
View your YouTube http://www.youtube.com/ videos. But video id to id.
{scribd:id=1234565|doc=doc_123456789000000|key=key-someacceskeyhere
|ver=1|page=1|height=500|width=450|name=doc_123456789000000_object|align=center}

{scribd:id=1234565|doc=doc_123456789000000|key=key-someacceskeyhere
|ver=1|page=1|height=500|width=450|name=doc_123456789000000_object|align=left}
You can upload your file as Word, PDF, plain text, HTML, JPEG, PowerPoint, Excel, Postscript, LIT, and even audio format to Scribd ( http://www.scribd.com/ ) and use this Macro to view it Embed in your Confluence pages.
Remove line break before |ver=

Params
doc = doc_123456789000000
id = 1234565
ver = default 1
key = key-someacceskeyhere
page = default 1
align = left|center|right
height = default 500
width = default 450
name = doc_123456789000000_object
{junitreport:directory=file:///c:/test-reports}
(currently only picks up result files in XML format. Set ant formatter to "xml")

{junitreport:url=file:///test-reports/TestRep.xml}
Displays the results of a series (or single) JUnit test.

Success Rate Tests Failures Time(s) Time(s)
93%
14 1 0 1.531

{rss:url=http://host.com/rss.xml}

{rss:url=http://host.com/rss.xml|max=5}

{rss:url=http://host.com/rss.xml|showTitlesOnly=true}

Display the contents of a remote RSS feed within the page. Note: feeds are cached for 60 minutes before being retrieved again.

The 'max' parameter can be used to limit the number of entries displayed.

Example:

Sample RSS Feed (RSS 2.0)
(Feed description here...)
My Item ( Dec 30, 2003 06:53)
And part of the item content here...
Another Item ( Dec 30, 2003 06:53)
And part of the item content here...

You can specify 'showTitlesOnly=true' to show only the RSS feed titles. This parameter defaults to false.

You can specify 'titleBar=false' to hide the feeds titlebar. This parameter defaults to true.

You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {rss:url=http://example.com/path/to/target/location}. This parameter defaults to true.

{visio:^diagram.vsd}

{visio:page^diagram.vsd|height=400|bgColor=silver}

{visio:space:page^diagram.vsd|page=true|pageTab=true|toolbar=true}

{visio:file=space:page^diagram.vsd|pageIndex=2|zoom=.5}

Displays a Visio diagram on a Confluence page. Diagram must be attached to a Confluence page. The user must have view permission to the page the attachment in on. This uses an IE Visio viewer control and needs IE, IE Tab in Firefox, or IE Tab in Chrome for rendering. The Visio viewer browser control is required and will be installed on first use based on user acceptance.

  • file - A required parameter that is equivalent to the default parameter. It specifies the location of the Visio file.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • width - The width of the Visio diagram in pixels or percent. Default is 100%.
  • height - The height of the Visio diagram in pixels. Default is 700.
  • bgColor - Background color of the diagram. Default is 'white'. See Colors.
  • pageView - Show Visio page view. Default is 'false'.
  • pageColor - Page color shown in page view. Default is 'silver'. See Colors.
  • grid - Grid is shown in page view. Default is 'false'.
  • pageTabs - Show Visio page tabs. Default is 'false'.
  • pageIndex - Initial page number to show. Default is '0' to show page when diagram was saved.
  • scrollBars - Show diagram scroll bars. Default is 'false'.
  • toolbar - Show toolbar. Default is 'false'.
  • contextMenu - Allows showing of viewer control menu with right click. Default is 'true'.
  • propertyDialog - Allows showing of the properties dialog from the context menu. Default is 'true'.
  • zoom - Zoom value. Default is '-1'. Specify a zoom percentage as a fraction (for example, 0.5 for 50% and 1.0 for 100%) or use any of the following values:
    • -1 = Whole page view
    • -2 = Page width view
    • -3 = Last zoom percentage
  • highQuality - Show diagram in highest quality (slower to display). Default is 'true'.
  • alerts - Show viewer control errors. Default is 'true'.
  • ieMessage - Message to display when IE render is not available to show the diagram. Use blank to not show a message. Otherwise a default message will show.
  • codebase - Advanced users only. Allows customization of the Microsoft Visio Viewer control being used.
{google-calendar}
http://www.google.com/calendar/feeds/rAndOmleTT3r5g0h3r3@group.calendar.google.com/public/basic http://www.google.com/calendar/ical/m0r3raNd0ml3tTer5@group.calendar.google.com/public/basic.ics {google-calendar}

Displays the specified Google Calendars in Confluence. Any of the standard Google calendar links (XML, ICAL, HTML) will work. You can have multiple calendars listed, one per line. You can also comment lines out by prefixing them with '//'.

Parameters

  • mode - The mode the calendar is in. Either 'month', 'week', or 'agenda'. Defaults to 'month'.
  • controls - The controls to show. Either 'all' (which displays Title, Navigation buttons, Date, Print icon, Tabs, Calendar list, Time zone), 'navigation' (which displays just the navigation button and Date) or 'none'. Defaults to 'navigation'.
  • title - The title to display. Only visible when controls is set to 'all'. Defaults to the name of the calendar.
  • width - The width of the calendar in either pixels ('500' - no 'px') or percentage ('100%'). Defaults to 100%
  • height - The height of the calendar in pixels ('600' - no 'px'). Defaults to '610'.
  • bgcolor - The background color of the calendar. Defaults to '#FFFFFF'.
  • firstDay - The first day of the week. Eg. 'Monday'. Defaults to 'Sunday'.
  • colors - A comma-separated list of colors for events, listed in the same order the calendars appear in the macro body. Colors must be one of the following values: Must be one of the following hexadecimal RGB color values:
    #A32929 #B1365F #7A367A #5229A3
    #29527A #2952A3 #1B887A #28754E
    #0D7813 #528800 #88880E #AB8B00
    #BE6D00 #B1440E #865A5A #705770
    #4E5D6C #5A6986 #4A716C #6E6E41
    #8D6F47 #853104 #691426 #5C1158
    #23164E #182C57 #060D5E #125A12
    #2F6213 #2F6309 #5F6B02 #8C500B
    #8C500B #754916 #6B3304 #5B123B
    #42104A #113F47 #333333 #0F4B38
    #856508 #711616 &nbps;