Biggest heading

Bigger heading

Big Heading

Normal Heading

Small Heading

Smallest Heading

Example:

Some block quoted text

Quote a block of text that's longer than one paragraph.

here is quoteable
content to be quoted

Example: look ma, red text!

Example: pagetitle

If such a page doesn't already exist, it will allow you to create the page in the current space. Create page links will have a after them.

Example: anewpage

Example: link alias

If you attempt to link to a blog post that doesn't exist, no link will be created.

Example:

• /2004/01/12/Blog Post
  
• my link name

Examples:

• /2004/01/12/Blog Post
• my link name

Examples:

• Re: Webwork 2 Upgrade
• my link name

Examples:

• spacekey
• custom link title
• [nosuchspace:]

Examples:

• User Full Name
• custom link title
• [~nosuchuser]

Examples:

• confluence@Google
• custom link text

Note: the [] around external links are optional in the case you do not want to use any alias for the link.

Examples:

• http://confluence.atlassian.com
• Atlassian

Example: legendaryservice@atlassian.com

This only works on Internet Explorer
Creates a link to file on your computer or on a network share that you have mapped to a drive

Creates a link to an attachment. It acts in a similar way as the regular links (using '[' and ']') but it used to record versions of attachments in approvals. It can be used also to access specific versions of attachments.

When accessing older versions of approved pages, a link the then current version of the attachment will be created.

Examples:

1. Creates a link to table.xsl.

2. Creates a link to version 1 of the attachment table.xls into the page.

3. Creates a link towhatever version of the approved table.xls was current when it received the latest Reviewer approval.

4. Creates a link to table.xls displaying The table as the link name.

5. Creates a link to table.xls displaying The table as the link name and Download the file as tooltip.

Embeds an image (or media file) into the page. It acts in a similar way as the images formating (using !) but it is used to record versions of attachments in approvals. It can be used also to access specific version of images.

When accessing older versions of approved pages, the then current version of the image will be displayed.

Examples:

1. Embeds the attachment image.jpg into the page.

2. Embeds version 1 of the attachment image.jpg into the page.

3. Embeds whatever version of the approved image.jpg was current when it received the latest Reviewer approval.

4. Embeds version 2 of the flash movie mymovie.swf into the page.

Used to display the final approval status of a page or blog post.

Depending on what version of the page or blog post is viewed, a status message with shown, provided the page has of requires a final approval (defined either in a workflow or Space Approval).

The macro takes no parameter, but the messages can be changed in a workflow through the {workflowproperties} macro.

To override the messages, the property set 'page.status' must be defined using the following properties:

A macro that allows you to quickly create links to content at http://confluence.atlassian.com.

• Default parameter — The link to the content relative to http://confluence.atlassian.com.
• Macro body — The link text, interpreted as wiki markup.

Example:

• some
• bullet
• indented
• bullets
• points

Example:

• different
• bullet
• types

Example:

1. a
2. numbered
3. list

# a
# numbered
#* with
#* nested
#* bullet
# list

* a
* bulletted
*# with
*# nested
*# numbered
* list

Example:

1. a
2. numbered
   • with
   • nested
   • bullet
3. list

• a
• bulletted
  1. with
  2. nested
  3. numbered
• list

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.

