To create a header, place "hn. " at the start of the line (where n can be a number from 1-6).
Notation
Comment
h1. Biggest heading
Biggest heading
h2. Bigger heading
Bigger heading
h3. Big Heading
Big Heading
h4. Normal Heading
Normal Heading
h5. Small Heading
Small Heading
h6. Smallest Heading
Smallest Heading
Text Effects
Text effects are used to change the formatting of words and sentences.
Notation
Comment
*strong*
Makes text strong.
_emphasis_
Makes text emphasis.
??citation??
Makes text in citation.
-strikethrough-
Makes text as strikethrough.
+underlined+
Makes text as underlined.
^superscript^
Makes text in superscript.
~subscript~
Makes text in subscript.
{{text will be monospaced}}
Makes text as code text.
bq. Some block quoted text
To make an entire paragraph into a block quotation, place "bq. " before it.
Example:
Some block quoted text
{quote}
here is quoteable content to be quoted
{quote}
Quote a block of text that's longer than one paragraph.
Example:
here is quoteable content to be quoted
{color:red}
look ma, red text!
{color}
Changes the color of a block of text.
Example:
look ma, red text!
Text Breaks
Most of the time, explicit paragraph breaks are not required - Confluence will be able to paginate your paragraphs properly.
Notation
Comment
(empty line)
Produces a new paragraph
\\
Creates a line break. Not often needed, most of the time Confluence will guess new lines for you appropriately.
----
creates a horizontal ruler
---
Produces — symbol.
--
Produces – symbol.
Links
Links are the heart of Confluence, so learning how to create them quickly is important.
Notation
Comment
[#anchor]
[^attachment.ext]
or
[pagetitle]
[pagetitle#anchor]
[pagetitle^attachment.ext]
or
[spacekey:pagetitle]
[spacekey:pagetitle#anchor]
[spacekey:pagetitle^attachment.ext]
Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space). Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.
Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space) where the link text is different from the actual hyperlink link. Also you can have an optional link tip which will apear as tooltip. Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.
Creates an internal hyperlink to the specified blog post in the desired space (or the current one if you don't specify any space). You must specify the date the post was made in /year/month/day form as shown. Anchors and link text can be added the same way as described above.
If you attempt to link to a blog post that doesn't exist, no link will be created.
[/2004/01/12]
[spacekey:/2004/01/12]
or
[my link name|/2004/01/12]
[my link name|spacekey:/2004/01/12]
Creates an internal hyperlink to a view of a whole day's blog. Specify the date you wish to link to as year/month/day. Link titles can be supplied as with other links. It is possible to link to days with no blog posts on them: the destination page will just be empty.
Creates a link to the space homepage, or space summary page of a particular space. Which of these the link points to depends on the configuration of the space being linked to. If the space does not exist, the link will be drawn with a strike-through to indicate it is an invalid space.
Creates a link to the user profile page of a particular user. By default, will be drawn with a user icon and the user's full name, but if you supply a custom link text, the icon will not be drawn. If the user being linked to does not exist, the link will be drawn with a strike-through.
[phrase@shortcut]
[custom link text|phrase@shortcut]
Creates a shortcut link to the specified shortcut site. Shortcuts are configured by the site administrator. You can add a link title to shortcuts in the same manner as other links.
Creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space. External links are denoted with an arrow icon.
Note: the [] around external links are optional in the case you do not want to use any alias for the link.
Redirects the browser to the specified page or URL.
Note: To allow editing of a page once it has been redirected,
add '?redirect=false' to the query string.
[default]/location - (required) The page or URL to redirect to.
delay - (optional) The number of seconds to delay before redirecting.
visible - (optional, default is true) If set to 'false', the information panel will not be displayed.
Creates an alias for the current page. Any references to the alias will be redirected
to this page.
[default] - The alias. Must follow standard page naming conventions.
parent - (optional) The parent the alias should have. May be set to any page
in the current space. It will default to having no parent.
It may also be one of two special parent markers:
@self - the parent will be the page being aliased.
@parent - the parent will be the parent of the page being aliased.
Macro body — The link text, interpreted as wiki markup.
{add-page:template=My Template|parent=Page Parent}Click to add page{add-page}
Generates an 'Add Page' link which, when clicked, can take the user directly
to a template and/or set the page parent.
template - (optional) the name of the template to use when creating the page.
live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false.
parent - (optional) the name of the parent page (empty by default).
May also have the following markers:
@self - (default) the parent will be the page the macro is in.
@parent - the parent will be the parent of the page the macro is in.
@home - the parent will be home page for the Space the page is in.
title - (optional) if you want popup text to appear when the mouse is hovered
over the link, enter it here.
labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.
allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
{add-page-form:template=My Template|parent=Page Parent}Click to add new page{add-page-form}
Generates an 'Add Page' form with a field for the title.
template - (optional) the name of the template to use when creating the page.
live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false.
parent - (optional) the name of the parent page (empty by default).
May also have the following markers:
@self - (default) the parent will be the page the macro is in.
@parent - the parent will be the parent of the page the macro is in.
@home - the parent will be home page for the Space the page is in.
labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.
allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
nameWidth - (optional) The width of the title text field. Eg. '250px' or '70%'.
prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
{link-page:template=My Template|parent=Page Parent}Click to add page{link-page}
{link-page:Page Title|template=My Template}A Specific Page{link-page}
Links to a page in the current space.
If the page doesn't exist or is untitled, it generates a 'Add Page' link which, when clicked, can take the user directly
to a template and/or set the page parent.
The title may also contain substitution markers, indicated with '%' surrounding a
Supplier key chain value. Eg:
{link-page:name=%content:title% - %global:current user > user:full name%}your page{link-page}
This will link to a page with the name being the parent page's title, followed by " - " followed by the current user's name.
[default]/name - (optional) the title of the page. If not supplied, clicking the link will always create a new page.
template - (optional) the name of the template to use when creating the page.
live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false.
parent - (optional) the name of the parent page (empty by default).
May also have the following markers:
@self - (default) the parent will be the page the macro is in.
@parent - the parent will be the parent of the page the macro is in.
@home - the parent will be home page for the Space the page is in.
title - (optional) if you want popup text to appear when the mouse is hovered
over the link, enter it here.
labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.
allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name.
The user will not be able to modify this section of the name while creating it.
Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
Creates a link to special Confluence locations. All locations are non-case-sensitive.
Parameters
[default] - The location to link to. See the list of locations below.
space - (optional) The spacekey to link to.
page/content - (optional) The name of the page/news item/etc to link to.
popup - (optional) If 'true', the link will open in a popup window.
popupWidth - (optional) The width of the popup window. Defaults to 600px.
popupHeight - (optional) The height of the popup window. Defaults to 400px.
popupScroll - (optional) If false, no scrollbar is displayed. Defaults to true.
target - (optional) The name of the popup window to open.
title - (optional) if you want popup text to appear when the mouse is hovered
over the link, enter it here.
Global Locations
admin - The administration section.
dashboard - The Dashboard.
global templates - The global templates page.
homepage - The user's homepage.
login - The login page.
logout - The logout page.
signup - The signup page.
notation guide - The notation guide.
rss feed builder - The RSS Feed Builder (Confluence 2.x)
spaces - The list of spaces the user has access to. (Confluence 1.4)
user profile - The currently logged in user's profile.
user history - The currently logged in user's history.
Space Locations
You can specify which space to link to by setting the 'space=key' parameter,
or it will default to the current space.
add news - Add a news post.
browse space - Go to the 'Browse Space' view.
mail - The mail page.
news - The news page.
pages alphabetical - The list of pages in alphabetical order.
pages tree - The hierarchical view of pages in the space.
pages updated - The recently updated pages list.
space attachments - The attachments list for the space.
space templates - The space templates list.
popular labels - A page listing popular page labels in the space. (Confluence 2.x)
all labels - A page listing all labels across the space. (Confluence 2.x)
RSS Feeds
Again, you can specify the space, or the current one will be used as the default.
rss comments - New comments are added to this feed.
rss news - News items for the space are added to the feed.
rss new pages - Any new pages in the space are added to the feed.
rss updated pages - Any updated pages in the space are added to the feed.
Page Locations
You can specify the space key as above, and you can specify the page or news item
with the 'page=Page Name' parameter.
@parent - Links to the page's parent, if it has one.
@self - Links to the page the macro is on.
add comment - Opens the 'add comment' section of the page.
page comments - Jumps to the page comments.
page attachments - The attachments tab for the page.
page children - Jumps to the page children list.
page edit - The edit tab for the page.
page history - The page history view.
page info - The page info view.
page source - The page source view
page hierarchy - The page in context of the page hierarchy.
pdf export - Export the page to PDF.
word export - Export the page in Microsoft Word format.
print - The print view for the page.
{link-window:Another Page}Open Another Page in Another Window{link-window}
Links to a page or URL, popping it up into a new window.
[default]/href - The name of the page, or the URL.
type - Either 'normal' (the default) or 'popup'. If set to popup,
many of the settings below will default to those appropriate for a popup window.
width - The width of the new window.
height - The height of the new window.
scrollbars - If false, the scrollbar will be hidden.
menubar - If false, the menubar will be hidden.
location - If false, the location bar will be hidden.
statusbar - If false, the status bar will be hidden.
resizable - If false, the window will not be resizable.
target - The title of the target window. Use this to open multiple links in the same popup window.
tip - The tip to display while the mouse is hovering over the link.
icon - If false, the link will not have an 'open new window' icon.
{anchor:anchorname}
Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So the link [My Page#here] will link to wherever in "My Page" there is an {anchor:here} macro, and the link [#there] will link to wherever in the current page there is an {anchor:there} macro.
Lists
Lists allow you to present information as a series of ordered items.
Notation
Comment
* some * bullet ** indented ** bullets * points
A bulleted list (must be in first column). Use more (**) for deeper indentations.
Example:
some
bullet
indented
bullets
points
- different - bullet - types
A list item (with -), several lines create a single list.
Example:
different
bullet
types
# a # numbered # list
A numbered list (must be in first column). Use more (##, ###) for deeper indentations.
Example:
a
numbered
list
# a # numbered #* with #* nested #* bullet # list
* a * bulletted *# with *# nested *# numbered * list
You can even go with any kind of mixed nested lists:
The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed. Despite the fact that this plugin has an ajax UI, it is still fully versioned like a normal Confluence page.
Example:
What you need to type
What you will get
{dynamictasklist:Arthurs To-Do's}
Images
Images can be embedded into Confluence pages from attached files or remote sources.
Notation
Comment
!http://www.host.com/image.gif!
or
!attached-image.gif!
Inserts an image into the page.
If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed.
!spaceKey:pageTitle^image.gif!
!/2007/05/23/My Blog Post^image.gif!
Inserts an image that is attached on another page or blog post.
If no space key is defined, the current is space is used by default.
!image.jpg|thumbnail!
Insert a thumbnail of the image into the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image.
Thumbnails must be enabled by the site administrator for this to work.
!image.gif|align=right, vspace=4!
For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.
{gallery}
{gallery:columns=3}
{gallery:title=Some office photos, and a waterfall|columns=3}
{gallery:title=Some office photos, without the waterfall|exclude=waterfall.jpg}
{gallery:title=One office photo, and a waterfall|include=office1.jpg,waterfall.jpg}
{gallery:title=Some office photos, and a waterfall|page=Gallery of Pictures}
{gallery:title=Some office photos, and a waterfall|page=DOC:Gallery of Pictures}
{gallery:title=Some office photos, and a waterfall|sort=name}
{gallery:title=Some office photos, and a waterfall|sort=date|reverse=true}
Create a gallery of thumbnails of all images attached to a page. This will only work on pagesthat allow attachments, obviously.
The title parameter allows you to supply a title for the gallery
The columns parameter allows you to specify the number of columns in the gallery (by default, 4)
The exclude parameter allows you to specify the name of attached images to ignore (i.e., they will not be included in the gallery). You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif
The include parameter allows you to specifically include one or more attached images. The gallery will show only those pictures. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif
The page parameter allows you specify the title of one or more pages which contains the images you want displayed. If a page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro. You can specify more than one page, separated by commas. Example: page=Image Gallery,STAFF:Group Photos
If a page or attachment file name contains a comma, you can use it in the include, exclude, or page parameters by enclosing it in single or doublequotes. Example: include="this,that.jpg",theother.png
The sort parameter allows you to control the order of the images. The options are name,comment, date, or size.
The reverse parameter is used in conjunction with the sort parameter to reverse the order of the specified sort. Valid values are true and false.
Previous versions of the Gallery macro had an additional slideshow parameter. This is no longer used in the latest version, and the slide show is always enabled. We have left the parameter here for compatibility with older versions of the macro.
Tables
Tables allow you to organise content in a rows and columns, with a header row if required.
{csv:output=wiki|width=900|border=15|delimiter=whitespace}
Month Max Min Average
January 25.5 *6.3* 15.9
February 32.4 12.8 22.6
March 44.6 24.5 34.6
April 59.7 37.1 48.4
May 72.5 48.7 60.6
June 81.3 57.9 69.6
July 85.2 62.8 74
August 82.5 60.7 71.6
September 73.7 51.7 62.7
October 61.1 40.1 50.6
November 43.6 27.4 35.5
December 29.9 13.6 21.8
{csv}
Converts csv and other deliminated data into a table.
CSV is not a formal standard, but the best reference is
The Comma Separated Value (CSV) File Format.
The support in this macro comes close to following this pseudo-standard.
For more details see
SCRP-16. This macro shares common table capabilities with other table
based macros (excel, table-plus, and sql).
output - Determines how the output is formated:
html - Data is output as a HTML table (default).
wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
script - Location of csv data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.
#filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
global page template name - Data is read from a global page template.
space:page template name - Data is read from a space template.
^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.
url - Specifies the URL of an csv file. If a url location is specified, the included data will follow the body and script data.
Use of this parameter may be restricted for security reasons. See your administrator for details.
heading - Number of rows to be considered heading rows (default is 1 row).
Specify heading=false or heading=0 to not show any heading lines.
Heading rows do not participate in sorting.
footing - Number of rows to be considered footing rows (default is 0).
Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.
border - The border width in pixels. Defaults to normal table border width.
width - The table width in pixels. Default is 100%.
delimiter - Delimiter that separates columns. Note that trailing delimiters on a line result in a blank column at the end of the row.
, or "," (comma) - The default column separator.
whitespace - Blanks, tabs, and other white space are used to separate columns.
tab - A single tab character is used to separate columns.
blanks - Blank or blanks only.
pipe - A single pipe (|) character is used to separate columns.
other single character delimiter - may be within double quotes with some restrictions. Examples: ";", "=",
columns - Comma separated list of column numbers in any order.
Defaults to all columns in existing order.
Columns are enumerated starting at 1.
ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored.
A row is considered blank if all the columns selected by the column parameter are blank.
Set ignoreTrailingBlankRows=false to show these blank rows.
quote - the character used to represent quoted data. Quoted data may contain delimiters or new lines. Quote character must be doubled inside a quoted string.
double - Double quote character (default).
single - Single quote character.
escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table.
Set escape=true to allow these special characters to be escaped so that it will not affect the formatting.
The default is false so that data that has wiki markup will be handled correctly.
showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table.
This is used to help resolve formating issues.
{table-plus}
|| || January || February || March || April ||
| Max | 37.5 | 32.7 | 28.0 | 25.3 |
| Min | 31.3 | 26.8 | 25.1 | 18.7 |
{table-plus}
{table-plus:width=500|border=15|enhableHighlighting=false|columnTypes=S,F,F,F}
|| Month || Max || Min || Average ||
| January | 25.5 | *6.3* | 15.9 |
| February | 32.4 | 12.8 | 22.6 |
| March | 44.6 | 24.5 | 34.6 |
| April | 59.7 | 37.1 | 48.4 |
Other text can be here too!
|| Another table ||
| more data |
{table-plus}
{table-plus:columnTypes=S,-,.|autoNumber=true|sortColumn=3
|columnAttributes=,,style="background:yellow; font-size:14pt;"}
|| Name || Phone || TCP ||
| John | 555-1234 | 192.168.1.10 |
| Mary | 555-2134 | 192.168.1.12 |
| Bob | 555-4527 | 192.168.1.9 |
{table-plus}
Adds column sorting and other attributes to one or more tables found in the body of the macro.
The tables can be produced by wiki markup or other means.
This macro shares common table capabilities with other table
based macros (excel, csv, and sql).
heading - Number of rows to be considered heading rows (default is 1 row).
Specify heading=false or heading=0 to not show any heading lines.
Heading rows do not participate in sorting.
footing - Number of rows to be considered footing rows (default is 0).
Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.
width - The table width in pixels. Default is 100%.
border - The border width in pixels. Defaults to normal table border width.
multiple - Default is true which means all tables found within the macro body are processed.
Set multiple=false to only process the first table found and may need to be used
if the table includes cells that are also tables.
Other parameters - Other parameters are passed through to the html table markup for more advanced
capabilities or to override the default class
A javascript enabled browser is required to enable these capabilities.
A number of table based macros (table-plus, csv, excel, and sql) share these common capabilities.
Column sorting - sort a column by clicking on column heading.
Clicking again will reverse the order. Auto sorting before display
Row highlighting on mouse over - row is highlighted when mouse goes over any row element for non-heading rows
Column attributes - ability to set the display attributes (color, font) on a column basis
Auto numbering - ability to automatically add a leading column with the data row count.
Auto totaling - ability to automatically add a footing row that totals all numeric columns.
Parameters - the following parameters control these common table capabilities:
enableSorting - Set enableSorting=false to prevent sorting.
enableHighlighting - As the mouse moves over a table row, the row will be highlighted by default.
Set enableHighlighting=false to stop this behavior.
This parameter was formerly known as highlightRow which still works.
sortColumn - The table can be auto sorted before it is displayed by any valid column name
or number provided by this parameter. No auto sorting will be done
if this value is not provided or is invalid. A column number is a 1-based count
of columns (excluding auto number column).
sortDescending - If sortDescending=true, the sort indicated by the sortColumn will
be done in reverse order.
sortTip - Text that is used to provide user feedback with mouse is over
a column heading that is sortable. Default text is: "Click to sort" followed by
the column name if available.
sortIcon - Default is false to not show a sort indicator icon.
Set sortIcon=true to include a sort icon in the first heading row for sortable columns.
An icon will show for the last column sorted indicating the direction the column was sorted.
highlightColor - Color of row when mouse is over a row element.
See Colors for how to specify.
autoNumber - If autoNumber=true, an additional column will be added that will
count each data row.
autoTotal - If autoTotal=true, an additional row will be appended to the end of the table
that will contain totals of all numeric columns.
autoNumberSort - If autoNumberSort=true, the auto number column will be sortable and
will retain the original data row count even after row sorting.
columnTypes - By default, all columns are treated as strings for sorting purposes unless
a more specific sort type is provided either by the macro logic or
by this parameter. The parameter
is a comma separated list of column type indicators to identify column types.
S - string
I - integer
F - float
C - currency or similar where it is a float value with pre or post characters
D - date in the browser date format. More advanced date handling may be available
on your server after installation of a date handling library. See online
docmentation for more information.
X - exclude this column from user selectable sorting
. or - or : or / - separated numbers, like phone numbers or TCP addresses.
Valid values are multiple integer numbers separated by one of the separators indicated by the type.
H - hide the column.
columnAttributes - A comma separated list of values used to modify cell attributes for all
cells in a column. The position in the comma separated list corresponds
to the column that the values apply to. Each value is a double semi-colon (;;) separated
list of attributeName=value pairs that will be applied to the column cells.
enableHeadingAttributes - By default, any column attributes provided will be applied to the all column rows including heading rows.
Set enableHeadingAttributes=false to have the column attributes apply only to data rows.
id - Sets the table id for the table for use in macros (like the chart macro) to identify a
specific table.
Advanced Formatting
More advanced text formatting.
Notation
Comment
{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
return foo;
}
{code}
Makes a preformatted block of code with syntax highlighting. All the optional parameters of {panel} macro are valid for {code} too. The default language is Java but you can specify JavaScript, ActionScript, XML, HTML and SQL too.
Example:
Bar.java
// Some comments herepublicString getFoo()
{
return foo;
}
orientation - A bar, line, or area chart will be displayed vertically (y axis is vertical) unless 'orientation=horizontal' is specified.
3D - A pie, bar, or line chart will be shown in 3D if 3D=true is specified.
stacked - A bar or area chart will be shown with stacked values if stacked=true is specified.
showShapes - Shapes will be shown at each data point in a line chart unless showShapes=false.
opacity - A percent value between 0 (not visible) and 100 (non-transparent) that determines how opaque the foreground areas and bars display. Defaults are:
75 percent for 3D charts
50 percent for non-stacked area charts
100 percent for all other charts
Display control parameters
width - The width of the chart in pixels (default is '300')
height - The height of the chart in pixels (default is '300')
dataDisplay - Default is false to not display the rendered body of the macro (usually the data tables). When dataDisplay=true or dataDisplay=after, the data will be displayed after the chart. When dataDisplay=before, the data will be displayed before the chart.
imageFormat - Default is png. Format of generated image. Valid formats are png and jpg. Other formats may be also be valid if installed on your server.
Title and label customization parameters
title - The title of the chart.
subTitle - A subtitle for the chart using a smaller font.
xLabel - The label to use for the x (domain) axis
yLabel - The label to use for the y (range) axis
legend - A legend will be displayed unless legend=false is specified.
Data specification parameters - The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined to Confluence will be tried. Additional conversion options can be specified using the parameters below.
tables - Comma separated list of table ids and/or table numbers contained within the body of the macro that will be used as the data for the chart. Defaults to all first level tables. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros).
columns - Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Defaults to all columns. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row.
dataOrientation - The data tables will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
timeSeries - If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats.
dateFormat - For time series data, the date format allows for additional customization of the conversion of data to date values. By default, the Confluence language defined date formats will be used. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the format of the time series data. See Date Format.
timePeriod - Specify the time period for time series data. Default is 'Day'. This defines the granularity of how the data is interpreted. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.
language - If provided, the language and country specification will be used to create additional number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
forgive - Default is true to try to convert numeric and date values that do not totally match any of the default or user specified formats. Specify forgive=false to enforce strict data format. Data format errors will cause the chart to not be produced.
Color customization parameters - See Colors for how to specify colors.
bgColor - Color (default is 'white') to use as the background of the chart.
borderColor - Color of a border around the chart. Default is to not show a border.
colors - Comma separated list of colors used to customize category, sections, and series colors.
Axis customization parameters - Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these paramters.
rangeAxisLowerBound - range axis lower bound
rangeAxisUpperBound - range axis upper bound
rangeAxisTickUnit - range axis units between axis tick marks
rangeAxisLabelAngle - angle for the range axis label in degrees
domainAxisLowerBound - domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)
domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)
domainAxisTickUnit - domain axis units between axis tick marks. For a date axis, this value represents a count of the units specified in the timePeriod parameter. The time period unit can be overridden by specifying a trailing character: y for years, M for months, d for days, h for hours, m for minutes, s for seconds, u - milliseconds. (Only used in XY Plots, standard charts will have no effect)
domainAxisLabelAngle - angle for the domain axis label in degrees. (Only used in XY Plots, standard charts will have no effect)
categoryLabelPosition - allows axis label text position for categories to be customized
up45 - 45 degrees going upward
up90 - 90 degrees going upward
down45 - 45 degrees going downward
down90 - 90 degrees going downward
dateTickMarkPosition - placement of the date tick mark
start (default) - tick mark is at the start of the date period
middle - tick mark is in the middle of the date period
end - tick mark is at the end of the date period
Pie chart customization parameters
pieSectionLabel - Format for how pie section labels are displayed. :
%0% is replaced by the pie section key.
%1% is replaced by the pie section numeric value.
%2% is replaced by the pie section percent value.
Example 1: "%0% = %1%" would display something like "Independent = 20"
Example 2: "%0% (%2%)" would display something like "Independent (20%)"
pieSectionExplode - Comma separated list of pie keys that are to be shown exploded. Defaults to no exploded sections. Note: requires jFreeChart version 1.0.3 or higher.
Attachment parameters - These are advanced options that can be used for chart versioning, automation enablement, and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the cache macro to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.
attachment - Chart image will be saved in a attachment.
page^attachment - The chart is saved as an attachment to the page name provided.
space:page^attachment - The chart is saved as an attachment to the page name provided in the space indicated.
attachmentVersion - Defines the the versioning mechanism for saved charts.
new - (default) Creates new version of the attachment.
replace - Replaces all previous versions of the chart. To replace an existing attachment, the user must be authorized to remove attachments for the page specified.
keep - Only saves a new attachment if an existing export of the same name does not exist. An existing attachment will not be changed or updated.
attachmentComment - Comment used for a saved chart attachment.
thumbnail - Default is false. If true, the chart image attachment will be shown as a thumbnail.
Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "'" represents a single quote. All other characters are not interpreted; theyre simply copied into the output string during formatting or matched against the input string during parsing.
The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):
Pattern letters are usually repeated, as their number determines the exact presentation.
Text:
For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
Number:
For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless its needed to separate two adjacent fields.
Year:
For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.
For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.
For parsing with the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isnt all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.
Month:
If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
General time zone:
Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:
GMTOffsetTimeZone:GMTSignHours:MinutesSign: one of
+ -Hours:DigitDigitDigitMinutes:DigitDigitDigit: one of
0 1 2 3 4 5 6 7 8 9
Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.
{report-empty}
This is displayed if no results are returned by the reporter.
{report-empty}
{report-table}
Displays the each of the items from a reporter in a table.
A report block must contain two things: 1) A reporter macro (such as
{content-reporter} or
{user-reporter}), which finds the list of items to report on,
and 2) one or more
{report-column}s must be present
to define what data is displayed.
It may also optionally include a {report-empty} macro, which specifies what will be displayed if
no items are returned from the reporter.
depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
sortDescendents - (optional) If set to false, the descendents displayed if 'depth'
is greater than 1 are not sorted using the report sort criteria.
maxResults - (optional) The maximum number of results to display.
firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
width - (optional) The width of the table (e.g. '500px', '100%').
class - (optional) The CSS class to render the table with.
injected - (optional) If set to true, the {report-column} macros will default to injecting %prefix:key% values directly.
Displays a single column in a {report-table}.
This macro will usually contain at least one use of the
{report-item} macro, or another macro which
dispays information about the current item being reported on.
title - (required) The title to display in the table header.
width - (optional) The width of the column. Eg. "50px", "20em".
colSpan - (optional) The number of columns this column should span over.
rowSpan - (optional) The number of rows this column should span over.
newRow - (optional) If set to true, a new row will be started with this column.
class - (optional) The CSS class(es) to apply to this column.
summaryType - (optional) The type of summary to display at the end of this column. May be one of:
sum - The sum total of all numbers in the column.
count - The number of non-blank values in the column.
average - The average of all numbers in the column.
summaryValue - (optional) The key chain value for the column summary, or plain
text to display if the 'summaryType' is not set for this column.
E.g. "data:My Number", or "content:children > collection:size".
*Note:* The summary value key can be completely unrelated to what is displaying
in the column, if so desired.
summaryFormat - (optional) The number format to use for the summary. E.g. "$#,
injected - (optional) If set to true, %prefix:key% values in the body will be injected with
report value before being rendered.
{report-body}
This content is repeated for each item.
{report-body}
{report-empty}This is displayed if no results are returned by the reporter.{report-empty}
{report-list}
Displays the each of the items from a reporter as a list item.
A report block must contain two things: 1) A reporter macro (such as
{content-reporter} or
{user-reporter}), which finds the list of items to report on,
and 2) A {report-body} macro, which contains the wiki code which will be executed for each item.
It may also optionally include a {report-empty} macro, which specifies what will be displayed if
no items are returned from the reporter.
style - (optional) The style of bullet to display. May be any standard CSS style. Defaults to 'disc' if outlining is off, or 'decimal' if outlining is on.
outline - (optional) If set to 'true', the list and any sub-lists of children will be displayed with an outline number format (eg. "1.2.3").
Defaults to 'false'. Note: This setting will only display correctly in FireFox.
depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
sortDescendents - (optional) If set to false, the descendents displayed if 'depth'
is greater than 1 are not sorted using the report sort criteria.
trim - (optional) If 'false', the body will not be trimmed. True by default.
injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly.
maxResults - (optional) The maximum number of results to display.
firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
{report-block}
{xxx-reporter}
{report-body}
This content is repeated for each item.
{report-body}
{report-empty}This is displayed if no results are returned by the reporter.{report-empty}
{report-block}
Displays the each of the items from a reporter in a block of wiki text.
A report block must contain two things: 1) A reporter macro (such as
{content-reporter} or
{user-reporter}), which finds the list of items to report on,
and 2) A {report-body} macro, which contains the wiki code which will be executed for each item.
It may also optionally include a {report-empty} macro, which specifies what will be displayed if
no items are returned from the reporter.
separator - (optional) The type of separator to display between each item. Defaults to nothing.
May be one of the following:
bracket - Square brackets ('[', ']') surrounding each item.
brace - Braces ('{', '}') surrounding each item.
comma - A comma (',') between each item.
paren - Parenthases ('(', ')') surrounding each item.
pipe - A pipe ('|') between each item.
newline - A line break after each item.
"custom" - Any other character you wish, specified between quotes.
maxResults - (optional) The maximum number of results to display.
firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
sortDescendents - (optional) If set to false, the descendents displayed if 'depth'
is greater than 1 are not sorted using the report sort criteria.
injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly.
{report-header}
This content is displayed at the beginning of a non-empty report.
{report-header}
This macro contains the wiki code which will be displayed before a non-empty report. It
must be contained in another report macro (e.g. {report-block}).
trim - (optional) If 'true', the body will be trimmed. False by default.
{report-body}
This content is repeated for each item of a report.
{report-body}
This macro contains the wiki code which will be executed for each item of the surrounding
report. It is used by the {report-block}
and {report-list} macros. It will usually
contain one or more uses of the {report-item}
macro to display reported values.
trim - (optional) If 'true', the body will be trimmed. False by default.
injected - (optional) If set to true, %prefix:key% values in the body will be injected
with report values before being rendered.
{report-footer}
This content is displayed at the end of a non-empty report.
{report-footer}
This macro contains the wiki code which will be displayed after a non-empty report. It
must be contained in another report macro (e.g. {report-block}).
trim - (optional) If 'true', the body will be trimmed. False by default.
{report-empty}
This content is displayed for reports with no items.
{report-empty}
This macro contains the wiki code which will be displayed if the surrounding
report has no items. It is used by the {report-block},
{report-list} and
{report-table} macros.
trim - (optional) If 'true', the body will have any leading or trailing white space removed before it is displayed. False by default.
Displays the specified key value for the current report item. The key is a set of
Supplier keys, separated
by ">" characters. For example, if the current item is a standard Confluence page, the
following will display the page creator's full name:
{report-info:content:creator > user:full name}
It first looks up the creator of the current item, then get the full name for that user.
default/key - (required) the key value to display.
format - (optional) The date (eg. 'dd MMM, yyyy') or number (eg. '#, This will only be used if the data is a date or a number, respectively. Otherwise, it will be ignored.
link - (optional) If set to 'true' and the current item/key has a URL link, the text generated will be linked to that URL.
Defaults to 'false'.
render - (optional) If set to 'wiki', the generated text will be rendered as wiki text. Defaults to 'none'.
default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered
as wiki text. Alternately, the body of the macro can also be used, if more complex wiki text is required.
separator - (optional) If the item/key points to a list of results, the type of separator to display between each item.
Defaults to 'comma'. May be one of the following:
bracket - Square brackets ('[', ']') surrounding each item.
brace - Braces ('{', '}') surrounding each item.
comma - A comma (',') between each item.
paren - Parenthases ('(', ')') surrounding each item.
pipe - A pipe ('|') between each item.
newline - A line break after each item.
"custom" - Any other character you wish, specified between quotes.
Displays the specified key value as a link. It is assumed that the item/key value
is an absolute or server-relative link. If not, the 'prefix' and 'postfix' parameters
can be used to prepend or append extra values to the URL.
default/key - (required) the key value to use as the link URL.
info - (optional) The text which will be displayed when the user hovers their mouse over the link.
target - (optional) The target frame to open the link in. May be any standard HTML target.
prefix - (optional) The text to prepend to the item/key value in the link.
postfix - (optional) The item to append to the item/key value in the link.
trim - (optional) If set to 'false', the URL will not be trimmed. Defaults to 'true'.
{report-image:item:key|width=16px|height=16px}
Displays the specifed key value for the current item as an image. It is assumed
that the key value retrieved is an absolute (eg. "http://server/folder/file.gif")
or server-relative (eg. "/folder/file.gif") URL.
default/key - (required) the key value to use as the image URL.
width - (optional) The width of the image, using standard CSS units (eg. "20px" or "80em").
height - (optional) The height of the image, using standard CSS units (eg. "20px" or "80em").
border - (optional) The border style of the image, using standard CSS values (eg. "red dash 2px").
Sets the item context to the item/key value specified. This is useful when you wish
to display several key values from a sub-item of the item currently being reported on. For
example, you may wish to use the full name and email address of the current page's
last modifier:
{report-on:content:modifier}
Last Modifier: {report-info:user:full name|link=true} ({report-info:user:email|link=true})
{report-on}
default/key - (required) the key value to display.
default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered
as wiki text. Alternately, the body of macro can also be used, if more complex wiki text is required.
separator - (optional) If the item/key points to a list of results, the type of separator to display between each item.
Defaults to 'comma'. May be one of the following:
bracket - Square brackets ('[', ']') surrounding each item.
brace - Braces ('{', '}') surrounding each item.
comma - A comma (',') between each item.
paren - Parentheses ('(', ')') surrounding each item.
pipe - A pipe ('|') between each item.
newline - A line break after each item.
"custom" - Any other character you wish, specified between quotes.
injected - (optional) If set to true, %prefix:key% values will be injected with report values before being rendered.
Stores the value, as defined by either the 'value' parameter, or the body of the macro, into the named
variable in the local context, accessible via the 'variable:' prefix. If inside a report-body or report-column section, it will only be stored for the lifetime of the current item.
If a 'reporter' macro is put into the macro body, it will be stored and can be reused across multiple reports.
default/name - (required) the name of the variable to store the result in.
value - (optional) The %injected% value of to store. If not provided, the macro body is used.
default - (optional) The contents of this parameter will be used if the item/key is empty. This can be an %injected% value.
Evaluates the mathematical expression contained in the body, injecting Supplier values from the local context.
Basic mathematical operators such as '+', '-', '/', '*', '^' and brackets are available.
default/name - (optional) the name of the variable to store the result in. Accessible via 'variable:[name]'.
format - (optional) Number format (eg. '#,
hidden - (optional) If set to 'true', the result will not be output.
default - (optional) The contents of this parameter will be used if the item/key is empty. This can be an %injected% value.
{local-reporter:prefix:key}
{xxx-sort:prefix:subkey|order=[ascending, descending]}
{xxx-filter:prefix:subkey|extra parameters go here}
{local-reporter}
Allows a sub-report to be created from within another report. This reporter will display
the contents of any sub-item of the current item, identified using the "prefix:key" value.
default/key - (required) the key value to display.
source - (optional) The location to set as the source context. If unspecified, the
current report item (if in a report) or current page/news item will be the context.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
{space-reporter:space=KEY}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{space-reporter}
Reports on Confluence Spaces. It must be used in a report of some type (eg.
{report-block}). It will only list spaces visible to the current user. Also,
further filtering can be made by specifying the 'spaces' parameter, or using custom filters.
space(s) - (optional) The list of spaces to search in. Each space may be prefixed
by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded).
Defaults to '@self'. May be one of the following:
@self - (default) The space the current content is in.
@personal - Personal spaces only.
@global - Global spaces, that is, non-personal spaces.
@all - All spaces, both global and personal
SPACE KEY - Any other space key may be specified explicitly.
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
Reports on Confluence content (pages, news, comments, attachments, etc). The content
can be filtered by space, type, scope or labels, as well as any custom filters specified
in the body of the macro.
space(s) - (optional) The list of spaces to search in. Each space may be prefixed
by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded).
Defaults to '@self'. May be one of the following:
@self - (default) The space the current content is in.
@personal - Personal spaces only.
@global - Global spaces, that is, non-personal spaces.
@all - All spaces, both global and personal
SPACE KEY - Any other space key may be specified explicitly.
type(s) - (optional) The list of content types to allow. Defaults to allowing all types.
Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded).
May be any of the following:
page
news
comment
attachment
spacedescription
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
{user-reporter:user=[usernames]|group=[group names]|space=SPACEKEY:view/edit/admin/news}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{user-reporter}
Reports on Confluence users matching the specified criteria.
user(s) - (optional) the (list of) users who can see the content.
group(s) - (optional) the (list of) groups who can see the conent.
space(s) - (optional) KEY > permission - the (list of) spaces where, if the user can view
the space, they can see the content. The permission is optional - view is used by default. Otherwise, you
may specify one of the following after the '>'.
view - (default) the user can view the space.
edit - the user can edit pages.
admin - the user has administration access.
news - the user can post a news entry.
comment - the user can post a comment.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
{user-group-reporter}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{user-group-reporter}
Reports on the available user groups in Confluence. This list is only available to
administrators and users who can create or administrate spaces.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
{expanding-reporter:prefix:key|as=something}
{xxx-reporter}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{expanding-reporter}
This macro will expand upon the selected 'prefix:key' of each of the result items returned
by the contained reporter. In database query terms, this
is essentially a 'join' operation, and is mostly useful for many-to-many relationships.
For example, a user can be a member of many groups, and each group can have many users as
members. If you wish to display a list of all groups and their members in a single table,
with only one group and one user listed per row, you need to expand on one or the other.
You will end up with both being repeated multiple times, but such is the nature of the
relationship. Using the {user-group-reporter}
it would look something like this:
Note the use of 'expanded:item' and 'expanded:member'. 'expanded:item' always referrs
to the original item being expanded on, in this case the user group. 'expanded:member'
is used because the original {expand-on} macro declared that each of the items in
'user-group:members' would be known as 'member'.
Note also that you can specify sort order inside the {expanded-reporter} macro. You can also
add any filters you wish to, and they will only apply to the items being expanded on.
default/key - (required) The key value to expand on.
as - (required) The name to set each expanded item as when accessing it in the report.
May not be 'item', as this is reserved for the original item being expanded.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
allowEmpty - (optional) Defaults to false. If set to true,
the parent item will still be returned even if the specified key value is empty.
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{combining-reporter}
This macro combines two or more reports into a single set of results for output. The
results of the reporter do not have to be of the same type, although sorting and filtering
will probably not work as expected if they are not.
The reporter can contain filter and sort macros. Filters will be applied on each item from each
report as it is retrieved from the sub-report. Sorting will be done on the complete set of results
after being filtered and combined.
By default, no uniqueness checking is done, but you can specify it with the 'unique' parameter. There
will be a performance penalty for turning this option on, however. If the set of results is unsorted,
only the first instance of a value will be returned - duplicates are ignored.
unique - (optional) If true, the set of results will only contain a single instance of each item.
matchAll - (optional) If set to 'false', content matching any of the
criteria will be returned. Otherwise, the content must match all criteria.
This filter will ensure that the specified 'prefix:key' value is a date, and that it
matches the required criteria. It must be used in a reporter macro.
default/key - (required) The key value to filter on.
minValue - (optional) If specified, the date must be greater than or equal to the specified date.
This may also be a period from today's date, such as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'.
E.g. '-2y 6m' is 2 years, 6 months in the past.
maxValue - (optional) If specified, the date must be less than or equal to the specified date value.
This may also be a period from today's date, such as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'.
format - (optional) If either minValue or maxValue are a specific date, this parameter
must also be specified to inform the filter of the date format used in those parameters. It is not required for relative dates.
required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty.
This filter will ensure that the specified 'prefix:key' value is a number, and that it
matches the required criteria. It must be used in a reporter macro.
default/key - (required) The key value to filter on.
minValue - (optional) If specified, the number must be greater than or equal to the specified value.
maxValue - (optional) If specified, the number must be less than or equal to the specified value.
decimal - (optional) If specified, setting it to 'true' will require that the number is
a decimal type, and setting it to false will require it is a whole number.
required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty.
This filter will ensure that the specified 'prefix:key' value matches the required
Confluence content value. It must be used in a reporter macro.
default/key - (required) The key value to filter on.
space(s) - (optional) The list of spaces to search in. Each space may be prefixed
by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded).
Defaults to '@self'. May be one of the following:
@self - (default) The space the current content is in.
@personal - Personal spaces only.
@global - Global spaces, that is, non-personal spaces.
@all - All spaces, both global and personal
SPACE KEY - Any other space key may be specified explicitly.
type(s) - (optional) The list of content types to allow. Defaults to allowing all types.
Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded).
May be any of the following:
page
news
comment
attachment
spacedescription
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
matchAll - (optional) If set to 'false', content matching any of the criteria will be let through.
This filter will ensure that the specified 'prefix:key' value matches the required
Confluence content value. It must be used in a reporter macro.
default/key - (required) The key value to filter on.
user(s) - (optional) The list of users to match.
May be '@self' to indicate the currently-logged-in user.
group(s) - (optional) This list of user groups to match.
space(s) - (optional) The list of space keys, followed by an optional permission type, to match against.
The form is 'SPACEKEY:permission' (e.g. 'MYSPACE:edit'). The available permissions to check against are:
view - (default) The user can view the space.
edit - The user can edit the pages in the space.
news - The user can add news items to the space.
comment - The user can add comments to the space.
admin
- The user can administer the space.
matchAll - (optional) Defaults to 'true'. If set to 'false', content matching any of the criteria will be let through.
This filter will check that any contained filter values exist on all/any/none of the items
in the collection specified by the filter's "prefix:key" value.
Tip: You can use 'collection-filter-1' to 'collection-filter-5' if you need to nest
collection filters.
default/key - (required) The key value to filter on.
matchItems - (optional) Define how many of the collection's items can match the sub-filers.
Defaults to 'all'. May be one of the following:
all - (default) All items must match the sub-filter set.
any - At least one item must match the sub-filter set.
none - None of the items may match the sub-filter set.
matchFilters - (optional) Define how many of the sub-filters must match for the item to be let through.
May be one of the following:
all - (default) All sub-filters must match the item.
any - At least one sub-filter must match the item.
none - None of the sub-filters may match item.
{repeat-filter:prefix:key|match=[first/repeats]}
This filter checks if the current value is different from the previous one passed to the filter.
If so, it passes, otherwise it will fail.
default/key - (required) The key value to filter on.
match - (optional) Either 'first' (the default) to match only the first item or
'repeats' to match only the repetitions, not the original value.
This will sort the results by the specified boolean key value. By default, empty values will
be listed before false, which will be before true, using ascending order.
order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{date-sort:prefix:key|order=ascending/descending}
This will sort the results by the specified date key value. By default, empty values will
be listed first, then the rest using ascending order.
order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
The page-info is used for retrieving information about the current page
displayType - required - selects the kind ad style of data displayed
created-user - displays the user who created the page
created-date - displays the date the page was created
modified-user - displays the user who last modified the page
modified-users - displays a list of all the users who have modified the page
modified-date - displays the date the page was last modified
participants - displays a list of the users who have modified or commented on the page
commenters - displays a list of the users who have commented on the page
current-version - displays the most recent version number for the page
versions - displays a comma separated list of version numbers, clickable to take you to view that version
diffs - displays a list of version numbers, clickable to take you to view the differences between that version and the next version
labels - displays a list of labels, clickable to take you to view that label
title - displays the title of the specified page
tinyurl - displays a tinyurl link to the specified page
pageID - displays the ID of the specified page
page - optional - selects the page for which information is being retrieved, if unspecified the current page is used
dateFormat - optional - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
prefix - optional - selects the prefix applied to lists
reverse - optional - reverses the order of the items found (versions & diffs only)
count - optional - sets the number of items to be displayed (versions & diffs only)
type - optional - displays lists of information as a flat comma separated list (default), or as an unordered list
wrap - optional - wraps lists in a span (default true)
caption - optional - caption to use with tinyurl links (@tinyid, @tinyurl, @title - default=title)
Displays version history data about a page in a tabular format
page - selects the page for which information is being retrieved, if unspecified the current page is used
dateFormat - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
reverse - displays data in reverse revision order when set to true
Transforms XML to a Confluence page via an XSLT style sheet. Note that macro parameters not recognized by the xslt macro are automatically passed
through to the xslt engine.
This macro may have restricted use for security reasons. See your administrator for details.
output - Determines how the output is formated:
html - Data is output as a HTML (default).
wiki - Data is output as Confluence wiki text. Use this option if you want the data to be formated by the Confluence wiki renderer.
source - Location of source XML code. Default is the macro body.
#filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
#http://... - Data is read from the URL specified.
global page template name - Data is read from a global page template.
space:page template name - Data is read from a space template.
^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.
style - Location of source XSL code. Required if source XML is in the macro body, otherwise defaults to the macro body.
#filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
#http://... - Data is read from the URL specified.
global page template name - Data is read from a global page template.
space:page template name - Data is read from a space template.
^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.
creates a child page to the current page (if it doesnt already exist)
Parameters:
default - The child page title (if it already exists but is not a child of the current page then a number will be appended)
template - the name of the template to apply to the child page
LAYOUTID:resource.ext - a resource in a specific layout
@current:resource.ext - a resource in the current layout
@parent:resource.ext - a resource in the current layouts parent
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
templatename - the name of a space or global template
If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available
render - pre-render the child page (default false)
parent - The parent page (default = @self)
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - an alternate way of specifying the parent space (default param takes precedence)
page - an alternate way of specifying the parent page (default param takes precedence)
_default_ - The HTML ID (must be unique for the entire web page) associated with an item in the menu
id - alternative (original) way of specifying the html id
class - The CSS class name to assign to div wrapping the menu
classname - The CSS class name to assign to items in the menu
electric - true (or number) - Pop-up menus will automatically open when the mouse hovers over their parent item, or their parent item gets keyboard focus, false - Pop-up menus will only be displayed when the parent item is clicked or when the the parent item is selected and the left arrow key (or spacebar) is pressed (default true)
timeout - Defines the number of milliseconds to wait before menus are automatically shown when the "electric" parameter is set to true
vertical - false - Items on the top level of the menu bar are shown horizontally, true - Items on the top level of the menu bar are shown vertically (ideal for putting menus in sidebars) (default false)
context - see userguide
tooltips - true - Tooltips, if specified in linked menu items, are shown when the mouse hovers over a menu item, false - Tooltips are not shown, useful when your target audience is using a slow internet connection or slow computer (default true)
shadows - see userguide
smooth - true - Shadows will look smoother in most browsers (requires an additional image to be loaded), false - Basic shadows will be used (slightly faster loading of pages) (default true)
blink - false - Menu items do not blink when clicked, true - Menu items blink a few times when clicked to give more visual feedback to the end-user (default false)
lazy - false - After the web page loads, the entire menu is "built" immediately, true - After the web page loads, only the top level of the menu is "built" and subsequent levels (i.e. pop-up menus) are only built when they are first displayed (default false)
toolbar - false - The top level of the menu displays normally, true - Additional styling is applied which makes items on the top level of the menu take up less space, ideal for toolbars. Note that some menu styles (e.g. the Longhorn style) don't currently support this feature (default false)
clone - see userguide
focus - automatically focus the menu (default false)
scrolling - true - If a menu is too big to fit in the browser window, scroll buttons will appear at either end to allow the user to "scroll" the menu. It's a really nice feature!, false - Menus will be shown in their entirety, even if that means that part of them can't be seen within the browser window (default true)
Used to create a menu with an icon based on the current space & page watch state
Parameters:
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
size - the size of the icon to use
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
{fav-menu}
{compound-menuitem:favourite|caption=%Add% this %Page% to favourites}
{compound-menuitem:favouritespace|caption=%Add% this space to favourites}
{fav-menu}
Used to create a menu with an icon based on the current space & page favourite state
Parameters:
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
size - the size of the icon to use
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
class - The CSS class name to assign to an item in a menu
subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
notitle - false : removes the title from submenus
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
Used to create a menuitem which contains a menulink and icon
Parameters:
caption - the text to use in the link
default - the piece of confluence functionality you wish to link to
RSS - go to rss feed editor
activity - show site/space activity
advanced - go to advanced config page
browse - link to browse space
builderadmin - link to builder administration
children - show/hide children toggle
colourscheme - go to colour scheme selector
comments - show/hide comments toggle
chooselayout - choose the layout
copy - copy the current page
custom - define a custom link
dashboard - go to dashboard
edit - edit the current page
emailpage - link to email page action
exportMail - export email to page
exportPDF - export page to pdf
exportWord - export page to word doc
favourite - add page to favourites
favouritespace - add space to favourites
first - the first sibling page
firstchild - the first child page
globaltemplates - display list of global templates
globallabels - show global labels heatmap
history - show account history
home - go to space home page
index - go to space index
information - show page information
labels - show labels heatmap
last - the last sibling page
lastchild - the last child page
login - go to login screen
logout - log out
mail - show space email
managelayouts - link to manage layouts
map - go to space map
move - move a page
newcomment - add a comment
newnews - create a new blogpost
newpage - create a new page
news - view space news
newspace - create a new space
next - the next sibling page
normalView - view page as normal
notationguide - link to the macro notation guide
pageView - view the page in normal mode
pageattachments - show page attachments
parent - the current page's parent
people - show the people directory
prev - the previous sibling page
printableView - view page as printable
profile - show user profile
recent - view recently updated in space
remove - delete the current page
search - links to the search screen
signup - create a new account
siteadmin - go to site administration
spaceadmin - go to space administration
spaceattachments - display space attachments
spacetemplates - display list of space templates
trimcomments - trim the comments of the current page
toggleSidebar - toggle the visibility of a sidebar
toggleVisibility - toggle the visibility of an html element
use-layout - change the layout
userspace - show user's space
viewSource - view the page source
viewattachments - show page attachments without checking attachment permission
watch - watch current page/space
watchspace - watch current space
webui - show a webui link, requires location & key parameters
wikipage - link to the page specified by the page & space parameters
tooltip - the tooltip that should be displayed by the link, use @none for blank
accesskey - the keypress that should be associated with this link
target - the target for the link (eg _blank)
space - the spacekey whose context the link generation should be calculated against
page - the title of the page whose context the link generation should be calculated against
parent - used by the exportMail link type to define the parent where the page generated from the mail shuld be created
class - the css class to be applied to the link
toggle - the html ID of the element whose visibility is to be toggled
sidebar - the name of the sidebar whose visibility is to be toggled (left/right)
link - the custom link
icon - the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)
imginside - should the icon appear inside the link (default=false)
title - page title to use with newpage menulink
template - template to use with newpage menulink
LAYOUTID:resource.ext - a resource in a specific layout
@current:resource.ext - a resource in the current layout
@parent:resource.ext - a resource in the current layouts parent
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
templatename - the name of a space or global template
If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available
view - Used only for newpage menulink in conjunction with builder templates, takes the user to the viewpage rather tha editpage (default - false)
layout - the layoutId to use when the link is used
latch - whether the layout should be latched when the link is used
class - The CSS class name to assign to an item in a menu
id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
location - the webui location to use with webui links
key - the webui key to use with webui links
linkId - the html id to be applied to the link
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
Generates a link to the specified piece of confluence functionality, see the userguide for more information
Parameters:
default - the piece of confluence functionality you wish to link to
RSS - go to rss feed editor
activity - show site/space activity
advanced - go to advanced config page
browse - link to browse space
builderadmin - link to builder administration
children - show/hide children toggle
colourscheme - go to colour scheme selector
comments - show/hide comments toggle
chooselayout - choose the layout
copy - copy the current page
custom - define a custom link
dashboard - go to dashboard
edit - edit the current page
emailpage - link to email page action
exportMail - export email to page
exportPDF - export page to pdf
exportWord - export page to word doc
favourite - add page to favourites
favouritespace - add space to favourites
first - the first sibling page
firstchild - the first child page
globaltemplates - display list of global templates
globallabels - show global labels heatmap
history - show account history
home - go to space home page
index - go to space index
information - show page information
labels - show labels heatmap
last - the last sibling page
lastchild - the last child page
login - go to login screen
logout - log out
mail - show space email
managelayouts - link to manage layouts
map - go to space map
move - move a page
newcomment - add a comment
newnews - create a new blogpost
newpage - create a new page
news - view space news
newspace - create a new space
next - the next sibling page
normalView - view page as normal
notationguide - link to the macro notation guide
pageView - view the page in normal mode
pageattachments - show page attachments
parent - the current page's parent
people - show the people directory
prev - the previous sibling page
printableView - view page as printable
profile - show user profile
recent - view recently updated in space
remove - delete the current page
search - links to the search screen
signup - create a new account
siteadmin - go to site administration
spaceadmin - go to space administration
spaceattachments - display space attachments
spacetemplates - display list of space templates
trimcomments - trim the comments of the current page
toggleSidebar - toggle the visibility of a sidebar
toggleVisibility - toggle the visibility of an html element
use-layout - change the layout
userspace - show user's space
viewSource - view the page source
viewattachments - show page attachments without checking attachment permission
watch - watch current page/space
watchspace - watch current space
webui - show a webui link, requires location & key parameters
wikipage - link to the page specified by the page & space parameters
tooltip - the tooltip that should be displayed by the link, use @none for blank
accesskey - the keypress that should be associated with this link
target - the target for the link (eg _blank)
space - the spacekey whose context the link generation should be calculated against
page - the title of the page whose context the link generation should be calculated against
parent - used by the exportMail link type to define the parent where the page generated from the mail shuld be created
class - the css class to be applied to the link
toggle - the html ID of the element whose visibility is to be toggled
sidebar - the name of the sidebar whose visibility is to be toggled (left/right)
link - the custom link
icon - the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)
size - the size of the icon to use
imginside - should the icon appear inside the link (default=false)
title - page title to use with newpage menulink
template - template to use with newpage menulink
LAYOUTID:resource.ext - a resource in a specific layout
@current:resource.ext - a resource in the current layout
@parent:resource.ext - a resource in the current layouts parent
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
templatename - the name of a space or global template
If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available
view - Used only for newpage menulink in conjunction with builder templates, takes the user to the viewpage rather tha editpage (default - false)
layout - the layoutId to use when the link is used
latch - whether the layout should be latched when the link is used
checkexists - whether userspace menulink should check to see if the user has a personal space (default false)
force - force the comments or children link to be displayed when there are no comments or children to the page (default false)
forceicon - force the icon to be displayed irrespective of the layout (default false)
location - the webui location to use with webui links
key - the webui key to use with webui links
linkId - the html id to be applied to the link
flag - Will only be rendered if any of the flags have been set using set-flag.
notflag - Will not be rendered if any of the flags have been set using set-flag.
Used to display a chunk of wiki-markup dependant on what is being displayed
Parameters:
context - comma separated list of contexts (the kind of page being displayed eg: page, blogpost, dashboard) where the content should be shown
mode - comma separated list of modes that the content is being viewed as (eg: view, edit) where the content should be shown
decorator - comma separated list of decorators (eg: printable) where the content should be shown
action - comma separated list of actions (eg: viewpage/login/logout) where the content should be shown
spacekey - the space against which permission checks will be made (default current space)
pagetitle - the page against which permission checks will be made (default current page)
space - comma separated list of spaces if the content is within one of these spaces then it will be shown, the type of space can also be checked through the @global and @personal meta keys
exists - the name of a confluence page whose existance defines whether the content should be shown (@parent can be used to show data if the page not at the root level, @child/@children can be used to show data if the page has children, @childless can be used to show data if the page has no children)
pluginkey - the key of a plugin which must be enabled for the content to be shown
spacelabel - comma separated list of labels applied to the space for which the content should be shown
teamlabel - comma separated list of team-labels applied to the space for which the content should be shown
label - comma separated list of labels for which the content should be shown (recursable)
metadata - comma separated list of metadata name:value pairs where the content should be shown (recursable)
hastitle - the title that the page must have for the content to be shown (recursable)
recurse - check the page's parents for the value (default false)
withuser - username that user/group/permission checks should be run against (inc @anonymous, @creator, @author, @current - default = @current)
user - comma separated list of usernames that should view the content (inc @anonymous, @creator & @author)
group - comma separated list of groups whose members should should view the content (inc @anonymous, @creator & @author)
permission - comma separated list of permissions who can view the content (view, comment, label, createpage, createnews, edit, remove, attach, export, createspace, spaceadmin, siteadmin)
restriction - display content if the page has a restriction in place (none/view/edit/vieworedit/viewandedit - recursable)
useragent - comma separated list of strings which if found in the user agent will display the content
attachment - comma separated list of filenames, one of which must be attached to the current page for the content to be displayed (use attachment= with no value to show based on whether there are any attachments)
olderthan - show if current page was modfied before the given time period from the current date, eg olderthan=1y6m1d1h (year/month/day/hour)
newerthan - show if current page was modfied after the given time period from the current date, eg newerthan=1y6m1d1h (year/month/day/hour)
ip - comma separated list of ip addresses to which the content should be shown
layout - a comma separated list of layouts to match the currently used layout, or @DEFAULT for the space default layout
flag - a comma separated list of flags to check, will only show if at least one of the flags is present
notflag - a comma separated list of flags to check, will only show if none of the flags are present
parameters - a comma separated list of parameter name:value pairs where the content should be shown
locale - a comma separated list of locales (eg: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC") where the content should be shown
resource - a comma separated list of layout resource identifiers, one of which must be attached to the layout for the content to be shown (eg: @current::filename.ext, LAYOUTID::filename.ext, @parent::filename.ext)
Used to hide a chunk of wiki-markup dependant on what is being displayed
Parameters:
context - comma separated list of contexts (the kind of page being displayed eg: page, blogpost, dashboard) where the content should be hidden
mode - comma separated list of modes that the content is being viewed as (eg: view, edit) where the content should be hidden
decorator - comma separated list of decorators (eg: printable) where the content should be hidden
action - comma separated list of actions (eg: viewpage/login/logout) where the content should be hidden
spacekey - the space against which checks will be made (default current space)
pagetitle - the page against which checks will be made (default current page)
space - comma separated list of spaces if the content is within one of these spaces then it will be hidden, the type of space can also be checked through the @global and @personal meta keys
exists - the name of a confluence page whose existance defines whether the content should be hidden (@parent can be used to hide data if the page not at the root level, @child/@children can be used to hide data if the page has children, @childless can be used to hide data if the page has no children)
pluginkey - the key of a plugin which must be enabled for the content to be hidden
spacelabel - comma separated list of labels applied to the space for which the content should be hidden
teamlabel - comma separated list of team-labels applied to the space for which the content should be hidden
label - comma separated list of labels for which the content should be hidden (recursable)
metadata - comma separated list of metadata name:value pairs where the content should be hidden (recursable)
hastitle - the title that the page must have for the content to be hidden (recursable)
recurse - check the page's parents for the value (default false)
withuser - username that user/group/permission checks should be run against (inc @anonymous, @creator, @author, @current - default = @current)
user - comma separated list of usernames that should not view the content (inc @anonymous, @creator & @author)
group - comma separated list of groups whose members should not should view the content (inc @anonymous, @creator & @author)
permission - comma separated list of permissions who cannot view the content (view, comment, createpage, createnews, edit, remove, attach, export, createspace, spaceadmin, siteadmin)
restriction - hide content if the page has a restriction in place (none/view/edit/vieworedit/viewandedit - recursable)
useragent - comma separated list of strings which if found in the user agent will hide the content
attachment - comma separated list of filenames, one of which must be attached to the current page for the content to be hidden (use attachment= with no value to hide based on whether there are any attachments)
olderthan - hide if current page was modfied before the given time period from the current date, eg olderthan=1y6m1d1h (year/month/day/hour)
newerthan - hide if current page was modfied after the given time period from the current date, eg newerthan=1y6m1d1h (year/month/day/hour)
ip - comma separated list of ip addresses from which the content should be hidden
layout - a comma separated list of layouts to match the currently used layout, or @DEFAULT for the space default layout
flag - a comma separated list of flags to check, will only hide if at least one of the flags is present
notflag - a comma separated list of flags to check, will only hide if none of the flags are present
parameters - a comma separated list of parameter name:value pairs where the content should be hidden
locale - a comma separated list of locales (eg: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC") where the content should be hidden
resource - a comma separated list of layout resource identifiers, one of which must be attached to the layout for the content to be hidden (eg: @current::filename.ext, LAYOUTID::filename.ext, @parent::filename.ext)
Very similar to the include macro in that it is used to display the contents of another page, but in this case rendered within the context of the current page
Parameters:
_default_ - the page title or layout resource that should be imported
LAYOUTID:resource.ext - a resource in a specific layout
@current:resource.ext - a resource in the current layout
@parent:resource.ext - a resource in the current layouts parent
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
templatename - the name of a space or global template
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available
In none of the above can be found then an empty string is returned
space - an alternate way of specifying the space (default param takes precedence)
page - an alternate way of specifying the page (default param takes precedence)
flag - a comma separated list of flags to check, will only display if at least one of the flags is present
notflag - a comma separated list of flags to check, will only display if none of the flags are present
render - whether to wiki-render the imported content (default true)
output - whether to output the imported content (default true)
Used to move a chunk of HTML from one place to another on the client-side. Useful for creating areas in panels that are populated with data from pages.
Parameters:
target - the html id of the destination
hidesource - whether the source should be hidden while the page loads (defaults to true)
showtarget - whether to show the target after copying or not (defaults to true)
Used to render a chunk of wiki-markup from the perspective of another page
Parameters:
direction - the direction that the macro should look in when searching for the page to render with (REQUIRED)
ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page
descendant/descendants/down - search for the page to render with amongst the descendants of the start page
sibling/siblings - search for the page to render with amongst the siblings of the start page
children - search for the page to render with amongst the children of the start page
none - dont search, just use the start page
startPage - the page to start the search from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
searchMode - list/single (default = single - Find the first page that matches)
Used to render a chunk of wiki-markup from the perspective of an ancestor page
Parameters:
startPage - the page to start the search from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
searchMode - list/single (default = single - Find the first page that matches)
Used to render a chunk of wiki-markup from the perspective of an descendant page
Parameters:
startPage - the page to start the search from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
searchMode - list/single (default = single - Find the first page that matches)
Used to render a chunk of wiki-markup from the perspective of a sibling page
Parameters:
startPage - the page to start the search from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
searchMode - list/single (default = single - Find the first page that matches)
direction - the direction that the macro should look in when searching for the pages to render with (REQUIRED)
ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page
descendant/descendants/down - search for the page to render with amongst the descendants of the start page
sibling/siblings - search for the page to render with amongst the siblings of the start page
children - search for the page to render with amongst the children of the start page
none - dont search, just use the start page
startPage - the page to start the search from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
excerpt - include the excerpt in the output (default false)
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
excerpt - include the excerpt in the output (default false)
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
excerpt - include the excerpt in the output (default false)
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
excerpt - include the excerpt in the output (default false)
space - comma separated list of spaces, one of which the page must be in
title - comma separated list of titles which the page must have
label - comma separated list of labels which the page must have at least one
metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid
default - if specified, and a page is not found, then this page will be used instead
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)
reverse - List the pages in reverse order
count - The number of pages that should be displayed
start - Offset from the start for listing the pages
Very similar to the include macro in that it is used to display the contents of another page, but in this case rendered within the context of the current page
Parameters:
_default_ - Page whose children the excerpt should be randomly selected from
SPACEKEY:pagename - a specific page in a specific space
pagename - a specific page in the current space
@self - the current page
@current - same as @self
@parent - the parent of the current page
@space - the currently viewed space showing all top-level pages
@orphan - same as @space
@root - the root of the current page's tree
@home - the homepage of currently viewed space
space - an alternate way of specifying the space (default param takes precedence)
page - an alternate way of specifying the page (default param takes precedence)
title - output the page title (default - true)
link - add more link to the page whose excerpt is being displayed (default - true)
more - text to use for the link to the page (default - 'More ...')
label - comma separated list of labels which the content must have at least one for it to be shown
class - the css classname to add to the outer div
count - the number of excerpts to be shown (default 1)
hide - whether to hide the extra excerpts or not (default false)
Displays a simple table of all the content (pages, comments, blog posts, user profiles and space descriptions) created by a user (here 'fred').
{index}
Displays an index of all the pages in the current space, cross linked and sorted alphabetically.
{include:Home}
{include:FOO:Home}
{include:spaceKey=FOO|pageTitle=Home}
Includes one page within another (this example includes a page called "Home"). Pages from another space can be included by prefacing the page title with a space key and a colon.
The user viewing the page must have permission to view the page being included, or it will not be displayed.
{replace-and-render}
{replace-body}{div:align=%alignment%}this is some text{div}{replace-body}
{replace-item:%alignment%}center{replace-item}
{replace-and-render}
Defines a replace-and-render collection of body and items
icon: - (optional) if "false", dont display the icon.
Handy Hint
Join the Confluence Mailing-List!
{noformat}
preformatted piece of text so *no* further _formatting_ is done here
{noformat}
Makes a preformatted block of text with no syntax highlighting. All the optional parameters of {panel} macro are valid for {noformat} too.
nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
Example:
preformatted piece of text so *no* further _formatting_ is done here
{panel}Some text{panel}
{panel:title=My Title}Some text with a title{panel}
{panel:title=My Title| borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor=#FFFFCE}
a block of text surrounded with a *panel*
yet _another_ line
{panel}
Embraces a block of text within a fully customizable panel. The optional parameters you can define are the following ones:
title: Title of the panel
borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
borderColor: The color of the border this panel uses
borderWidth: The width of the border this panel uses
bgColor: The background color of this panel
titleBGColor: The background color of the title section of this panel
Example:
My Title
a block of text surrounded with a panel
yet another line
{clickable:tooltip|link}content{clickable}
Makes the contained content clickable. The link can be a page title (including space key if desired) or a URL.
{lozenge:title=Adaptavist.com|link=http://adaptavist.com|color=red}Click to visit...{lozenge}
Inserts a graphical lozenge panel, ideal for creating buttons, etc.
Parameters:
link - if you want to link to a page, insert the page title or url
icon - if you want to display an icon (48x48 pixels or smaller) in the left
panel, use wiki notaiton for an image. Alternatively, specify normal
text to display text in the left panel.
color - the color of the left panel: bronze, silver (default), gold, blue, cyan, green, purple, pink, red
arrow - display or hide the arrow in the left panel: none (default if no link), blue (default if link specified), green
title - the title of the lozenge, also used as the tooltip for links
width - the width of the entire lozenge specified as pixels (347px default), percentage (eg. 70%) or auto to stretch to fit contents.
default - no parameters - Search the current space
default - spacekey - Search a specific space, list of spaces, @all spaces, @personal spaces, @global spaces, @favourite spaces, @current space (default)
teams - filter the list of spaces by team labels (only the selected space is searched)
group - group results by space/type/@select
lastModified - filter list of search results by last modified date (today/yesterday/lastweek/lastmonth/@select)
type - only return objects of type (page/blogpost/mail/comment/attachment/userinfo/spacedesc/@select)
globalText - The text to use for labeling global searches (Global Spaces)
personalText - The text to use for labeling personal searches (Personal Spaces)
favouritesText - The text to use for labeling global searches (Favourite Spaces)
allText - The text to use for labeling global searches (All Spaces)
buttonText - The text to use for the search button (Search)
label - adds a label to the search input
accesskey - adds an access key to the search button
button - Display the search button (true/false)
all - Search all spaces - overrides spaces list (true/false)
Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.
Parameters:
title - displays wiki content in the space above the main content area between the upper corners
footer - displays wiki content in the space below the main content area between the lower corners
bgcolor - the background color of the content area
titlebgcolor - the background color of the title area (defaults to bgcolor)
footerbgcolor - the background color of the footer area (defaults to bgcolor)
width - the width of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
height - the minimum height of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
cornersize - defines the radius of the rounded corners
hSize - overrides cornersize to allow setting of the width of the corners
vSize - overrides cornersize to allow setting of the height of the corners
corners - a comma separated list of flags stating which corners should be rounded: Top Left, Top Right, Bottom Left, Bottom Right (default is true,true,true,true)
rows - a comma separated list of flags stating which rows should be displayed: Top, Middle, Bottom (default is true,true,true)
antialias - use Adobe Flash to antialias the corners (default false)
class - a list of classes to be applied to the roundrect table
Inserts comments into wiki markup, without arguments the macro produces an HTML comment in the output, when the 'hidden' flag is passed the comment is not output to HTML
abbr - Specifies an abbreviated version of the content in a cell
align - Specifies the horizontal alignment of cell content
axis - Defines a name for a cell
bgcolor - Specifies the background color of the table cell
char - Specifies which character to align text on
charoff - Specifies the alignment offset to the first character to align on
colspan - Indicates the number of columns this cell should span
headers - A space-separated list of cell IDs that supply header information for the cell. This attribute allows text-only browsers to render the header information for a given cell
height - Specifies the height of the table cell
nowrap - Whether to disable or enable automatic text wrapping in this cell
rowspan - Indicates the number of rows this cell should span
scope - Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it
valign - Specifies the vertical alignment of cell content
abbr - Specifies an abbreviated version of the content in a cell
align - Specifies the horizontal alignment of cell content
axis - Defines a name for a cell
bgcolor - Specifies the background color of the table cell
char - Specifies which character to align text on
charoff - Specifies the alignment offset to the first character to align on
colspan - Indicates the number of columns this cell should span
headers - A space-separated list of cell IDs that supply header information for the cell. This attribute allows text-only browsers to render the header information for a given cell
height - Specifies the height of the table cell
nowrap - Whether to disable or enable automatic text wrapping in this cell
rowspan - Indicates the number of rows this cell should span
scope - Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it
valign - Specifies the vertical alignment of cell content
Ways to include, summarise or refer to other Confluence content.
Notation
Comment
!quicktime.mov!
!spaceKey:pageTitle^attachment.mov!
!quicktime.mov|width=300,height=400!
!media.wmv|id=media!
Embeds an object in a page, taking in a comma-separated of properties.
Default supported formats:
Flash (.swf)
Quicktime movies (.mov)
Windows Media (.wma, .wmv)
Real Media (.rm, .ram)
MP3 files (.mp3)
Other types of files can be used, but may require the specification of the "classid", "codebase" and "pluginspage" properties in order to be recognised by web browsers.
Common properties are:
width - the width of the media file
height - the height of the media file
id - the ID assigned to the embedded object
Due to security issues, files located on remote servers are not permitted Styling
By default, each embedded object is wrapped in a "div" tag. If you wish to style the div and its contents, override the "embeddedObject" CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format "embeddedObject-ID" are used.
patterns: - (optional) a comma separated list of regular expressions. Only file names matching one of these are displayed.
old: - (optional) if "true", display old versions of attachments as well.
upload: - (optional) if "true", allow the upload of new attachments.
{bookmarks}
Displays a list of bookmarks using the criteria supplied.
Searching Options
spaces comma separated list of spaces to search for. Meta space names @all, @personal, @global can also be used. (If no labels and spaces are supplied will default to current space.)
labels list of labels that are applied to the bookmarks. (If multiple labels are specified bookmarks only have to match one label to be included.)
creators comma separated list of users that have created bookmarks.
Sorting Options
sort comma separated list of attributes to sort the bookmarks by. Valid values are:
creation Bookmark Created Date
creator Bookmark Creator Name
title Bookmark title
Default is by created date.
reverseSort Reverse the order of the bookmarks. Default is false.
Display Options All options default to true.
showAuthor
The user that created the bookmark.
showDate
The relative date the bookmark was created.
showDescription
The bookmark description.
showEditLinks
If the current user has permission, show quick links to edit or remove the bookmark.
showLabels
The labels for the bookmark.
showListHeader
The bookmark list header (with the rss feed link).
max
The maximum number of bookmarks to display. Defaults to 15.
Provides page hierachal tree within a space. If no parameters are specified the root of the tree will
be the home page, a different root page can be specified by providing the page to the root
parameter.
root: - (optional) page where the tree would be rooted from. Meta root names @self, @parent, @home can also be used.
sort: - (optional) sorts the tree node. It my be one of the following: bitwise, creation, modified, natural, position. Default sorting is position
excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false).
reverse: - (optional) true/false flag that allows you to reverse the order of the display (default is false).
searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false).
expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false).
startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1).
{pagetreesearch}
{pagetreesearch:rootPage=PageName}
{pagetreesearch:rootPage=Space:PageName}
Provides a search box to search a page hierachal tree within a space.
If no parameters are specified the root of the tree will be the current
page, a different root page can be specified by providing the page to the rootPage parameter.
Creates a Table of Contents for headings on the the current page.
type - (optional) The type of output. May be one of the following:
list - (default) The headings are output in hierarchical list format.
flat - The headings are listed on a single line with a separator between them.
class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
style - (optional) The style of the list items if in list mode. The style may be any of the following:
none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
any CSS style - Headings are output in indented lists with the specified CSS style.
outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
ident - (optional) The amount to indent each list sub-heading by (default is '10px').
separator - (optional) The type of separator to use if the style is flat. May be one of the following:
bracket - Square brackets ('[', ']') surrounding each item. (default)
brace - Square brackets ('[', ']') surrounding each item. (default)
comma - A comma (',') between each item.
paren - Parentheses ('(', ')') surrounding each item.
pipe - A pipe ('|') between each item.
newline - A line break after each item.
"custom" - Any other character you wish, specified between quotes.
minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
Creates a Table of Contents for headings contained in the macro body.
location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations.
type - (optional) The type of output. May be one of the following:
list - (default) The headings are output in hierarchical list format.
flat - The headings are listed on a single line with a separator between them.
class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
style - (optional) The style of the list items if in list mode. The style may be any of the following:
none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
any CSS style - Headings are output in indented lists with the specified CSS style.
outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
ident - (optional) The amount to indent each list sub-heading by (default is '10px').
separator - (optional) The type of separator to use if the style is flat. May be one of the following:
bracket - Square brackets ('[', ']') surrounding each item. (default)
brace - Square brackets ('[', ']') surrounding each item. (default)
comma - A comma (',') between each item.
paren - Parentheses ('(', ')') surrounding each item.
pipe - A pipe ('|') between each item.
newline - A line break after each item.
"custom" - Any other character you wish, specified between quotes.
minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
Creates a table of contributor information from the current page or a group of pages.
Table Options
groupby - (optional) Specify if the table should be grouped by contributors or pages. Default value is contributors
columns - (optional) Specify the columns that should appear in the table as a comma separated list. Default value is edits,comments,labels. Valid values:
edits Edit Count Column
edited List of pages or contributors
comments Comment Count Column
commented List of pages or contributors
labels Label Count Column
labeled List of pages or contributors
labellist List of labels
watches Watch Count Column
watching List of pages or contributors
lastupdate Last time a page was updated or a contributor changed some content.
order - (optional) The order the contributors or pages will appear in. By default the table is ordered by the number of edits.
edits Orders the list with the highest number of edits first in the list
name Orders the list by name alphabetically
editTime Orders the list by the time they last edit time
update Order by the last update time of any content
reverse - (optional) If true the sort order will be reversed.
limit - (optional) Limit the number of contributors displayed to this amount
showAnonymous - (optional) Show updates by anonymous users. Default is false.
showZeroCounts - (optional) If all the selected columns are zero, or empty should the contributor or page be displayed in the table. Default is false.
Page Searching Options
The following parameters control what pages are used to build the contributors list.
page The page to count statistics from. If no spaces or labels are specified this will default to the current page.
labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)
spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The following shortcut space names can also be used:
@all All Spaces
@global All Global Spaces
@personal All Personal Spaces
contentType Valid options are:
pages
blogposts
If not specified blog posts and pages are included.
publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
children include statistics from the immediate children of the page
descendants include statistics from all descendants of the page
Creates a list of contributors who have contributed to a page or a list of pages.
Display Options
include - (optional) What type of content from the pages to base the contributor list (and the counts) on. Multiple values can be specified with a comma separated list
authors Include page authors (default).
comments Include page comments
labels Include page labels
watches Include page watches
order - (optional) The order the contributors will appear in.
count Order by the total count (default)
name Order by the names of the contributors
update Order by the last update time
Both the count and update orderings will use values from only the content specified with the include parameter.
reverse - (optional) If true the sort order will be reversed.
limit - (optional) Limit the number of contributors initially displayed to this amount
mode - (optional) Sets the display mode of the macro
inline The contributors will be displayed across the screen (default)
list The contributors will be displayed in a list down the screen
showAnonymous - (optional) Show edits by anonymous users. Default is false.
showCount - (optional) Show the count for each user. Default is false.
showLastTime - (optional) Show the last time a contribution was made by each user for any content specified by the include parameter. Default is false.
Page Searching Options
The following parameters control what pages are used to build the contributors list.
page The page to count statistics from. If no spaces or labels are specified this will default to the current page.
labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)
spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The followingshortcut space names can also be used:
@all All Spaces
@global All Global Spaces
@personal All Personal Spaces
contentType Valid options are:
pages
blogposts
If not specified blog posts and pages are included.
publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
children include statistics from the immediate children of the page
descendants include statistics from all descendants of the page
Advanced Options
showPages - show a list of pages returned above the list. Useful for debugging.
noneFoundMessage - override the default message that is displayed when no contributors are found.
Embeds the content of a file attachment into a Confluence page.
Supported formats:
Microsoft Word Documents
- Embedded as html
Microsoft Excel Spreadsheets
- Embedded as html
Microsoft Powerpoint Presentations
- Embedded in a flash slideshow control or as a single image for individual pages
Adobe PDF files
- Embedded in a flash slideshow control or as a single image for individual pages
space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}
Macro arguments specific to Excel spreadsheets
grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
row - (optional)the last row in the worksheet to render. The default is the last row with content.
col - (optional)the last column in the worksheet to render. The default the last column with content.
Macro arguments specific to Powerpoint and PDF presentations
slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
height - (optional)overrides the default height of the flash control or image.
width - (optional)overrides the default width of the flash control or image.
Embeds the content of a file attachment into a Confluence page.
Supported formats:
Microsoft Word Documents
- Embedded as html
Microsoft Excel Spreadsheets
- Embedded as html
Microsoft Powerpoint Presentations
- Embedded in a flash slideshow control or as a single image for individual pages
Adobe PDF files
- Embedded in a flash slideshow control or as a single image for individual pages
space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}
Macro arguments specific to Excel spreadsheets
grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
row - (optional)the last row in the worksheet to render. The default is the last row with content.
col - (optional)the last column in the worksheet to render. The default the last column with content.
Macro arguments specific to Powerpoint and PDF presentations
slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
height - (optional)overrides the default height of the flash control or image.
width - (optional)overrides the default width of the flash control or image.
spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
events: - (optional) a comma-separated list of events to restrict content usage based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
timespan: - (optional) restrict the timespan of popularilty from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1d (1 day) is used by default.
period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.
spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
labels: - (optional) a comma-separated list of labels to restrict content to.
display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1w (1 week) is used by default.
events: - (optional) a comma-separated list of events to restrict content popularity based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
max: - (optional) the maximum number of popular content to display (10 by default).
style: - (optional) the style to display the popular content in (table by default). Allowed style values are 'list', 'table' and 'flat'.
spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
events: - (optional) a comma-separated list of events to restrict top users based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1w (1 week) is used by default.
period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.
{children}
{children:all=true}
{children:depth=x}
{children:depth=x|style=h3}
{children:excerpt=true}
{children:page=Another Page}
{children:page=/}
{children:page=SPACEKEY:}
{children:page=SPACEKEY:Page Title}
{children:first=x}
{children:sort=<mode>|reverse=<true or false>}
Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants.
The 'style' attribute can be any of 'h1' through 'h6'. If you specify a style, the top level of child pages will be displayed as headings of that level, with their children then displayed as lists below. A great way to throw together a quick contents page!
You can view the children of a different page in the same space with {children:page=Another Page Title}.
If you specify a page of '/', you will list all the pages in the space with no parent (i.e. the top-level pages), excluding the current page
If you specify a page of 'FOO:' (the colon is required), you will list all the pages with no parent in the space with key "FOO".
Specify 'excerpt=true' to also display the first line of the pages excerpt (see the excerpt macro) if it exists.
Example:
child
another child
child
first grandchild
another child
The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date. Use the reverse attribute to optionally reverse the sorting.
The 'first' attribute allows you to restrict the number of children displayed at the top level.
{search:query=my_query}
{search:query=my_query|maxLimit=x}
Does an inline site search.
query: your query
maxLimit=x: (where x is any number > 0) to limit the search result to a number of results.
spacekey: specify the key of the space you want to search in
type: specify the content type (could be page, comment, blogpost, attachment, userinfo, spacedesc)
lastModified: specify a time period in which the content was last modified: (e.g. 3d = modified in the last 3 days, 1m3d = modified in the last month and three days)
contributor: specify the username of the contributor of the content to be retrieved
Example:
Found 2 result(s) for home
Home(My Space) This is the
home page for My Space.
Displays the most recent blog posts in this space.
content - lets you choose whether to display each blog post in its entirety (the default), just short excerpts from each item (see the excerpt macro), or just a list of post titles.
time - lets you choose how far back to look for blog posts. For example, "time=12h" would show you those items made in the last twelve hours, and "time=7d" would show items made in the last week. (The default is no limit)
label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
spaces - (optional) spaces to search. Accepted values:
space keys (case-sensitive)
@self: current space
@personal: personal spaces
@global: global spaces
@favorite/@favourite: user's favourite spaces
@all/*: all spaces (that the user has permission to view)
Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
type - (optional) search for types of content. Accepted values:
page: basic pages
comment: comments on pages or blogs
blogpost/news: blog posts
attachment: attachments to pages or blogs
userinfo: personal information
spacedesc: space descriptions
personalspacedesc: personal space descriptions
mail: emails in a space
Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
max/maxResults - (optional) the maximum number of results to return. Defaults to 100.
sort - (optional) the sorting to apply to the results. Accepted values:
title: by content title
creation: by time of creation
modified: by time of last modification (creation is the "first" modification)
reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.
{excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt}
{excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt}
Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content.
hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.
{excerpt-include:Home}
{excerpt-include:Home|nopanel=true}
{excerpt-include:blogPost=/2006/12/28/News Page}
Includes the excerpt from one page (see the excerpt macro) within another. The included page must be in the same space as the page on which the macro is used.
nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
{popular-labels}
{popular-labels:style=heatmap|count=15}
Renders a list (or heatmap) of the most popular labels ordered by popularity (or name).
count - (optional) Specify the number of labels to be displayed. If not specified, a default of 100 is used.
spaceKey - (optional) Restrict the popular labels to a certain space.
style - (optional) Allows 'heatmap'. Specifying a heatmap style will use different font sizes depending on their rank of popularity, ordered by label names. If not specified, a default list style is used ordered by popularity (highest first).
Displays a list of content marked with the specified labels.
type - (optional) search for types of content. Accepted values:
page: basic pages
comment: comments on pages or blogs
blogpost/news: blog posts
attachment: attachments to pages or blogs
userinfo: personal information
spacedesc: space descriptions
personalspacedesc: personal space descriptions
mail: emails in a space
Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
showLabels - (optional) display the labels for each results (enabled by default)
showSpace - (optional) display space name for each result (enabled by default)
title - (optional) add a title above the results list
max/maxResults - (optional) the maximum number of results to display (default is 5)
excerpt - (optional) display first line of excerpt for each result
space/spaces - (optional) spaces to search. Accepted values:
space keys (case-sensitive)
@self: current space
@personal: personal spaces
@global: global spaces
@favorite/@favourite: user's favourite spaces
@all/*: all spaces (that the user has permission to view)
Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
sort - (optional) the sorting to apply to the results. Accepted values:
title: by content title
creation: by time of creation
modified: by time of last modification (creation is the "first" modification)
reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.
{related-labels}
{related-labels:labels=labelone, labeltwo}
Renders a list of labels related to the current page's labels.
labels - (optional) comma-separated list of labels whose related labels will be displayed.
Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%
space/spaces - (optional) spaces to search. Accepted values:
space keys (case-sensitive)
@self: current space
@personal: personal spaces
@global: global spaces
@favorite/@favourite: user's favourite spaces
@all/*: all spaces (that the user has permission to view)
Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces. Defaults to the current space (@self).
label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
width - (optional) width of table on Confluence page, defaults to 100%.
type/types - (optional) search for types of content. Accepted values:
page: basic pages
comment: comments on pages or blogs
blogpost/news: blog posts
attachment: attachments to pages or blogs
userinfo: personal information
spacedesc: space descriptions
personalspacedesc: personal space descriptions
Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces. Defaults to all types. In shared mode, the personal information type is excluded from the defaults.
{recently-used-labels}
{recently-used-labels:scope=space|count=15}
Renders a list (or table) of labels most recently used in a specified scope.
count - (optional) Specify the number of labels to be displayed. If not specified, a default of 10 is used.
scope - (optional) Allows 'global', 'space' and 'personal'. If not specified, the 'global' scope is used. The global scope will show labels that were recently used within this confluence instance. The space scope will show labels that were recently used in the current space. The personal scope will show you personal labels that you recently used.
style - (optional) Allows 'table'. Specifying a table style will render the most recently used labels in a table form.
title - (optional) Allows you to specify a heading for the table view of this macro. See the 'style' option above.
Renders the list of pages associated with the specified label as a navigable map.
A label must be specified for this macro. The following parameters are all optional:
title - the title for this navigation map.
wrapAfter - the number of cells to span horizontally before wrapping to the next line. (default: 5)
cellWidth - width of individual cells in the map in pixels. (default: 90px)
cellHeight - height of individual cells in the map in pixels. (default: 60px)
theme - if you want to create your own look and feel for the navmap (say one with rounded corners), you can do so by adding a file to the WEB-INF/classes/templates/macros directory. The file name convention to use is: navmap-mytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you specify this when calling the macro using theme=mytheme.
Creates a list of pages which link to the current page.
Wiki content may be included as the body to be shown if no links exist.
Display Options
page - The page to search on.
mode - The mode in which incoming links are displayed. Available modes:
list - Links are displayed in a bullet-pointed list.
flat - Links are displayed in a single row, with a separator between each item.
separator - The style of separator to have. Defaults to ', ' when in flat mode.
Available separators:
brackets - Each item is surrounded by square brackets ('[' and ']').
braces - Each item is surrounded by curly braces ('{' and '}').
parens - Each item is surrounded by parentheses ('(' and ')').
pipe - Each item is separated by a pipe ('|').
other - The value is the separator.
style - The style of the bullet points. Some styles may not be available depending on the mode.
Available styles:
icons - displays the Confluence page-type icon (default)
none - no bullet point displayed
other CSS styles - disc, square, upper-roman, lower-roman, etc
excerpt - Will output any excerpts which have been set on the linking page.
sort - Allows the sort order to be specified. More than one sort may be specified
and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate
the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
natural title - Sorted by the unicode-safe natural order of the content title. (Default)
exact title - Sorted by the exact content title.
creation date - Sorted by the creation date of the content.
modification date - Sorted by the last-modified date of the content.
space key - Sorted by the space key the content is contained in.
space name - Sorted by the unicode-safe natural order of the space name.
maxResults - Outputs up to this number of results. Default is unlimited.
Filtering Options
In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:
labels=foo, -bar
If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:
labels="foo-bar"
This will work for all filter properties below.
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one
of the following special values:
@all - All spaces, both personal and global
@personal - All personal spaces
@global - All non-personal spaces
@favourites - All the current user's favourite spaces
types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
page - Wiki pages
news - Blog/News posts
comment - Page or blog comments
spacedescription - Space description
userinfo - User profile
attachment - An attachment
mail - Mail archive
mailto - A 'mailto' link
url - An external URL.
unresolved - An unresolved link.
{outgoing-links}No links exist{outgoing-links}
{outgoing-links:style=square|excerpt=true}
{outgoing-links:scope=Another Page>children}
{outgoing-links:scope=A Different Page>descendents}
{outgoing-links:spaces=MYSPACE}
{outgoing-links:types=page,comment}
Creates a list of pages, websites and email addresses the current page links to.
Wiki content may be included as the body to be shown if no links exist.
Display Options
page - The page to search on.
mode - The mode in which links are displayed. Available modes:
list - Links are displayed in a bullet-pointed list.
flat - Links are displayed in a single row, with a separator between each item.
separator - The style of separator to have. Defaults to ', ' when in flat mode.
Available separators:
brackets - Each item is surrounded by square brackets ('[' and ']').
braces - Each item is surrounded by curly braces ('{' and '}').
parens - Each item is surrounded by parentheses ('(' and ')').
pipe - Each item is separated by a pipe ('|').
other - The value is the separator.
style - The style of the bullet points. Some styles may not be available depending on the mode.
Available styles:
icons - displays the Confluence page-type icon (default)
none - no bullet point displayed
other CSS styles - disc, square, upper-roman, lower-roman, etc
excerpt - Will output any excerpts which have been set on the linking page.
sort - Allows the sort order to be specified. More than one sort may be specified
and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate
the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
natural title - Sorted by the unicode-safe natural order of the content title. (Default)
exact title - Sorted by the exact content title.
creation date - Sorted by the creation date of the content.
modification date - Sorted by the last-modified date of the content.
space key - Sorted by the space key the content is contained in.
space name - Sorted by the unicode-safe natural order of the space name.
maxResults - Outputs up to this number of results. Default is unlimited.
Filtering Options
In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:
labels=foo, -bar
If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:
labels="foo-bar"
This will work for all filter properties below.
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one
of the following special values:
@all - All spaces, both personal and global
@personal - All personal spaces
@global - All non-personal spaces
@favourites - All the current user's favourite spaces
types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
page - Wiki pages
news - Blog/News posts
comment - Page or blog comments
spacedescription - Space description
userinfo - User profile
attachment - An attachment
mail - Mail archive
mailto - A 'mailto' link
url - An external URL.
unresolved - An unresolved link.
{orphaned-links}No links exist{orphaned-links}
{orphaned-links:style=square|excerpt=true}
{orphaned-links:scope=Another Page>children}
{orphaned-links:scope=A Different Page>descendents}
{orphaned-links:spaces=MYSPACE}
{orphaned-links:types=page,comment}
Creates a list of pages which do not have any other pages linking to them.
Wiki content may be included as the body to be shown if no links exist.
Display Options
page - The page to search on.
mode - The mode in which links are displayed. Available modes:
list - Links are displayed in a bullet-pointed list.
flat - Links are displayed in a single row, with a separator between each item.
separator - The style of separator to have. Defaults to ', ' when in flat mode.
Available separators:
brackets - Each item is surrounded by square brackets ('[' and ']').
braces - Each item is surrounded by curly braces ('{' and '}').
parens - Each item is surrounded by parentheses ('(' and ')').
pipe - Each item is separated by a pipe ('|').
other - The value is the separator.
style - The style of the bullet points. Some styles may not be available depending on the mode.
Available styles:
icons - displays the Confluence page-type icon (default)
none - no bullet point displayed
other CSS styles - disc, square, upper-roman, lower-roman, etc
excerpt - Will output any excerpts which have been set on the linking page.
sort - Allows the sort order to be specified. More than one sort may be specified
and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate
the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
natural title - Sorted by the unicode-safe natural order of the content title. (Default)
exact title - Sorted by the exact content title.
creation date - Sorted by the creation date of the content.
modification date - Sorted by the last-modified date of the content.
space key - Sorted by the space key the content is contained in.
space name - Sorted by the unicode-safe natural order of the space name.
maxResults - Outputs up to this number of results. Default is unlimited.
Filtering Options
In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:
labels=foo, -bar
If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:
labels="foo-bar"
This will work for all filter properties below.
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one
of the following special values:
@all - All spaces, both personal and global
@personal - All personal spaces
@global - All non-personal spaces
@favourites - All the current user's favourite spaces
types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
page - Wiki pages
news - Blog/News posts
comment - Page or blog comments
spacedescription - Space description
userinfo - User profile
attachment - An attachment
mail - Mail archive
mailto - A 'mailto' link
url - An external URL.
unresolved - An unresolved link.
{undefined-links}No links exist{undefined-links}
{undefined-links:style=square|excerpt=true}
{undefined-links:scope=Another Page>children}
{undefined-links:scope=A Different Page>descenents}
{undefined-links:spaces=MYSPACE}
{undefined-links:types=page,comment}
Creates a list of pages which are linked to but have not yet been created.
Wiki content may be included as the body to be shown if no links exist.
Display Options
page - The page to search on.
mode - The mode in which links are displayed. Available modes:
list - Links are displayed in a bullet-pointed list.
flat - Links are displayed in a single row, with a separator between each item.
separator - The style of separator to have. Defaults to ', ' when in flat mode.
Available separators:
brackets - Each item is surrounded by square brackets ('[' and ']').
braces - Each item is surrounded by curly braces ('{' and '}').
parens - Each item is surrounded by parentheses ('(' and ')').
pipe - Each item is separated by a pipe ('|').
other - The value is the separator.
style - The style of the bullet points. Some styles may not be available depending on the mode.
Available styles:
icons - displays the Confluence page-type icon (default)
none - no bullet point displayed
other CSS styles - disc, square, upper-roman, lower-roman, etc
excerpt - Will output any excerpts which have been set on the linking page.
sort - Allows the sort order to be specified. More than one sort may be specified
and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate
the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
natural title - Sorted by the unicode-safe natural order of the content title. (Default)
exact title - Sorted by the exact content title.
creation date - Sorted by the creation date of the content.
modification date - Sorted by the last-modified date of the content.
space key - Sorted by the space key the content is contained in.
space name - Sorted by the unicode-safe natural order of the space name.
maxResults - Outputs up to this number of results. Default is unlimited.
Filtering Options
In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:
labels=foo, -bar
If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:
labels="foo-bar"
This will work for all filter properties below.
scope - List of pages, news items, etc which are in scope. If the content is a page,
the scope can be expanded to their children, descendents or ancestors:
>children - The direct children of the specified page. Eg. 'scope=My Page>children'
>descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
>ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one
of the following special values:
@all - All spaces, both personal and global
@personal - All personal spaces
@global - All non-personal spaces
@favourites - All the current user's favourite spaces
types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
page - Wiki pages
news - Blog/News posts
comment - Page or blog comments
spacedescription - Space description
userinfo - User profile
attachment - An attachment
mail - Mail archive
mailto - A 'mailto' link
url - An external URL.
unresolved - An unresolved link.
{spaces:width=x}
Displays a list of all spaces visible to the user, with linked icons leading to various space content functionality, within a table. The width parameter specifies the table width on the page.
width - (optional) width of table on Confluence page, defaults to 100%.
Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%
spaces - (optional) comma separated list of space keys
labels - (optional) comma separated list of labels (content associated with at least one of these will be listed)
width - (optional) width of table on Confluence page, defaults to 100%.
types - Filter content by type. You can specify one or more types, separated by commas. Accepted values:
page: basic pages
comment: comments on pages or blogs
blogpost/news: blog posts
attachment: attachments to pages or blogs
userinfo: personal information
spacedesc: space descriptions
personalspacedesc: personal space descriptions
mail: emails in a space
showProfilePic - if true, display the profile pictures of the users who updated the content.
{global-reports: width=x}
Renders a list of links to global reports within a table of width x (defaults to 99%).
width - (optional) width of table on Confluence page, defaults to 50%.
{welcome-message}
Include the Confluence site welcome message. The site welcome message may be configured in the Administration -> General Configuration section.
Specifying the online value allows you to filter the user list by the user online status. Setting online=true will show only online users, whereas setting online=false will show only offline users.
If you've configured this macro to display groups which are black listed by the administrator, you will get a warning panel at the top. The warning will be automatically displayed by default. To disable the warning, you can specify showWarning=false.
External Content
Ways to include, summarise or refer to content from other servers.
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.
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)
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.
Shows a plugins compatibility with versions of a product.
key — The key of the plugin to show compatibility information of.
productStart — The starting product version to show compatibility with. For instance, you can specify a value like 2.8 and the compatibility matrix will show compatibility information of the concerned plugin with product version 2.8 and above.
productEnd — This is the same as productStart. The only difference is that this is used as the upper boundary of the product version range, instead of lower.
majorVersionsOnly — If set to true, the generated compatibility matrix will only show compatibility with major versions of the product. If this is true, the plugin will assume the concerned plugin to be compatible with a major version of a product only:
When a version of the plugin is explicitly marked compatibile with any minor version of the product, and...
The same version of the plugin is not marked incompatible with any minor version of the product.
By default, this is true.
rows — The number of the latest X versions of the plugin to show compatibility of. By default, all versions of the plugin is shown.
showBrokenBuilds — Lets you to choose whether to display broken builds as . By default, this is false and broken build cells are blank.
Displays the results of a series (or single) JUnit test.
Success Rate
Tests
Failures
Time(s)
Time(s)
93%
14
1
0
1.531
{html-include:url=http://www.host.com}
The {html-include} macro allows you to include the contents of an HTML file in a Confluence page.
CAUTION: Including unknown HTML inside a webpage is dangerous. Because HTML can contain active scripting components, it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a users authentication cookie and give the attacker their Confluence login password.
You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {html-include:url=http://example.com/path/to/target/location}. This parameter defaults to true.
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.
{excel:file=^Report.xls}
{excel:file=Year 2005^Report.xls|sheets=First Quarter, Second Quarter}
{excel:file=excel/Report.xls|sheets=1,2,4}
Displays one or more worksheets from Microsoft Excel spreadsheets (Excel 97, 2000, 2003 workbooks).
Each worksheet is shown as a table.
This macro supports common table capabilities with other table
based macros (table-plus, csv, and sql).
file - A required parameter unless url is specified. It specifies the location of the Excel 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.
filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
url - Only required if file is not specified. Specifies the URL of an Excel file.
Use of this parameter may be restricted for security reasons. See your administrator for details.
sheets - By default, each sheet in the workbook will produce a table. Use the sheets parameter to control what sheets will be shown and ordering.
The parameter value can be a comma separated list of sheet names (case sensitive) or sheet numbers (1-based counting)
columns - By default, all columns will be shown. Use the columns parameter to control the columns to show. Column ordering is not currently supported.
The parameter value can be a comma separated list of column numbers (1-based counting). Hidden columns will show if listed in the columns parameter.
output - Determines how the output is formated:
html - Data is output as a HTML table (default).
wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
border - The border width in pixels. Defaults to normal table border width.
width - The table width in pixels. Default is 100%.
showHidden - By default, hidden sheets, rows, and columns will not be shown. Set showHidden=true to show all data.
showSheetName - By default, the sheet name will not be shown. Set showSheetName=true to show a the sheet name before the table.
formatCell - By default, no special formating will be applied to the cells.
Set formatCell=true to process each cell for special properties. Currently supported properties are:
html - Font and background color.
wiki - None at this time.
formatColumn - By default, the format for a column will be used to apply formating for all cells in the column.
Set formatColumn=false to not use the column formating information from the excel sheet.
Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table.
This is used to help resolve formating issues.
escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table.
Set escape=true to allow these special characters to be escaped so that it will not affect the formatting.
The default is false so that data that has wiki markup will be handled correctly.
hyperlinks - Default is true. Set to false to disable inclusion of cell hyperlinks.
ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored.
Set ignoreTrailingBlankRows=false to show these blank rows.
ignoreTrailingBlankColumns - By default, all trailing blank columns will be ignored.
Set ignoreTrailingBlankColumns=false to show these blank columns.
language - If provided, the language and country specification will be used to provide number and date formats to be
used for data conversion. This specification will be used before the default languages automatically used.
Valid values are 2 character ISO 639-1 alpha-2 codes.
country - Used in combination with the language parameter.
Valid values are 2 character ISO 3166 codes.
Misc
Various other syntax highlighting capabilities.
Notation
Comment
\X
Escape special character X (i.e. '{')
:), :( etc
Graphical emoticons (smileys).
Notation
:)
:(
:P
:D
;)
(y)
(n)
(i)
(/)
(x)
(!)
Image
Notation
(+)
(-)
(?)
(on)
(off)
(*)
(*r)
(*g)
(*b)
(*y)
Image
Macros
Macros allow you to perform programmatic functions within a page, and can be used for generating more complex content structures.
Notation
Comment
{vote:What is your favorite color?}
Red
Blue
None of the above
{vote}
{vote:What is your favorite color?|changeableVotes=true|voters=user1,user2}
Red
Blue
None of the above
{vote}
The vote macro allows Confluence users to vote on any topic of interest.
Users are allowed to select only one of the given choices and vote one time,
and the results will not be visible to them until they have voted. Users
that have not logged in will be prompted to do so before allowing them to
cast a vote. This macro was created to support quick, informal votes on
various topics. The macro has a title and a series of choices, each choice
starting on its own line.
Parameter
Required
Default
Description
true
This is the title of the ballot and must be the first paramter.
voters
false
all users
This is a comma seperated list of usernames to who are allowed to
cast a vote. Users not in this list will not be allowed to vote, but
if they are viewers will be shown the results of the vote. If this parameter
is not specified, all users with access to the page are considered voters.
viewers
false
all users
This is a comma seperated list of usernames to who are allowed to see the survey results.
Users not in this list will be allowed to vote but
after doing so will simply be shown which item they voted for. If a user is in this
list but is not a voter, they will be taken straight to the results. If this parameter is not specified,
all users will be able to see the results.
changeableVotes
false
false
This parameter, if set to true, will allow the voters to change their vote
after it has been cast.
locked
false
false
Dont allow any further voting. Show a lock Symbol to indicate that.
{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Knowledge - This is the knowledge category.
Communication - This is the communication category.
{survey}
The survey macro allows Confluence users to be surveyed on several categories.
For each category, users are allowed to select only one of the given choices,
and the results will not be visible to them until they have voted. Users
that have not logged in will be prompted to do so before allowing them to
cast a vote. This macro was created to support surveys of confluence users
on several categories and will provide them with the chance to give a
rating (1 to 5) for each category as well as a comment.
The body of this macro defines the categories that the users will be polled
on. Each line of the body will be treated as a seperate category and
should be written in the format "title - description". The title is
always required but the dash and the description are optional.
Parameter
Required
Default
Description
title
false
default no title
If a Title is specified the Survey gets a Box around which makes it looking more compact
and feeling the votes are belonging more together.
voters
false
all users
This is a comma seperated list of usernames to who are allowed to
cast a vote. Users not in this list will not be allowed to vote, but
if they are viewers will be shown the results of the vote. If this parameter
is not specified, all users with access to the page are considered voters.
viewers
false
all users
This is a comma seperated list of usernames to who are allowed to see the survey results.
Users not in this list will be allowed to vote but
after doing so will simply be shown which item they voted for. If a user is in this
list but is not a voter, they will be taken straight to the results. If this parameter is not specified,
all users will be able to see the results.
changeableVotes
false
false
This parameter, if set to true, will allow the users to change their responses
after they have been cast.
choices
false
default 1-5
A comma separated List of choices. This will override the Default (1-5) List, but can still be overriden by
a '-' separated list in each single line.
showComments
false
true
Show comments-menu (the whole set: show, add, edit, delete)
locked
false
false
Dont allow any further voting. Show a lock Symbol to indicate that.
Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements)