Download 1. Confluence User Guide

Confluence 3.0 Documentation
1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
2. Next, click the Macro Browser icon
on the editor toolbar. The Macro Browser will open in the middle of the screen.
3. 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 have found the JIRA portlet macro, paste your copied JIRA portlet URL into the JIRA Portlet URL field and then
click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
To insert the JIRA portlet macro into a page using the Wiki Markup editor,
1. Log in to your Confluence system.
2. Paste the copied JIRA portlet URL at the end of the url parameter in a {jiraportlet} macro on your Confluence
page.
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
JIRA Portlet
URL
(url)
yes
none
URL of the JIRA portlet, as described above.
Anonymous
Retrieval
(anonymous
)
no
false
For Confluence 2.7.0 and later. If this parameter is set to 'true', JIRA will return only the issues which
allow unrestricted viewing i.e. the issues which are visible to anonymous viewers, as determined by
JIRA's viewing restrictions. If this parameter is omitted or set to 'false', then the results depend on
how your administrator has configured the communication between JIRA and Confluence. By
default, Confluence will show only the JIRA issues which the user is authorised to view. See
more details below.
Base URL
(baseurl)
no
none
If Confluence retrieves the JIRA portlet from some other URL than JIRA's public URL, you should
supply JIRA's public URL in the baseurl parameter.
Certain JIRA portlets may require user authentication details in order to display their content.
Hence you may need to append:
&os_username=yourJiraUsername&os_password=yourJiraPassword to the end of this url.
Example
Below is an example of some macro markup code, requesting a portlet from the Atlassian public JIRA site:
{jiraportlet:anonymous=true|url=http:
//jira.atlassian.com/secure/RunPortlet.jspa?portletKey=com.atlassian.jira.plugin.system.portlets:projectstats&descr
Below are the results of the above macro markup, displayed on this Confluence page:
Statistics: Confluence (Fix For Versions (non-archived))
236
2.10.2
1
2.10.3
2
3.0
9
3.0.2
9
3.0.1
7
3.1 Milestone 1
6
Total Issues: 5,008