What you need to type	What you will get
{dynamictasklist:Arthurs To-Do's}

Generates a checklist for a subset of pages. The rows are children pages of a given page (parent) and can be filtered by a label. The columns can be labels that are set/un-set for the pages, the excerpt or a text.

The columns of the checklist can also be defined using the {checklist-label}, {checklist-input}, {checklist-wikiinput}, {checklist-select}, {checklist-excerpt}, {checklist-include}, {checklist-wiki}, {checklist-metadata} macros.

Generates a checklist for a subset of pages. The rows are children pages of a given page (parent) and can be filtered by a label.

The columns can be labels that are set/un-set for the pages, the excerpt or a text. You can set/unset the tag in the row pages and edit the text.

Parameters value can have any of the following keywords that will be replace when rendering the page:

Examples

Lets say we have a page Animals as parent of the pages Dog, Cat, Shark, Elephant, Turtle, Salmon, Snake, Whale, Frog, Toad, Lizard, Platypus and Eagle.

In the first example, all the children of Animals are shown. The checks are for the labels mammal, oviparous and pets. Whenever any the check is selected, the appropriate label is added/removed to/from the page on the row.

In the second example, the excerpt of each page is shown, and it will show only the children of Animals that have the label oviparous and the check labels bird, fish, amphibian and reptile are mutually exclusive.

In the third example, only the children of Animals that have the label pets are shown. The excerpt of each page is shown and a comment can be added to each page in the checklist

Note how the comment text can be actual wiki content.

When used within a {checklist} macro, it defines a column as a label check. Every time a cell of this column is selected, the label will be added/removed to/from the referred page

Example

{checklist:name=Pets|parent=Animals|label=pets}
   {checklist-label:Mammal?|label=mammal}
{checklist}

When used within a {checklist} macro, it defines a column as a text input.

Example

{checklist:name=Pets names|parent=Animals|label=pets}
   {checklist-input:Common pet names|cols=20}
{checklist}

When used within a {checklist} macro, it defines a column as a wiki-text input.

Example

{checklist:name=The pets| parent=Animals| label=pets}
    {checklist-wikiinput:Comments|rows=5|cols=20|width=90%}
{checklist}

When used within a {checklist} macro, it defines a column as a selection (drop-down menu). The selection can be from a list of options, a list of labels or a list of users.

If store is set to checklist and there is only one option to select from, then the column is handled as a checkbox.

Examples

{checklist:name=Swimmers|parent=Animals|label=oviparous}
   {checklist-select:Can swim?}
      yes
      no
   {checklist-select}
{checklist}

{checklist:name=The oviparious|parent=Animals|label=oviparous}
   {checklist-select:Type|uselabels=true}
       fish|It's a fish
       amphibians|It's an amphibian
       reptiles|It's a reptile
       birds|It's a bird
   {checklist-select}
{checklist}

{checklist:name=Pets on the team|parent=Animals|label=pets}
   {checklist-select:Who owns one?|usersgroup=all}
{checklist}

When used within a {checklist} macro, it defines a column as a wiki segment to be rendered for each of the pages on the checklist.

Example

Assuming each of the pages contains an attachment photo.jpg

{checklist:name=Da pets|parent=Animals|label= pets}
   {checklist-wiki:Photo}
       !photo.jpg!
   {checklist-wiki}
{checklist}

When used within a {checklist} macro, it defines a column as the excerpt of each of the pages.

Example

{checklist:name=pets| parent=Animals| label=pets}
    {checklist-excerpt:Classification|width=10%}
{checklist}

When used within a {checklist} macro, it defines a column as a link to each of the pages.

When used within a {checklist} macro, it defines a column as the entire content of each of the pages.Use with caution, it can get really messy.

Example

{checklist:name=All the pet's pages|parent=Animals|label= pets}
   {checklist-include:Full page}
{checklist}

When used within a {checklist} macro, it defines a column as a lookup of existing metadata for each page.

Example

{checklist:name=The pets names|parent=Animals|label=pets}
   {checklist-metadata:Comments}
{checklist}

Displays the value of an attribute set on a page through a {checklist}

The second example on the side will display If you are a cat person... from any page

Generates a checklist change report for a given page.

Example

{checklist-log:format=useranddate|maxentries=1|Comments}

This macro is being deprecated. Use {checklist-label}, {checklist-excerpt} or {checklist-wikiinput} instead.

Defines more detailed column information for a {checklist}.

Note that the {checklist-column} macro must be contained within a {checklist} macro.

The {rate} macro allows visitors to rate various aspects of your content
Examples:

• allowAnonymous - false stops anonymous from rating this content (default: true)
• allowUsers - false stops logged in users from rating this content (default: true)
• theme - the theme to use (basic, v2 - default: v2)

The {rate-search} macro uses a smart list to find content based around the rating stats.
Examples:

Generic

• maxResults - the maximum number of results to return
• spaces - the comma separated list of spaces to search through
• minRates - the minimum number of rates needed for inclusion in the results

Theme: v2 (default)

• hideSpace - if true, hides the output of the space in the listings

If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed.

If no space key is defined, the current is space is used by default.

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.

For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.

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.

The code given here produces a table that looks like:

Defines a single column.

• width: - (optional) the width of the column.

If you want to use columns instead of tables, you can define them first by marking a {section}, and then placing any number of {column}s inside.

• border: - (optional) set to "true" to draw a border around the section and columns.

Example:

// Some comments here
public String getFoo()
{
  return foo;
}

<test>
    <another tag="attribute"/>
</test>

Performs setup operations for some of the composition macros. Some macros require that this has been put at the top of a page for them to work. It allows page-wide settings for macros. Its contents is a list of properties, as listed below.

Parameters:

• defaults - (optional) the link to the default property attachment. E.g. "Home^defaults.txt". This allows easy setting of defaults for multiple pages.

Properties:

• import.css - The path to the CSS file to import. May be a page attachment (eg. "^style.css") or a regular URL.
• cloak.memory.duration - The number of days to remember the state of the page. Set to 0 to disable memory altogether. Defaults to 7 days.
• cloak.toggle.type - (optional) The type of toggle to display. May be:
  • default - (default) Blue arrows pointing up or down.
  • custom - Allow custom images as the icons. You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
  • text - Allow any regular text as the icons. You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
  • wiki - Allow regular wiki text (except links). You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
  • none - No icon will be output at all. You will probably want to make sure that 'cloak.toggle.zone' is set to true with this option.
• cloak.toggle.open - If 'cloak.toggle.type' is set to 'text' or 'custom', this what the toggle will contain when the cloak contents can be expanded. E.g. If in 'text' mode, a good value might be '+'. If in 'custom' mode, either an absolute URL ('http://.../open.gif'), a relative URL ('/.../open.gif') or a Confluence attachment link ('[SPACEKEY:][Page]^open.gif') must be provided.
• cloak.toggle.close - If 'cloak.toggle.type' is set to 'text' or 'custom', this is what the toggle will contain when the cloak contents can be hidden. E.g. If in 'text' mode, a good value might be '-'. If in 'custom' mode, either an absolute URL ('http://.../close.gif'), a relative URL ('/.../close.gif') or a Confluence attachment link ('[SPACEKEY:][Page]^close.gif') must be provided.
• cloak.toggle.exclusive - (optional) If true, all cloaked sections will be exclusive - that is, only the current section will be visible at any given time. Defaults to 'false'.
• cloak.toggle.zone - (optional) If true, the paragraph or heading any toggle icons are placed in can also be clicked to toggle the associated cloak section. Defaults to 'true'.
• deck.memory.duration - The number of days to remember the state of the decks on the page. Set to 0 to disable memory altogether. Defaults to 7 days.
• deck.class - The custom CSS class to apply to all decks
• deck.tab.location - 'top', 'bottom' or 'none'. The location of the tab bar.
• deck.tab.active.border - The border for the active tab (CSS - eg. '1px dashed black')
• deck.tab.active.background - The background for the active tab (CSS - eg. '#ff0055')
• deck.tab.inactive.border - The border for inactive tabs (CSS)
• deck.tab.inactive.background - The background for inactive tabs (CSS)
• deck.tab.spacer - The distance between tabs (eg '5px')
• deck.card.border - The border for the active card.
• deck.card.background - The background for the active card.
• deck.width/deck.height - The width and/or height the content will be constrained to (not including any tabs). If not set, the tabs expand to display their content.
• deck.startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.
• deck.loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.
• deck.nextAfter - The number of seconds the slides will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
• deck.effect.type - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).
• deck.effect.duration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.

Creates a weekly booking sheet with the list of items able to be booked by logged-in users. All options below such as width, background and padding support valid CSS options for the properties of the same name.

• [default]/side - (required) The side the content will float on (left or right).
• width - (optional) The width of the floating content (eg. '100px').
• background - (optional) The background colour or picture settings.
• border - (optional) The border settings.
• margin - (optional) The margin settings.
• padding - (optional) The padding settings.

Creates a cloaked section which can be toggled between being visible and hidden.
Note: Requires that {composition-setup} is placed above it in the page.

• id - (required) The unique ID of the cloaked section.
• visible - (optional) If 'true', the section will be visible initially. Defaults to 'false'.

Creates a button to toggle a cloaked section between being visibile and hidden.
Note: Requires that {composition-setup} is placed above it in the page.

• id - (required) The unique ID of the cloaked section to toggle.
• exclusive - (optional) If true, all other sections at the same level will be cloaked when this is shown.

Creates a new deck of 'cards' - sections of content which are displayed one at a time. By default, tabs similar to those in the default Confluence theme are displayed.
Note: Requires that {composition-setup} is placed above it in the page.

• id - (required) The unique ID of the deck section.
• tabLocation Either 'top', 'bottom' or 'none'. Defaults to 'top'.
• class - The custom CSS class the deck will be placed in.
• width/height - The width and/or height the content will be constrained to (not including any tabs). If not set, the tabs expand to display their content.
• startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.
• loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.
• nextAfter - The number of seconds the slides will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
• effectType - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).
• effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.

Creates a new card. Must be inside a 'deck'. Only one card is visible at any given time.

• label - (required) The label to put on the tab.
• default - (optional) If true, the card will be the default. The last card in the deck marked as 'default' will be the default.
• accessKey - (optional) The key that, when combined with {{Ctrl}} will activate the card.
• class - (optional) The custom CSS class for the tab.
• nextAfter - The number of seconds the slide will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
• effectType - The effect to use when moving to this slide. May be 'fade' or 'none' (the default).
• effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'

Shows a card in the specified deck.

• deck - (required) The id of the deck.
• card - (required) Either the label of the card, or one of the following special labels:
• @first - Show the first card in the deck.
• @last - Show the last card in the deck.
• @next - Show the next card after the currently-visible one. If the deck loops, it will show the first card if the current card is the last.
• @prev - Show the card previous to the currently-visible one. If the deck loops, it will show the last card if the current card is the first.
• scrollTo - (optional) If set to false, the browser will not scroll to the deck. Defaults to true.

Used to create editable sub-sections

Parameters:

• default - (required) The ID used to identify the sub-section on the page, all sub-sections with the same id will end up with the same content after editing, hence this ID should be unique for the page. The ID is case-sensitive and must be specified directly after the : (colon).
• showComment - (optional) Show/Hide the comment textbox in the sub-section. Either true or false. Default to true.
• comment - (optional) Set the text of the version comment (no quote). Default : sub-section:ID edited.
• showMinorChange - (optional) Show/Hide the minorEdit checkbox in the sub-section. Either true or false. Default to true.
• minorChange - (optional) Either true or false. A minor change won't send a notification to watchers. Default to false.
• metadata - (optional) The key of the metadata in which the wikimarkup will be stored. Default: no metadata set.
All the parameters (keys and values) are case insensitive except the id.
Sub-sections use Asynchronous JavaScript and XML (AJAX).

See Also: User Guide and Examples

Makes the contained content clickable. The link can be a page title (including space key if desired) or a URL.

See Also: User Guide and Examples

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.

See Also: User Guide and Examples

Inserts a trade mark: Builder Hosting^TM

See Also: User Guide and Examples

Inserts a service mark: Builder Hosting^SM

See Also: User Guide and Examples

Inserts a registered trade mark: Adaptavist^�

See Also: User Guide and Examples

Inserts a copyright statement: � 2005 Adaptavist.com Ltd.

See Also: User Guide and Examples

Insert a style sheet in to your content.

• media - optionally specify which media types the style applies to, eg: print,aural,embossed
• import - optional URL for an external style sheet to import

See Also: User Guide and Examples

Wraps content in a span tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Sets the background color for a block of content. Colour names or hex values can be used.

There are several special pastel colours: yellow, red, blue, cyan, green (default) and purple.

See Also: User Guide and Examples

Sets the background color for a section of content such as a single word in a paragraph, etc. Colour names or hex values can be used.

There are several special pastel colours: yellow (default), red, blue, cyan, green and purple.

See Also: User Guide and Examples

Centers a block of content or text on the page or within a panel, etc.

See Also: User Guide and Examples

Attack text with a red marker just like your teacher used to at school!

See Also: User Guide and Examples

Display a privacy statement specific to a page. By default it will link to your full privacy policy on a page called "Privacy Policy

See Also: User Guide and Examples

Display a privacy indicator with optional tooltip. When clicked, the page will be focussed on a {privacy-policy} macro if present.

See Also: User Guide and Examples

Add a search box to your page:

• 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)

See Also: User Guide and Examples

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

See Also: User Guide and Examples

Wraps content in a div tag and sets the alignment mode as specified

Valid modes are left, right, center and justify. By default the {align} macro will justify your content.

See Also: User Guide and Examples

Injects a javascript CSS rollover effect into the outermost tag of the content contained by the rollover tag

Parameters:

• class - The class name for the 'normal' (roll-out) state
• over - An optional class name for the roll-over state (defaults to the '%class%-rollover'
• link - An option link to redirect the page to when the rollover is clicked
• target - An optional external target to also modify
• targetclass - An optional class name to use solely for the external target (defaults to class)
• targetover - An optional class name to use solely for the external target roll-over state(defaults to %targetclass%-rollover)

See Also: User Guide and Examples

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

See Also: User Guide and Examples

Creates a bulleted list that uses the specified image as the bullet

Parameters:

• _default_ - The image to use as the bullet in SPACEKEY:page^attachment format
• image - ann alternate way of defining the image
• id - a unique id
• padding - the padding to apply to the list items

See Also: User Guide and Examples

Displays a series of tests designed to put the content formatting macros through their paces

See Also: User Guide and Examples

Wraps content in a div tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• width - Sets the width of the element

See Also: User Guide and Examples

Wraps content in a div tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.

Parameters:

• align - Specifies how to align the iframe according to the surrounding text
• frameborder - Specifies whether or not to display a frame border
• height - Defines the height of the iframe
• longdesc - A URL to a long description of the frame contents
• marginheight - Defines the top and bottom margins of the iframe
• marginwidth - Defines the left and right margins of the iframe
• name - Specifies a unique name of the iframe (to use in scripts)
• scroling - Define scroll bars
• src - The URL of the document to show in the iframe
• width - Defines the width of the iframe
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• span - Indicates the number of columns this colgroup should span
• valign - Specifies the vertical alignment of cell content
• width - Specifies the width of the table cell

See Also: User Guide and Examples

Inserts a table.

Parameters:

• align - Aligns the table
• bgcolor - Specifies the background color of the table
• border - Specifies the border width
• cellpadding - Specifies the space between the cell walls and contents
• cellspacing - Specifies the space between cells
• frame - Specifies how the outer borders should be displayed
• rules - Specifies the horizontal/vertical divider lines
• summary - Specifies a summary of the table for speech-synthesizing/non-visual browsers
• width - Specifies the width of the table
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table row.

Parameters:

• align - Defines the text alignment in cells
• bgcolor - Specifies the background color of the table cell. Deprecated. Use styles instead
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical text alignment in cells
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

• 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
• width - Specifies the width of the table cell
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table heading cell.

Parameters:

• 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
• width - Specifies the width of the table cell
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table body.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical alignment of cell content

See Also: User Guide and Examples

Inserts a table heading.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical alignment of cell content

See Also: User Guide and Examples

Creates an ordered list tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Creates an unordered list tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Creates a list item tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.

Parameters:

• alt - Defines a short description of the image
• src - The URL of the image to display
• align - Specifies how to align the image according to surrounding text
• border - Defines a border around an image
• height - Defines the height of an image
• hspace - Defines white space on the left and right side of the image
• ismap - Defines the image as a server-side image map
• longdesc - A URL to a document that contains a long description of the image
• usemap - Defines the image as a client-side image map. Look at the
• vspace - Defines white space on the top and bottom of the image
• width - Sets the width of an image
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Used to define a set of actions to be exectuted when an event occurs. These actions are defined in the body of the macro.

Events

Used to define a state in a workflow and could contain approvals.

State transition

A page's state is transitioned to the approved state when all the approvals are given, or to the rejected state when all the defined approvals are rejected.

Alternatively, the state of a page can be changed in triggers using the {set-state} macro.

Chart parameters

You can change the way the states chart is displayed by defining Graphviz parameters using the {workflowproperties} macro with the chart properties set name.

Chart visualization requires the Graphviz Plugin to be installed

Examples

{workflow}
    {state:Draft|approved=For Review}
         {approval:Author}
    {state}
    {state:For Review|approved=To Publish|rejected=Draft}
         {approval:Reviewer}
    {state}
    {state:To Publish|approved=Published|rejected=For Review|final=true}
         {approval:Editor in Chief}
    {state}
    {state:Published}
    {state}
    {workflowproperties:chart|rankdir=LR|size=8,8}
{workflow}

Defines an approval on a page or a workflow.

Approvers selection

• define a list of users, groups or Value References by using the selectedapprover or selectedapprovers parameters
• define the approvals within a workflow
• define a preceding approval (another approval that precedes the one you want to restrict, using the hasapproval condition condition).

The maximum number of users allowed in a selection is 50.

Examples

{approval:Reviewer|weight=100|hasapproval=Author|usergroup=reviewers}

The page can get the Reviewer approval/rejection only if it has received the Author approval and by users that belong to the group reviewers.

{approval:Reviewer|weight=100|hasapproval=Author|selectedapprover=reviewers}

To give the Reviewer approval, the Author approval has to be given first, and the approver has to be selected by the person given the Author approval, from all the members of the reviewers group.

{workflow}
    {approval:Author|usergroup=content-providers}
    {approval:Peer|selectedapprover=emendator,primus|hasapproval=Author|caption=Peer reviewer:|hint=Peers:}
    {approval:Reviewers|user=&reviewers|hasapproval=Peer}
{workflow}

The approval Author can be given only by members of the content-providers user group. The Peer approval can be given by either of users emendator or primus. The user giving the Author approval would be making the selection.
The Reviewers approval must be given by all the members of the reviewers user group, after the Peer review approval is given.

Used to set properties in a workflow, which will become available to trigger actions.

Example

{workflow}
    {workflowproperties:remotepublishing|url=http://foo/rpc/xmlrpc|user=foo|password=bar|space=PUBLIC}
    ...
{workflow}

Used to included the approvals line and messages section in the user interface.

Use this macro if you are not able to make the page layout changes to view the approvals line.

It be used in any of the panels of the Theme Builder.

Used to add a label to the current page. It can be used only within a {trigger} macro.

Used to remove a label from the current page. It can be used only within a {trigger} macro.

Allows users to select a label. It can be used only within a {trigger} macro.

Example

This macro can be used to allow users selecting what workflow to use when they create a page:

{workflow}
    {trigger:pagecreated}
        {set-caption}
            {select-label:labels=flasttrack, standardworkflow |
             title=Please select the workflow type|
             descriptions=Fast-track, Standard}
        {set-caption}
    {trigger}
{workflow}

Then you can define two different label workflows:

{workflow:label=fasttrack}
    ...
{workflow}

{workflow:label=fasttrack}
    ...
{workflow}

Used to set messages in the view screen. Messages can be associated to the page or a to specific user.

The actual message is defined in the body of the macro and can include Value References.

It can be used only within a {trigger} macro.

Used to set a metadata value on a page or blog post. It can be used only within a {trigger} macro.

The value is defined in the body of the macro.

Examples

In this example, we store the page creator as Document Author, which is going to be used later to notify if the page is updated by other user after being approved, so it has to be reapproved:

{workflow}
    {approval:Approval}
    {trigger:pagecreated}
        {set-metadata:Document Author}@user@{set-metadata}
    {trigger}
    {trigger:pageupdated|user=!@Document Author@|hasapproval=Approval}
        {send-email:user=@Document Author@}@user@ has modified @page@{send-email}
    {trigger}
{workflow}

Used to set text or entry macros in the view screen. The wiki markup is defined in the body of the macro and can include Value References. It can be used only within a {trigger} macro.

Examples

Selecting a label when a page is created:

{workflow}
    {trigger:pagecreated}
        {set-caption}
            {select-label:labels=flasttrack, standardworkflow |
             title=Please select the workflow type|
             descriptions=Fast-track, Standard}
        {set-caption}
    {trigger}
{workflow}

Used to add additional page restrictions. It can be used only within a {trigger} macro.

Examples

The following trigger restricts a created page to be read only by the user that created it and by members of the moderators group:

{trigger:pagecreated}
        {add-restriction:type=View|user=@user@}
        {add-restriction:type=View|group=moderators}
    {trigger}

When an approved page is edited, it makes it editable only by the user and by members of the moderators group:

{trigger:pageupdated|hasapproval=Approval}
    {add-restriction:type=Edit|user=@user@}
    {add-restriction:type=Edit|group=moderators}
{trigger}

Used to remove page restrictions. It can be used only within a {trigger} macro.

If neither the user or group is set, then all the existing permissions of the given type will be removed. Note the only the content permissions will be removed and the predefined space permissions will remain.

Examples

The following trigger removes all restrictions when the page is approved

{trigger:pageapproved|approval=Approval}
    {remove-restriction:type=View}
    {remove-restriction:type=Edit}
{trigger}

Used to approve a page or blog post. It can be used only within a {trigger} macro.

It can be used also to approve pages on another Confluence instance.

To approve the page on another confluence instance, the remote instance's credentials have to be defined using the {workflowproperties} macro:

Examples

The following trigger will automatically give the Editor approval to the page, if it was approved by the user bigboss.

    {trigger:pageapproved|approval=Author|user=bigboss}
        {approve-page:Editor}
    {trigger}

Used to approve the children of a page. It can be used only within a {trigger} macro.

Examples

The following trigger with approve all the children of an approved page, that is not at the top level of the hierarchy (see the isorphan condition):

{trigger:pageapproved|Approval=Author|isorfan=false}
    {approve-children:Author|comment=@comment@}
{trigger}

Used to reject a page or blog post. It can be used only within a {trigger} macro.

It can be used also to reject pages on another Confluence instance.

To reject the page on another confluence instance, the remote instance's credentials have to be defined using the {workflowproperties} macro:

Examples

The following trigger will automatically give the Editor rejection to the page, if it was rejected by the bigboss.

    {trigger:pagerejected|approval=Editor in Chief|user=bigboss}
        {reject-page:Editor}
    {trigger}

Used to reject the children of a page. It can be used only within a {trigger} macro.

Examples

The following trigger with reject all the children of an rejected page, that is not the home page (see the ishomepage condition):

{trigger:pagearejected|Approval=Author|ishomepage=false}
    {reject-children:Author|comment=@comment@}
{trigger}

Used to change the state of page or blog post. It can be used only within a {trigger} macro.

Generates a report on approval or page states for a given space.

Parameters	Mandatory	Default	Description
space or spacekey	No	current space	The space key
maxentries or entries	No	20	The maximum number of entries
type	No	approvals or states depending on the type of workflow in the space	The type of report
filter	No	pending	For approvals report, pending will filter the pages which have pending approvals, approved pages which have been approved or rejected for rejected pages
approval	No		The approval name to filter
state	No		the state name to filter
sort	No	modified	Sort the entries on modified or created date Confluence 2.9 and newer only
order	No	descending	sets the ascending or descending order Confluence 2.9 and newer only
parent	No		Limits the report to child pages of the given parent page title Confluence 2.9 and newer only
approver	No		Show only the content for which the given user name (or @self for current user) has been selected for the given approval. Requires that the Approvals are defined with the selectapprover parameter is set)
user	No		Show only the content that is ready for approval and that the given user name (or @self for the current user) can approve. Confluence 2.8 and newer only

Examples

Generate an approval report of pages that have received the Author approval, listing five pages per page:

{workflowreport:approval=Author|filter=approved|max=5}

Generate a states report, for pages in the Completed state:

{workflowreport:type=states|state=Completed}

Generates a report of all pages that the current user could approve or reject:

{workflowreport:user=@self}

Generates a report of all pages on which user emendator has been selected as approver:

{workflowreport:approver=emendator}

Displays a calendar.

• id - (required) The page-unique ID of the calendar.
• title - (optional) The title of the initial sub-calendar.
• defaultView - (optional) The view to display by default. May be 'event', 'day', 'week', or 'month' (the default).
• firstDay - (optional) The first day of the week. Defaults to 'Monday'.

Show flash based content on a confluence page.

• file - Location of flash file. One of the file or url parameters must be specified.
  • filename - Data is read from the file located in confluence home directory/flash/filename. Subdirectories can be specified.
  • ^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 - URL of flash file. Only used if file parameter is not provided.
  • http://... - Data is read from the URL specified.
• width - The table width in pixels. Default is 100%.
• height - The table height in pixels. Default is 100%.
• show - Default is to show the flash content on the page. Set show=link to show as a link to the content.
• title - Title to use for the link when show=link is specified. Default is the name of the flash file or url.
• Other flash specific parameters - All other parameters are passed through to flash. See Flash reference information. Here is is a partial list.
  • ID - Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language. OBJECT-specific.
  • NAME - Identifies the Flash movie to the host environment (a web browser, typically) so that it can be referenced using a scripting language such as JavaScript or VBScript. EMBED-specific.
  • SWLIVECONNECT - (true, false) Specifies whether the browser should start Java when loading the Flash Player for the first time. The default value is false if this attribute is omitted. If you use JavaScript and Flash on the same page, Java must be running for the FSCommand to work.
  • PLAY - (true, false) Specifies whether the movie begins playing immediately on loading in the browser. The default value is true if this attribute is omitted.
  • LOOP - (true, false) Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.
  • MENU (true, false)
    • True displays the full menu, allowing the user a variety of options to enhance or control playback.
    • False displays a menu that contains only the Settings option and the About Flash option.
  • QUALITY - (low, high, autolow, autohigh, best )
  • SCALE - (showall, noborder, exactfit)
    • Default (Show all) makes the entire movie visible in the specified area without distortion, while maintaining the original aspect ratio of the movie. Borders may appear on two sides of the movie.
    • No Border scales the movie to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the movie.
    • Exact Fit makes the entire movie visible in the specified area without trying to preserve the original aspect ratio. Distortion may occur.
  • ALIGN - (l, t, r, b)
    • Default centers the movie in the browser window and crops edges if the browser window is smaller than the movie.
    • Left, Right, Top, and Bottom align the movie along the corresponding edge of the browser window and crop the remaining three sides as needed.
  • SALIGN - (l, t, r, b, tl, tr, bl, br)
    • L, R, T, and B align the movie along the left, right, top or bottom edge, respectively, of the browser window and crop the remaining three sides as needed.
    • TL and TR align the movie to the top left and top right corner, respectively, of the browser window and crop the bottom and remaining right or left side as needed.
    • BL and BR align the movie to the bottom left and bottom right corner, respectively, of the browser window and crop the top and remaining right or left side as needed.
  • WMODE - (window, opaque, transparent) Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser.
    • Window movie plays in its own rectangular window on a web page.
    • Opaque the movie hides everything on the page behind it.
    • Transparent the background of the HTML page shows through all transparent portions of the movie, this may slow animation performance.
  • BGCOLOR - (#RRGGBB, hexadecimal RGB value) Specifies the background color of the movie. Use this attribute to override the background color setting specified in the Flash file. This attribute does not affect the background color of the HTML page.

Displays a simple table of all the content (pages, comments, news items, user profiles and space descriptions) created by a user (here 'fred').

Displays an index of all the pages in the current space, cross linked and sorted alphabetically.

The user viewing the page must have permission to view the page being included, or it will not be displayed.

Prints a simple note to the user.

• title: - (optional) the title of the note.
• icon: - (optional) if "false", dont display the icon.

Be Careful The body of the note here..

Prints a warning note to the user.

• title: - (optional) the title of the warning.
• icon: - (optional) if "false", dont display the icon.

Warning Insert warning message here!

Prints an informational note.

• title: - (optional) the title of the information box.
• icon: - (optional) if "false", dont display the icon.

Useful Information This macro is useful for including helpful information in your confluence pages

Prints a helpful tip for the user.

• title: - (optional) the title of the tip.
• icon: - (optional) if "false", dont display the icon.

Handy Hint Join the Confluence Mailing-List!

{zone-template}
... Define zones here
{zone-template}

Defines a zone template. Within the tmeplate define the common page structure and include one or more zones to allow instances of the template to provide custom data.

More Information

• [Documentation]

{zone-template-instance:SOMESPACE:Some Template}
... Define zone data here
{zone-template-instance}

Define an instance of a zone template. Instances are put on to pages that users are expected to look at. A minimal set of customized zone data must be provided.

Parameters

• default: Page refernce to the zone-template. Required.

{zone:product-version|render=false}

{zone:installation-guide}

Define a named zone in a template. A zone is a placeholder which will be rendered with the data from the template instance.

NOTE: Currently a zone data block must have been defined; otherwise an exception is thrown.

Parameters

• default: The name of the zone; Required.
• render: True to render the zone data as wiki; Default: true.
• trim: True to trim the zone data (remove preceeding and trailing whitespace); Default: true.

{zone-data:product-version}
4.0.0
{zone-data}

{zone-data:installation-guide}
 * Download
 * Extract
 * Run
{zone-data}

Provides a block of data for a template zone. The zone definition will determine how the data will be rendered.

Parameters

• default: The name of the target zone to receive the defined data. ; Required.

• nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.

preformatted piece of text
so *no* further _formatting_ is done here

• 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:

Displays a chart using data from the supplied table or tables.

• Chart type parameters - These parameters change what type of chart to display and the way the chart looks.
  • type - The type of chart to display. The following chart types are available:

    Standard charts

    • pie (default)
    • bar
    • line
    • area

    XY plots - The standard XY plot has numerical x and y axes.The x values may optionally be time based. See timeSeries.

    • xyArea
    • xyBar
    • xyLine
    • xyStep
    • xyStepArea
    • scatter
    • timeSeries

    Other charts

    • gantt - beta - See Gantt Charts.
    
    
  • 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
  • domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter
  • 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
  • domainAxisLabelAngle - angle for the domain axis label in degrees
  • 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.
    • ^attachment - chart.macro.param.attachment.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.

Colors

Date Format

Copied from Java SimpleDateFormat specification.

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):

• 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:
               GMT Sign Hours : Minutes
  
       Sign: one of
               + -
       Hours:
               Digit
               Digit Digit
  
       Minutes:
               Digit Digit
       Digit: 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.

  For parsing, RFC 822 time zones are also accepted.

• RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit

  TwoDigitHours must be between 00 and 23. Other definitions are as for general time zones.

  For parsing, general time zones are also accepted.

• Flash (.swf)
• Quicktime movies (.mov)
• Windows Media (.wma, .wmv)
• Real Media (.rm, .ram)
• MP3 files (.mp3)

• width - the width of the media file
• height - the height of the media file
• id - the ID assigned to the embedded object

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.
• showSpace The space the bookmark is saved in
• showViewLink A link to the actual bookmark page

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 Confluence content which has changed recently. By default, listed content will be listed from the current space. Returned content may be filtered through the various parameters.

• 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 the rendered 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.

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%.

Include the Confluence site welcome message. The site welcome message may be configured in the Administration -> General Configuration section.

Renders a create space button linked to the create space page.

• size - small (size of 'small' uses a smaller graphic, whereas size of 'large' uses a larger one)
• height - image height in pixels
• width - image width in pixels

Prints a list of attachments

• 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.

Lists users registered in Confluence.

Either a group or groups value must be supplied. If you want all users in the system use groups=*.

Supplying a groups value will list only members of those groups. The groups value supports a comma separated list of group-names.

Group: confluence-administrators
Tyler Durden (tdurden@example.com)
Marla Singer (marla@example.com)
Robert Paulson (bob@example.com)

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.

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).

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.

Show search results keystroke by keystroke.

• spaceKey: - (optional) this option searches within a single space.

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.

• 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.

file-containing-home.pdf ( download)

Displays the most recent news items in this space.

• content - lets you choose whether to display each news item 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 news items. 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.

• hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.

• nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.

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.

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 Confluence content which has changed recently. By default, listed content will be listed from the current space. Returned content may be filtered through the various parameters.

• 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 the rendered 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
  • 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. Defaults to all content types except mail (and, when in a shared setting, personal information).
• 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.

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.

Renders the list of all labels or labels for a specific space sorted alphabetical.

• spaceKey - (optional) list the labels in the specified space (current space by default). If '@all' is specified, labels in all spaces will be listed.

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.

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).
• includePages - (optional) If 'true', any included Confluence pages will be imported and listed.
• 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).
• includePages - (optional) If 'true', any included Confluence pages will be imported and listed.
• 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.

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}

• 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.

• 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.

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

Parameters

• mode - The mode the calendar is in. Either 'month', 'agenda' or 'mini'. Defaults to 'month'.
• controls - The controls to show. Either 'all' (which displays Title, Navigation buttons, Date, Print icon, Tabs, Calendar list, Time zone), 'navigation' (which displays just the navigation button and Date) or 'none'. Defaults to 'navigation'.
• title - The title to display. Only visible when controls is set to 'all'. Defaults to the name of the calendar.
• width - The width of the calendar in either pixels ('500' - no 'px') or percentage ('100%'). Defaults to 100%
• height - The height of the calendar in pixels ('600' - no 'px'). Defaults to '610'.
• bgcolor - The background color of the calendar. Defaults to '#FFFFFF'.
• firstDay - The first day of the week. Eg. 'Monday'. Defaults to 'Sunday'.
• colors - A comma-separated list of colors for events, listed in the same order the calendars appear in the macro body. Colors must available in Google Calendar and '#'d values (eg. '#29527A', '28754E', etc).

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

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

Example:

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

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

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

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

Displays an OPML file with expanding sections for each outline item. Should contain {opml-column} macros to define extra attribute/column values.

• source - (required) The source of the OPML file. Either an attachment ('^attachment.opml') or a full URL ('http://server/file.opml').
• width - (optional) The width of the table. Eg. '100%' or '400px'.
• iconType - (optional) The type of content to use for the icons. May be one of the following:
• image - (default) The icon values point to an image file, either an attachment or a URL.
• wiki - The icon values are wiki text.
• text - The icon values are plain text.
• expandIcon - The value of the expand icon.
• collapseIcon - The value of the collapse icon.
• singleIcon - The value of the single item icon.
• class - (optional) The custom CSS class for the OPML display.

Specifies the settings for a column of data in an OPML document. The data comes from extra attributes on <outline> elements. Must be contained inside an {opml} macro.

• name - (required) The name of the attribute the column gets data from.
• title - (optional) The title of the column. This is wiki text, and you may alternately use the macro body to set the title if there is more complex text you wish to use.
• type - (optional) The type of data contained in the
• text - (default) Plain text.
• html - HTML text (note - this may be dangerous if there is bad HTML in the source).
• number - A number. This may not contain any non-digit values. Eg. '9.5' is good, '$9.50' is bad.
• date - A date. You will usually want to specify the source format so that the date can be interpreted correctly.
• sourceFormat - The format of the date in the OPML file (eg. 'dd MMM, yyyy').
• displayFormat - The format to display the value as, either a number format (eg. '$#0.00') or date (eg. 'dd-MM-yyyy').
• width - The width of the column. Eg. '100%', '400px'.

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

Parameters

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

• id: - Flickr ID of the photo.
• title: - (optional) title text.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.

• id: - Flickr ID of the photoset.
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• id: - Flickr ID of the group.
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• userName: - Flickr user name (not ID!).
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• tags: - (optional) comma-separated list of tags, defaults to the page labels. If neither of those is specified, it uses some default tags.
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• userName: - Flickr user name (not ID!).
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• userName: - Flickr user name (not ID!).
• title: - (optional) title text.
• maxPhotos: - (optional) the maximum number of photos to download, defaults to 5.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.
• columns: - (optional) number of columns in the table, defaults to 4.
• showDetails: - (optional) show title, tags, number of comments and such, defaults to true.

• id: - Flickr ID of the photo.
• title: - (optional) title text.
• size: - (optional) image size, one of square, thumbnail, small, medium, large, original, defaults to square.

• client: - passed to the google_ad_client javascript parameter.
• width: - (optional) passed to the google_ad_width javascript parameter.
• height: - (optional) passed to the google_ad_height javascript parameter.
• format: - (optional) passed to the google_ad_format javascript parameter.
• type: - (optional) passed to the google_ad_type javascript parameter.
• channel: - (optional) passed to the google_ad_channel javascript parameter.
• bordercolor: - (optional) passed to the google_color_border javascript parameter.
• backgroundcolor: - (optional) passed to the google_color_bg javascript parameter.
• linkcolor: - (optional) passed to the google_color_link javascript parameter.
• urlcolor: - (optional) passed to the google_color_url javascript parameter.
• textcolor: - (optional) passed to the google_color_text javascript parameter.

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

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

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

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

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

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

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

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

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

Example:

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.

{plugins-supported}
{plugins-supported:profileKey=confluence}
{plugins-supported:profileKey=confluence|by=atlassian}

Lists supported plugins.

• profileKey — The profile from which to get a list of plugins to display.
• by — Lets you filter the list of plugins by the name of the person or organization that supports them.

{plugin-compatibility-matrix}
{plugin-compatibility-matrix:key=confluence.repository.client}>
{plugin-compatibility-matrix:key=confluence.repository.client|productStart=2.7|productEnd=2.9}

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.

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.

• default argument - (required) the title of the ballot.

Before the user logs in:

Before the logged-in user votes:

Ballot: What is your favorite color?	Choose
Red
Blue
None of the above

After the logged-in user votes: