Notation Guide

Print Help Tips
Headings

To create a header, place "hn. " at the start of the line (where n can be a number from 1-6).

Notation Comment
h1. Biggest heading

Biggest heading

h2. Bigger heading

Bigger heading

h3. Big Heading

Big Heading

h4. Normal Heading

Normal Heading

h5. Small Heading
Small Heading
h6. Smallest Heading
Smallest Heading
Text Effects

Text effects are used to change the formatting of words and sentences.

Notation Comment
*strong* Makes text strong.
_emphasis_ Makes text emphasis.
??citation?? Makes text in citation.
-strikethrough- Makes text as strikethrough.
+underlined+ Makes text as underlined.
^superscript^ Makes text in superscript.
~subscript~ Makes text in subscript.
{{text will be monospaced}} Makes text as code text.
bq. Some block quoted text To make an entire paragraph into a block quotation, place "bq. " before it.

Example:

Some block quoted text

{quote}
here is quoteble
content to be quoted
{quote}

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

Example:
here is quotable
content to be quoted
{color:red}
look ma, red text!
{color}
Changes the color of a block of text.

Example: look ma, red text!

Text Breaks

Most of the time, explicit paragraph breaks are not required - Confluence will be able to paginate your paragraphs properly.

Notation Comment
(empty line) Produces a new paragraph
\\ Creates a line break. Not often needed, most of the time Confluence will guess new lines for you appropriately.
---- Creates a horizontal rule
--- Produces symbol.
-- Produces symbol.
Lists

Lists allow you to present information as a series of ordered items.

Notation Comment
* some
* bullet
** indented
** bullets
* points
A bulleted list (must be in first column). Use more (**) for deeper indentations.

Example:

  • some
  • bullet
    • indented
    • bullets
  • points

- different
- bullet
- types
A list item (with -), several lines create a single list.

Example:

  • different
  • bullet
  • types

# a
# numbered
# list
A numbered list (must be in first column). Use more (##, ###) for deeper indentations.

Example:

  1. a
  2. numbered
  3. list

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

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

You can even go with any kind of mixed nested lists:

Example:

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

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

{checklist:name=The animals| parent=Animals|checklabels=mammal, oviparous, pets}

{checklist:name=Oviparious|parent=Animals|excerpt-heading=Classification|label=oviparous|checklabels=fish, amphibians, reptiles, birds|mutuallyexclusive=true}

{checklist:name=The pets| parent=demo:Animals| label=pets| excerpt-heading=Classification| comment-heading=Comments}

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:

Keyword Value
@user@ current user's name
@userfullname@ current user's full name
@self@ or title the title of the page owning the checklist
@creator@ the page creator's user name
@modifier@ the last modifier's user name
@any other value name@ the given metadata value in the page owning the checklist

parameter Mandatory? Default description
name or unnamed
first parameter
no current page's name the name of the checklist
parent no   the parent page, if not set, and there is no label set either, then the page containing the checklist will be used as such
label no   the label the selected must have
space no   the space to reduce the query to, when using label only and no parent
depth no 0 depth of the search for children ('0' for no limit)
childrenonly no false whether or not parent-children are to be included
sort no name How the table should be sorted: name to sort by name, created to sort by page creation date, or modified to sort by last modification date
checklabels no   a comma separated list of labels to be used to 'check' the pages
mutuallyexclusive no false whether or not the checklabels are mutually exclusive
excerpt-heading no   the heading for the excerpt column
comment no   the heading for a column to be used for comments
class no grid the style sheet (CSS) class to use for the table
pagelink no true whether or not to include a link to the pages as the first column of the table

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.

{checklist-label:Mammal?|label=mammal}

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
label no the heading The label to be used to 'check' the pages
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only

Example

{checklist:name=Pets|parent=Animals|label=pets}
   {checklist-label:Mammal?|label=mammal}
{checklist}
Will render as:
{checklist-input:Common pet names|cols=20}

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
cols yes   The maximum number of characters read
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)

Example

{checklist:name=Pets names|parent=Animals|label=pets}
   {checklist-input:Common pet names|cols=20}
{checklist}
Will render as:
{checklist-wikiinput:Comments| rows=5| cols=20| width=90%}

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
cols yes   The number of columns in the text area when editing the value
rows no 1 The number of rows in the text area when editing the value
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)

Example

{checklist:name=The pets| parent=Animals| label=pets}
    {checklist-wikiinput:Comments|rows=5|cols=20|width=90%}
{checklist}
Will render as:
{checklist-select:Can swim?}
yes
no
{checklist-select}

{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-select:Who owns one?|usersgroup=all}

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.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
uselabels no false instead of setting a metadata value, add the selected label
usersgroup no   instead of listing the value, use the given users group to select from a list of users. Use all for listing all the users
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)
macro body     If no usersgroup is given, the options to select from have to be defined as part of the body. Each line of the body define an option. Each option could have a different value from the actual caption by defining it as <value>|<caption>

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}
Will render as:
{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}
Will render as:
{checklist:name=Pets on the team|parent=Animals|label=pets}
   {checklist-select:Who owns one?|usersgroup=all}
{checklist}

Will render as:
{checklist-wiki:Photo}
!photo.jpg!
{checklist-wiki}

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.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column and the metadata value name
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
macro body     the wiki segment to be rendered for each page 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}
Will render as:
{checklist-excerpt:Classification|width=10%}

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

{checklist:name=pets| parent=Animals| label=pets}
    {checklist-excerpt:Classification|width=10%}
{checklist}
Will render as:
{checklist-pagelink:Edit|destination=view|width=10%}

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
destination no view the link should go to (view or edit)
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
{checklist-include:Full page}

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.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

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

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

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column and the metadata value name
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

{checklist:name=The pets names|parent=Animals|label=pets}
   {checklist-metadata:Comments}
{checklist}
Will render as:
{checklist-attribute:attribute=Common pet names}

{checklist-attribute:page=confluence:Cat| attribute=Comments}

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

parameter description
page (optional) title of the page to lookup. If none set, then the current page will be used
attribute Name of the attribute (column) set in the checklist


The first example on the side will display fido, dino... if the segment is in the Dog page

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

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

Generates a checklist change report for a given page.

parameter Mandatory? Default description
page no current page The title of the page to generate the report from
maxentries no 0 (no limit) The maximum number of entries to report (0 for no limit)
maxentriespername no 0 (no limit) The maximum number of entries per value name (0 for no limit)
mostrecentfirst no false whether or not display the most recent entry first
format no detailed Defines the way each of log entries is to be reported:
date : display only the date
dateanduser: display the date and use
detailed: display all the available information
newvalue: display only the new value
oldvalue: display only the last value
simple: display date, user and new value in a single line
user: display only the user
useranddate: display the user and date
remaining
unnamed parameters
no   each remaining unnamed parameters in the macro indicate what name values are to be included in the report. If none set, the report will include all the value names

Example

{checklist-log:format=useranddate|maxentries=1|Comments}
Will render as:
{checklist-column:heading=Classification| type=excerpt| width=5%}
{checklist-column:heading=Mammal| type=label| label=mammal}
{checklist-column:heading=Comments| type=text| cols=30| readonly=true}
{checklist-column:heading=Common pet names| type=text| rows=5| cols=20}

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

Defines more detailed column information for a {checklist}.

parameter Mandatory? Default description
heading yes   Heading of the column
type yes   type of column. It can be any of label, text or excerpt
label yes, if
type=label
  the label to be used to 'check' the pages
rows yes, if
type=text
  rows when editing text area
cols yes, if
type=text
  cols when editing text area
width no   width of the of column
readonly no false whether or not the column is read-only

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

{dynamictasklist:thingsToDo}
{dynamictasklist:thingsToDo|showAssignee=false}
{dynamictasklist:thingsToDo|promptOnDelete=false}

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.

  • showAssignee - (optional) If set to true the assignee will be shown in the tasks.
  • width - (optional) The width of the tasklist (default is 640px). To set the width to 400 pixels, set the parameter value to 400px.
  • enableLocking - (optional) If set to true, tasks can be locked so other users can not modify.
  • autoLockOnComplete (optional) Used in conjunction with enableLocking. Tasks will auto lock when it is completed.
  • promptOnDelete - (optional) If set to false there will not be any confirmation prompt when deleting a task.

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

Images can be embedded into Confluence pages from attached files or remote sources.

Notation Comment
!http://www.host.com/image.gif!
or
!attached-image.gif!
Inserts an image into the page.

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

!spaceKey:pageTitle^image.gif!

!/2007/05/23/My Blog Post^image.gif!
Inserts an image that is attached on another page or blog post.

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

!image.jpg|thumbnail!

Insert a thumbnail of the image into the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image.

Thumbnails must be enabled by the site administrator for this to work.

!image.gif|align=right, vspace=4!

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

{gallery}

{gallery:columns=3}

{gallery:title=Some office photos, and a waterfall|columns=3}

{gallery:title=Some office photos, without the waterfall|exclude=waterfall.jpg}

{gallery:title=One office photo, and a waterfall|include=office1.jpg,waterfall.jpg}

{gallery:title=Some office photos, and a waterfall|page=Gallery of Pictures}

{gallery:title=Some office photos, and a waterfall|page=DOC:Gallery of Pictures}

{gallery:title=Some office photos, and a waterfall|sort=name}

{gallery:title=Some office photos, and a waterfall|sort=date|reverse=true}

Create a gallery of thumbnails of all images attached to a page. This will only work on pagesthat allow attachments, obviously.

The title parameter allows you to supply a title for the gallery

The columns parameter allows you to specify the number of columns in the gallery (by default, 4)

The exclude parameter allows you to specify the name of attached images to ignore (i.e., they will not be included in the gallery). You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif

The include parameter allows you to specifically include one or more attached images. The gallery will show only those pictures. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif

The page parameter allows you specify the title of one or more pages which contains the images you want displayed. If a page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro. You can specify more than one page, separated by commas. Example: page=Image Gallery,STAFF:Group Photos

If a page or attachment file name contains a comma, you can use it in the include, exclude, or page parameters by enclosing it in single or doublequotes. Example: include="this,that.jpg",theother.png

The sort parameter allows you to control the order of the images. The options are name,comment, date, or size.

The reverse parameter is used in conjunction with the sort parameter to reverse the order of the specified sort. Valid values are true and false.

Previous versions of the Gallery macro had an additional slideshow parameter. This is no longer used in the latest version, and the slide show is always enabled. We have left the parameter here for compatibility with older versions of the macro.

Tables

Tables allow you to organise content in a rows and columns, with a header row if required.

Notation Comment
||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
Makes a table. Use double bars for a table heading row. Note that each table-row has to be defined on a single line.

The code given here produces a table that looks like:

heading 1 heading 2 heading 3
col A1 col A2 col A3
col B1 col B2 col B3

{column:width=50%}
Text in this column.
{column}

Defines a single column.

  • width: - (optional) the width of the column.
Must be defined in a section macro.

{section}

{column:width=30%}
Column one text goes here
{column}

{column:width=70%}
Column two text goes here
{column}

{section}


{section:border=true}
...
{section}

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.

{csv}
, January, February, March, April
Max, 37.5, 32.7, 28.0, 25.3
Min, 31.3, 26.8, 25.1, 18.7
{csv}

{csv:output=wiki|width=900|border=15|delimiter=whitespace}
Month Max Min Average
January 25.5 *6.3* 15.9
February 32.4 12.8 22.6
March 44.6 24.5 34.6
April 59.7 37.1 48.4
May 72.5 48.7 60.6
June 81.3 57.9 69.6
July 85.2 62.8 74
August 82.5 60.7 71.6
September 73.7 51.7 62.7
October 61.1 40.1 50.6
November 43.6 27.4 35.5
December 29.9 13.6 21.8
{csv}

CSV Macro

Converts csv and other deliminated data into a table. CSV is not a formal standard, but the best reference is The Comma Separated Value (CSV) File Format. The support in this macro comes close to following this pseudo-standard. For more details see SCRP-16. This macro shares common table capabilities with other table based macros (excel, table-plus, and sql).

  • output - Determines how the output is formated:
    • html - Data is output as a HTML table (default).
    • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
  • script - Location of csv data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.
    • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • global page template name - Data is read from a global page template.
    • space:page template name - Data is read from a space template.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • encoding - File encoding for an external file if different from the system default handling. Example: *UTF-8*.
  • url - Specifies the URL of an csv file. If a url location is specified, the included data will follow the body and script data. Use of this parameter may be restricted for security reasons. See your administrator for details.
  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines. Heading rows do not participate in sorting.
  • footing - Number of rows to be considered footing rows (default is 0). Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.
  • border - The border width in pixels. Defaults to normal table border width.
  • width - The table width in pixels. Default is 100%.
  • delimiter - Delimiter that separates columns. Note that trailing delimiters on a line result in a blank column at the end of the row.
    • , or "," (comma) - The default column separator.
    • whitespace - Blanks, tabs, and other white space are used to separate columns.
    • tab - A single tab character is used to separate columns.
    • blanks - Blank or blanks only.
    • pipe - A single pipe (|) character is used to separate columns.
    • other single character delimiter - may be within double quotes with some restrictions. Examples: ";", "=",
  • columns - Comma separated list of column numbers in any order. Defaults to all columns in existing order. Columns are enumerated starting at 1.
  • ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored. A row is considered blank if all the columns selected by the column parameter are blank. Set ignoreTrailingBlankRows=false to show these blank rows.
  • quote - the character used to represent quoted data. Quoted data may contain delimiters or new lines. Quote character must be doubled inside a quoted string.
    • double - Double quote character (default).
    • single - Single quote character.
  • escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Set escape=true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
  • showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formating issues.
  • disableAntiXss - Default is false. Set to true to stop encoding of html special characters found in table content. For security reasons, use of this parameter is restricted to authorized users. See your administrator for details.
{table-plus}
|| || January || February || March || April ||
| Max | 37.5 | 32.7 | 28.0 | 25.3 |
| Min | 31.3 | 26.8 | 25.1 | 18.7 |
{table-plus}

{table-plus:width=500|border=15|enhableHighlighting=false|columnTypes=S,F,F,F}
|| Month || Max || Min || Average ||
| January | 25.5 | *6.3* | 15.9 |
| February | 32.4 | 12.8 | 22.6 |
| March | 44.6 | 24.5 | 34.6 |
| April | 59.7 | 37.1 | 48.4 |

Other text can be here too!

|| Another table || | more data | {table-plus}

{table-plus:columnTypes=S,-,.|autoNumber=true|sortColumn=3
|columnAttributes=,,style="background:yellow; font-size:14pt;"}
|| Name || Phone || TCP ||
| John | 555-1234 | 192.168.1.10 |
| Mary | 555-2134 | 192.168.1.12 |
| Bob | 555-4527 | 192.168.1.9 |

{table-plus}

Table Plus Macro

Adds column sorting and other attributes to one or more tables found in the body of the macro. The tables can be produced by wiki markup or other means. This macro shares common table capabilities with other table based macros (excel, csv, and sql).

  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines. Heading rows do not participate in sorting.
  • footing - Number of rows to be considered footing rows (default is 0). Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.
  • width - The table width in pixels. Default is 100%.
  • border - The border width in pixels. Defaults to normal table border width.
  • multiple - Default is true which means all tables found within the macro body are processed. Set multiple=false to only process the first table found and may need to be used if the table includes cells that are also tables.
  • Other parameters - Other parameters are passed through to the html table markup for more advanced capabilities or to override the default class

Common table capabilities

A javascript enabled browser is required to enable these capabilities. A number of table based macros (table-plus, csv, excel, and sql) share these common capabilities.

  • Column sorting - sort a column by clicking on column heading. Clicking again will reverse the order. Auto sorting before display
  • Row highlighting on mouse over - row is highlighted when mouse goes over any row element for non-heading rows
  • Column attributes - ability to set the display attributes (color, font) on a column basis
  • Auto numbering - ability to automatically add a leading column with the data row count.
  • Auto totaling - ability to automatically add a footing row that totals all numeric columns.

Parameters - the following parameters control these common table capabilities:

  • enableSorting - Set enableSorting=false to prevent sorting.
  • enableHighlighting - As the mouse moves over a table row, the row will be highlighted by default. Set enableHighlighting=false to stop this behavior. This parameter was formerly known as highlightRow which still works.
  • sortColumn - The table can be auto sorted before it is displayed by any valid column name or number provided by this parameter. No auto sorting will be done if this value is not provided or is invalid. A column number is a 1-based count of columns (excluding auto number column).
  • sortDescending - If sortDescending=true, the sort indicated by the sortColumn will be done in reverse order.
  • sortTip - Text that is used to provide user feedback with mouse is over a column heading that is sortable. Default text is: "Click to sort" followed by the column name if available.
  • sortIcon - Default is false to not show a sort indicator icon. Set sortIcon=true to include a sort icon in the first heading row for sortable columns. An icon will show for the last column sorted indicating the direction the column was sorted.
  • highlightColor - Color of row when mouse is over a row element. See Colors for how to specify.
  • autoNumber - If autoNumber=true, an additional column will be added that will count each data row.
  • autoTotal - If autoTotal=true, an additional row will be appended to the end of the table that will contain totals of all numeric columns.
  • autoNumberSort - If autoNumberSort=true, the auto number column will be sortable and will retain the original data row count even after row sorting.
  • columnTypes - By default, all columns are treated as strings for sorting purposes unless a more specific sort type is provided either by the macro logic or by this parameter. The parameter is a comma separated list of column type indicators to identify column types.
    • S - string
    • I - integer
    • F - float
    • C - currency or similar where it is a float value with pre or post characters
    • D - date in the browser date format. More advanced date handling may be available on your server after installation of a date handling library. See online docmentation for more information.
    • X - exclude this column from user selectable sorting
    • . or - or : or / - separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by one of the separators indicated by the type.
    • H - hide the column.
  • columnAttributes - A comma separated list of values used to modify cell attributes for all cells in a column. The position in the comma separated list corresponds to the column that the values apply to. Each value is a double semi-colon (;;) separated list of attributeName=value pairs that will be applied to the column cells.
  • enableHeadingAttributes - By default, any column attributes provided will be applied to the all column rows including heading rows. Set enableHeadingAttributes=false to have the column attributes apply only to data rows.
  • id - Sets the table id for the table for use in macros (like the chart macro) to identify a specific table.
Advanced Formatting

More advanced text formatting.

Notation Comment
{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
    return foo;
}
{code}

{code:xml}
<test>
  <another tag="attribute"/>
</test>
{code}
Makes a pre-formatted block of code with syntax highlighting. All the optional parameters of {panel} macro are valid for {code} too. The default language is Java but you can specify JavaScript, ActionScript, XML, HTML and SQL too.

Example:

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

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

{calendar:id=myCalendar|title=My Calendar|defaultView=week}

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'.
{chart:title=Fish Sold}
|| Fish Type || 2004 || 2005 ||
|| Herring | 9,500 | 8,300 |
|| Salmon | 2,900 | 4,200 |
|| Tuna | 1,500 | 1,500 |
{chart}

{chart:type=line|title=Temperatures in Brisbane|yLabel=Celcius
|dataDisplay=true|dataOrientation=vertical}
|| Month || Min || Max ||
| January | 31.3 | 37.5 |
| February | 26.8 | 32.7 |
| March | 25.1 | 28 |
| April | 18.7 | 25.3 |
{chart}

{chart:type=timeSeries|dateFormat=MM.yyyy|timePeriod=Month|
dataOrientation=vertical|rangeAxisLowerBound=0|colors=blue,gray}
|| Month || Revenue ||
| 1.2005 | 31.8 |
| 2.2005 | 41.8 |
| 3.2005 | 51.3 |
| 4.2005 | 33.8 |
| 5.2005 | 27.6 |
| 6.2005 | 49.8 |
| 7.2005 | 51.8 |
| 8.2005 | 77.3 |
| 9.2005 | 73.8 |
| 10.2005 | 97.6 |
| 11.2005 | 101.2 |
| 12.2005 | 113.7 |

|| Month || Expenses ||
| 1.2005 | 41.1 |
| 2.2005 | 43.8 |
| 3.2005 | 45.3 |
| 4.2005 | 45.0 |
| 5.2005 | 44.6 |
| 6.2005 | 43.8 |
| 7.2005 | 51.8 |
| 8.2005 | 52.3 |
| 9.2005 | 53.8 |
| 10.2005 | 55.6 |
| 11.2005 | 61.2 |
| 12.2005 | 63.7 |
{chart}

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


    • orientation - A bar, line, or area chart will be displayed vertically (y axis is vertical) unless 'orientation=horizontal' is specified.
    • 3D - A pie, bar, or line chart will be shown in 3D if 3D=true is specified.
    • stacked - A bar or area chart will be shown with stacked values if stacked=true is specified.
    • showShapes - Shapes will be shown at each data point in a line chart unless showShapes=false.
    • opacity - A percent value between 0 (not visible) and 100 (non-transparent) that determines how opaque the foreground areas and bars display. Defaults are:
      • 75 percent for 3D charts
      • 50 percent for non-stacked area charts
      • 100 percent for all other charts
  • Display control parameters
    • width - The width of the chart in pixels (default is '300')
    • height - The height of the chart in pixels (default is '300')
    • dataDisplay - Default is false to not display the rendered body of the macro (usually the data tables). When dataDisplay=true or dataDisplay=after, the data will be displayed after the chart. When dataDisplay=before, the data will be displayed before the chart.
    • imageFormat - Default is png. Format of generated image. Valid formats are png and jpg. Other formats may be also be valid if installed on your server.
  • Title and label customization parameters
    • title - The title of the chart.
    • subTitle - A subtitle for the chart using a smaller font.
    • xLabel - The label to use for the x (domain) axis
    • yLabel - The label to use for the y (range) axis
    • legend - A legend will be displayed unless legend=false is specified.
  • Data specification parameters - The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined to Confluence will be tried. Additional conversion options can be specified using the parameters below.
    • tables - Comma separated list of table ids and/or table numbers contained within the body of the macro that will be used as the data for the chart. Defaults to all first level tables. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros).
    • columns - Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Defaults to all columns. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row.
    • dataOrientation - The data tables will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
    • timeSeries - If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats.
    • dateFormat - For time series data, the date format allows for additional customization of the conversion of data to date values. By default, the Confluence language defined date formats will be used. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the format of the time series data. See Date Format.
    • timePeriod - Specify the time period for time series data. Default is 'Day'. This defines the granularity of how the data is interpreted. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.
    • language - If provided, the language and country specification will be used to create additional number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
    • country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
    • forgive - Default is true to try to convert numeric and date values that do not totally match any of the default or user specified formats. Specify forgive=false to enforce strict data format. Data format errors will cause the chart to not be produced.
  • Color customization parameters - See Colors for how to specify colors.
    • bgColor - Color (default is 'white') to use as the background of the chart.
    • borderColor - Color of a border around the chart. Default is to not show a border.
    • colors - Comma separated list of colors used to customize category, sections, and series colors.
  • Axis customization parameters - Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these paramters.
    • rangeAxisLowerBound - range axis lower bound
    • rangeAxisUpperBound - range axis upper bound
    • rangeAxisTickUnit - range axis units between axis tick marks
    • rangeAxisLabelAngle - angle for the range axis label in degrees
    • domainAxisLowerBound - domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)
    • domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)
    • domainAxisTickUnit - domain axis units between axis tick marks. For a date axis, this value represents a count of the units specified in the timePeriod parameter. The time period unit can be overridden by specifying a trailing character: y for years, M for months, d for days, h for hours, m for minutes, s for seconds, u - milliseconds. (Only used in XY Plots, standard charts will have no effect)
    • domainAxisLabelAngle - angle for the domain axis label in degrees. (Only used in XY Plots, standard charts will have no effect)
    • categoryLabelPosition - allows axis label text position for categories to be customized
      • up45 - 45 degrees going upward
      • up90 - 90 degrees going upward
      • down45 - 45 degrees going downward
      • down90 - 90 degrees going downward
    • dateTickMarkPosition - placement of the date tick mark
      • start (default) - tick mark is at the start of the date period
      • middle - tick mark is in the middle of the date period
      • end - tick mark is at the end of the date period
  • Pie chart customization parameters
    • pieSectionLabel - Format for how pie section labels are displayed. :
      • %0% is replaced by the pie section key.
      • %1% is replaced by the pie section numeric value.
      • %2% is replaced by the pie section percent value.
      Example 1: "%0% = %1%" would display something like "Independent = 20"
      Example 2: "%0% (%2%)" would display something like "Independent (20%)"
    • pieSectionExplode - Comma separated list of pie keys that are to be shown exploded. Defaults to no exploded sections. Note: requires jFreeChart version 1.0.3 or higher.
  • Attachment parameters - These are advanced options that can be used for chart versioning, automation enablement, and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the cache macro to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.
    • attachment - Chart image will be saved in a attachment.
      • ^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

Colors can be specified by name or hex value. See Web-colors. The following are the valid color names that will automatically be converted.
Color Hexadecimal Color Hexadecimal Color Hexadecimal Color Hexadecimal
black #000000 silver #c0c0c0 maroon #800000 red #ff0000
navy #000080 blue #0000ff purple #800080 fuchsia #ff00ff
green #008000 lime #00ff00 olive #808000 yellow #ffff00
teal #008080 aqua #00ffff gray #808080 white #ffffff

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

Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
M Month in year Month July; Jul; 07
w Week in year Number 27
W Week in month Number 2
D Day in year Number 189
d Day in month Number 10
F Day of week in month Number 2
E Day in week Text Tuesday; Tue
a Am/pm marker Text PM
H Hour in day (0-23) Number 0
k Hour in day (1-24) Number 24
K Hour in am/pm (0-11) Number 0
h Hour in am/pm (1-12) Number 12
m Minute in hour Number 30
s Second in minute Number 55
S Millisecond Number 978
z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
Z Time zone RFC 822 time zone -0800
Pattern letters are usually repeated, as their number determines the exact presentation.
  • Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
  • Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless its needed to separate two adjacent fields.
  • Year: For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.

    For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.

    For parsing with the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isnt all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.

  • Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
  • General time zone: Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:
         GMTOffsetTimeZone:
                 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.

{advanced-search:id=config_id}

The {advanced-search} macro requires a valid id that relates to an xml configuration on the Advanced Search Configuration page in the Admin Panel.

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

The {search-input} macro provides an input field synonymous to a HTML input field and has no body.

  • autoSubmit - (boolean) Submit the form as soon as the page loads, providing default results. (defaults is false).
  • hidden - (boolean) Hide the form from view (only useful when autoSubmit=true)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-input:type=checkbox|match=label|value=alpha|checked=true} Search for Alpha?
  {search-input:type=checkbox|match=label|value=beta} Search for Beta?
  {search-submit}
{search-form}

{search-results}

The {search-input} macro provides an input field synonymous to a HTML input field and has no body.

  • match - (string) Type of Search Field (label, metadata, query).
  • metadataKey - (string) Metadata Key - only valid if match=metadata
  • type - (string) Type of Field (text, checkbox, hidden)
  • value - (string) Value of the Field
  • checked - (boolean) Inital State - only valid if type=checkbox (default is false)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-select:match=query|nullLabel=neither}
    {search-option:value=alpha}Alpha{search-option}
    {search-option:value=beta}Beta{search-option}
  {search-select}
  {search-submit}
{search-form}

{search-results}

The {search-select} macro provides an select field (drop-down list) synonymous to a HTML select field, with options defined in it's body by the {search-option} macro.

  • match - (string) Type of Search Field (label, metadata, query). This parameter is required.
  • metadataKey - (string) Metadata Key is only valid if match=metadata
  • nullLabel - (string) Label of the "unanswered" option

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-select:match=query|nullLabel=neither}
    {search-option:value=alpha}Alpha{search-option}
    {search-option:value=beta}Beta{search-option}
  {search-select}
  {search-submit}
{search-form}

{search-results}

The {search-option} macro provides an option field synonymous to a HTML option field, its body is wiki rendered and is the outputted label for the option.

  • value - (string) Value of the Field.
  • selected - (boolean) Is this Option Selected. (default is false)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

The {search-submit} macro must be included within the search-form if you wish your users to be able to manually submit the search.
(If you hide the search form and set it to auto submit, then this is not needed.)
The default text on the button can be changed, eg:

{search-submit:Search}

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

The {search-results} macro is used to display the output of the search and to configure how the search results are displayed.

  • Types - There are 4 content types you can search for currently. You specify them as a comma separated list and any of the specified content types are included in the results. The 4 content types are: page, blogpost, userinfo and spacedesc.
  • Fields - There are 6 fields, and can be displayed in any order - however title must always be display. They can also be renamed:
    rating,title!My Title,author
    That would put the fields in that order, renaming the title field to "My Title".
  • Excerpts - If shown, the contents of the {excerpt} macro are used first and then it falls back on the the content excerpt used in the standard search results.
  • Ratings - If the rate macro is use (or has been in the past) and the page has ratings, then an average is found. If the rateThreashold (defaulting at 5) isn't met (i.e. if there haven't been 5 people rating this content) then it uses 0. If there isn't any rate data then it defaults to 0 as well. NOTE: If the content has been rated in the past, and the rate macro is then removed - the rating data will sill remain and will still be used by this plugin. This can be worked around by detecting the presence of a {rate} macro first in the content - however this work around isnt in effect yet. Please let me know if this is needed.

See Also: Plugin Homepage and Documentation

{published-date}

Injects the published date into the page properties.

See Also: Plugin Homepage and Documentation

{widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E}
{widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E | width=500 | height=400}

Widget Connector

  • url - (required) The URL to the widget you want to display in Confluence
  • {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E}
  • width & height - (optional) Specify the width and height of your widget
  • {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E | width=500 | height=400}
{flash:file=^example.swf}


{flash:file=example.swf}


{flash:file=example.swf|play=false|loop=false|bgcolor=#00FF00}


{flash:file=EXAMPLE:Example page^example.swf|show=link|title=Flash example}


{flash:url=http://.../example.swf}


{flash:file=example.swf}


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.
{content-by-user:fred}

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

{index}

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

{include:Home}

{include:FOO:Home}

{include:spaceKey=FOO|pageTitle=Home}
Includes one page within another (this example includes a page called "Home"). Pages from another space can be included by prefacing the page title with a space key and a colon.

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

{note:title=Be Careful}
The body of the note here..
{note}

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..
{warning:title=Warning}
Insert warning message here!
{warning}

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!
{info:title=Be Careful}
This macro is useful for including helpful information in your confluence pages
{info}

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
{tip:title=Handy Hint}
Join the Confluence Mailing-List!
{tip}

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!
{graph-from-table}
| A | B |
| A | C |
{graph-from-table}


{graph-from-table}
|| heading 1 ignored || heading 2 ignored ||
| A node | B node | label="relationship 1", style=dashed | style=normal | fillcolor=lightblue |
| A node | C node |
| A node | D node | style=invis |
{graph-from-table}


{graph-from-table:node=fillcolor=lightblue,fontsize=20|edge=style=bold,color=red| replace=key1:'style=dashed, color=blue', key2:style=invis|ranksep=2.0}
| A node | B node | | shape=polygon,sides=8,peripheries=3 | |
| A node | B node | | style=dashed |
| A node | C node |
| A node | D node | key2 |

Here is a second table
| E | F | key1 |
| F | G | key1 |
{graph-from-table}


{graph-from-table:direction=LR|ranksep=1.5|node=fillcolor=lightblue,fontsize=20| edge=style=bold,color=red|replace=key1:style=dashed}
| A node | B node | label="r1" | | | cluster 1 | key1 |
| F | G | key1 | | | cluster 1 |
| X | Y | key1 | | | cluster 1 | | big cluster |
{graph-from-table}


{graph-from-table:direction=LR|edge=color=blue|displayData=true}

{sql:dataSource=ConfluenceDS}
select PARENTID, TITLE from CONTENT where PARENTID is not NULL
{sql}

{graph-from-table}

Converts a table into a Graphviz graph by rendering the body of the macro and then converting each row in each table to a node relationship. A flowchart macro is used for the rendering. This macro simplifies use of the Graphviz support by eliminating or significantly reducing the need to know the dot language. Advanced users will still need to consult the Graphviz documentation for the multitude of attributes and settings that are possible.

The table or tables specified in the body of the macro can be wiki markup or created as a result of other macros. Specifically, the sql, csv, and excel macros can be used to produce the tables.

The columns in the table are interpreted as follows:

  1. Node with label equal to the column. The source of a relationship.
  2. Node with label equal to the column. The target of a relationship.
  3. Relationship attributes.
  4. Source node attributes.
  5. Target node attributes.
  6. First cluster label. A cluster is a subgraph that contains the source and target nodes for this row.
  7. First cluster attributes. For instance, if you do not want a label to show for the cluster, put label=""
  8. Second cluster label. The second cluster is a subgraph that contains the first cluster.
  9. Second cluster attributes.

Attributes are defined by Graphviz for nodes, relationships, and subgraphs (clusters). They are specified as comma separated list. Attribute values containing blanks must be surrounded by double quotes. Some commonly used attributes are:

  • label - text to display
  • style - examples: filled, bold, dotted, dashed, invis (for invisible)
  • fillcolor - node fill color
  • fontname - standard font name (enclosed in double quotes if contains a blank)
  • fontsize - standard font size
  • fontcolor - color usually specified as a color name like blue, grey, lightyellow
  • shape - examples: rect, box, circle, ellise, triangle, polygon (together with sides attibutes), diamond, ...
  • sides - number of sides for a polygon shape
  • peripheries - number of node boundaries

References:

Parameters - all are optional:
  • displayData - Default is false. Set to true to show the rendered body data after the graph. This is useful to see the results of a sql macro for instance.
  • node - The default node attributes are: shape=rect, style=filled, fillcolor=lightyellow, fontname="Verdana", fontsize=9. The default attributes are taken from the default flowchart macro behavior. By specifying the node parameter, you can override these defaults or add additional default attributes. See the Graphviz Documentation for information on attributes and settings.
  • edge - The default edge attributes are: arrowsize=0.8. The default attributes are taken from the default flowchart macro behavior. By specifying the edge parameter, you can override these defaults or add additional default attributes. See the Graphviz Documentation for information on attributes and settings.
  • direction - The default layout direction is top to bottom (TB). Set direction=LR to layout in a left to right direction. This is equivalent to the rankdir setting.
  • 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 graph. Defaults to all tables found in the body.
  • columns - Allows selection of the columns of the table that will be used for the graph. It must be a comma separated list of 1 or more positive integers in any order. The default is columns=1,2,3,4,5,6,7,8,9. If the table does not contain the column indicated, it will be ignored. For example, if columns=3,13 then column 3 will be used for the source node and column 13 will be used for the target node of the relationship. All other columns will be ignored.
  • replace - A comma separated list of key:value pairs that will be used to convert column values to attributes. If a column value for an attribute column matches one of the keys, the associated value will replace the column value. This makes it easy to associate attributes to column data. If more than one attribute needs to be specified for a key, enclose the value in a single quote so that the comma gets treated as a attribute separator.
  • ... - All other parameters are passed through to Graphviz for setting any global Graphviz parameter. Some common examples are:
    • ranksep - Separation in inches between nodes.
    • bgcolor - Background color.
    • size - Size specified as width, height in inches. Example: size="3,5".
{graphviz}
digraph {
A -> B
A -> C
C -> D
}
{graphviz}

Displays a graph drawn using the GraphViz language.

{flowchart}
A -> B
A -> C
C -> D
{flowchart}

Displays a flowchart diagram drawn using the GraphViz language. Some defaults are set to match the Confluence look.

{noformat}
pre-formatted piece of text
so *no* further _formatting_ is done here
{noformat}
Makes a pre-formatted block of text with no syntax highlighting. All the optional parameters of {panel} macro are valid for {noformat} too.

  • nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
Example:
pre-formatted piece of text
so *no* further _formatting_ is done here

{panel}Some text{panel}

{panel:title=My Title}Some text with a title{panel}

{panel:title=My Title| borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor=#FFFFCE}
a block of text surrounded with a *panel*
yet _another_ line
{panel}
Embraces a block of text within a fully customizable panel. The optional parameters you can define are the following ones:
  • title: Title of the panel
  • borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
  • borderColor: The color of the border this panel uses
  • borderWidth: The width of the border this panel uses
  • bgColor: The background color of this panel
  • titleBGColor: The background color of the title section of this panel

Example:

My Title
a block of text surrounded with a panel
yet another line

Confluence Content

Ways to include, summarise or refer to other Confluence content.

Notation Comment
!quicktime.mov!

!spaceKey:pageTitle^attachment.mov!

!quicktime.mov|width=300,height=400!

!media.wmv|id=media!
Embeds an object in a page, taking in a comma-separated of properties.

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

Other types of files can be used, but may require the specification of the "classid", "codebase" and "pluginspage" properties in order to be recognised by web browsers.

Common properties are:
  • width - the width of the media file
  • height - the height of the media file
  • id - the ID assigned to the embedded object

Due to security issues, files located on remote servers are not permitted
Styling
By default, each embedded object is wrapped in a "div" tag. If you wish to style the div and its contents, override the "embeddedObject" CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format "embeddedObject-ID" are used.
{attachments:patterns=.*doc|old=true}

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.

{bookmarks}

Displays a list of bookmarks using the criteria supplied.

Searching Options

  • spaces comma separated list of spaces to search for. Meta space names @all, @personal, @global can also be used. (If no labels and spaces are supplied will default to current space.)
  • labels list of labels that are applied to the bookmarks. (If multiple labels are specified bookmarks only have to match one label to be included.)
  • creators comma separated list of users that have created bookmarks.

Sorting Options

  • sort comma separated list of attributes to sort the bookmarks by. Valid values are:
    • creation Bookmark Created Date
    • creator Bookmark Creator Name
    • title Bookmark title
    Default is by created date.
  • reverseSort Reverse the order of the bookmarks. Default is false.

Display Options All options default to true.

  • showAuthor The user that created the bookmark.
  • showDate The relative date the bookmark was created.
  • showDescription The bookmark description.
  • showEditLinks If the current user has permission, show quick links to edit or remove the bookmark.
  • showLabels The labels for the bookmark.
  • showListHeader The bookmark list header (with the rss feed link).
  • max The maximum number of bookmarks to display. Defaults to 15.
  • showSpace The space the bookmark is saved in
  • showViewLink A link to the actual bookmark page

{pagetree}

{pagetree:root=PageName}

{pagetree:root=PageName|sort=natural|excerpt=true|reverse=false}

{pagetree:root=@home|startDepth=3}

{pagetree:searchBox=true}

{pagetree:expandCollapseAll=true}

Provides page hierachal tree within a space. If no parameters are specified the root of the tree will be the home page, a different root page can be specified by providing the page to the root parameter.

  • root: - (optional) page where the tree would be rooted from. Meta root names @self, @parent, @home can also be used.
  • sort: - (optional) sorts the tree node. It my be one of the following: bitwise, creation, modified, natural, position. Default sorting is position
  • excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false).
  • reverse: - (optional) true/false flag that allows you to reverse the order of the display (default is false).
  • searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false).
  • expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false).
  • startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1).

{pagetreesearch}

{pagetreesearch:rootPage=PageName}

{pagetreesearch:rootPage=Space:PageName}

Provides a search box to search a page hierachal tree within a space.

If no parameters are specified the root of the tree will be the current page, a different root page can be specified by providing the page to the rootPage parameter.

{toc:style=disc|indent=20px}
{toc:outline=true|indent=0px|minLevel=2}
{toc:type=flat|separator=pipe|maxLevel=3}

Creates a Table of Contents for headings on the the current page.

  • type - (optional) The type of output. May be one of the following:
    • list - (default) The headings are output in hierarchical list format.
    • flat - The headings are listed on a single line with a separator between them.
  • class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
  • style - (optional) The style of the list items if in list mode. The style may be any of the following:
    • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
    • any CSS style - Headings are output in indented lists with the specified CSS style.
  • outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
  • ident - (optional) The amount to indent each list sub-heading by (default is '10px').
  • separator - (optional) The type of separator to use if the style is flat. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item. (default)
    • brace - Square brackets ('[', ']') surrounding each item. (default)
    • comma - A comma (',') between each item.
    • paren - Parentheses ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
  • maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
  • include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
{toc-zone:separator\=brackets|location=top}
h1. First Heading
blah blah blah...
{toc-zone}

Creates a Table of Contents for headings contained in the macro body.

  • location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations.
  • type - (optional) The type of output. May be one of the following:
    • list - (default) The headings are output in hierarchical list format.
    • flat - The headings are listed on a single line with a separator between them.
  • class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
  • style - (optional) The style of the list items if in list mode. The style may be any of the following:
    • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
    • any CSS style - Headings are output in indented lists with the specified CSS style.
  • outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
  • ident - (optional) The amount to indent each list sub-heading by (default is '10px').
  • separator - (optional) The type of separator to use if the style is flat. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item. (default)
    • brace - Square brackets ('[', ']') surrounding each item. (default)
    • comma - A comma (',') between each item.
    • paren - Parentheses ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
  • maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
  • include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
{livesearch:id=1|spaceKey=KEY}

Show search results keystroke by keystroke.

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

{contributors-summary:order=edits|limit=3|showAnonymous=true}

{contributors-summary:columns=edits|order=editTime}

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

{contributors:order=edits}

{contributors:include=authors,labels|mode=list|showCount=true}

{contributors:order=editTime|limit=6}

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.

{viewfile:presentation.ppt}

{viewfile:space=dog|page=testpage|name=worddocument.doc}

{viewfile:spreadsheet.xls|grid=false|sheet=Sheet 1|row=4|col=5}

{viewfile:slideshow.pdf|width=200|height=150}

Embeds the content of a file attachment into a Confluence page. Supported formats:

  • Microsoft Word Documents
  • - Embedded as html
  • Microsoft Excel Spreadsheets
  • - Embedded as html
  • Microsoft Powerpoint Presentations
  • - Embedded in a flash slideshow control or as a single image for individual pages
  • Adobe PDF files
  • - Embedded in a flash slideshow control or as a single image for individual pages
  • space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
  • page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
  • date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
  • name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}
Macro arguments specific to Excel spreadsheets
  • grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
  • sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
  • row - (optional)the last row in the worksheet to render. The default is the last row with content.
  • col - (optional)the last column in the worksheet to render. The default the last column with content.
Macro arguments specific to Powerpoint and PDF presentations
  • slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
  • height - (optional)overrides the default height of the flash control or image.
  • width - (optional)overrides the default width of the flash control or image.

{tracking-info:value=view count}0{tracking-info}
{tracking-info:^attachment.ext|value=first view date|format=dd-MMM-yyyy}Anonymous{tracking-info}
{tracking-info:SPACE:Page|value=view count|type=gif|images=customgif}Unviewed{tracking-info}
{tracking-info:SPACE:Page^attachment.ext|value=last view date}Never modified{tracking-info}
Outputs information about the specified content.
  • [default] - (optional) The content to report the view count for. Any standard Confluence link syntax is valid, although external links will not produce useful information.
  • value - (required) The value to output. One of the following:
    • first view date - The date the content was first viewed by someone other than the creator.
    • last view date - The date the content was last viewed by someone other than the last editor.
    • view count - The number of times the content has been viewed since the firstViewed date.
For values returning a number, the following parameters may also be set:
  • digits - (optional) The minimum number of digits to output. Defaults to 1.
  • type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output.
  • images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style.
For values returning a date, the following parameters may also be set:
  • format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or 'short', which will use the system defaults for those formats.
{tracking-table:scope=Page > descendents|labels=tracked|type=page, attachment}
{tracking-table}
Outputs a table containing data about the matching content. Defaults to displaying the title, view count, first view date and last view date.

Display Options

  • sort - (required) The sort order. May be one or more of the options listed below followed optionally by 'asc' or 'desc', separated by commas. The default is "view count desc, natural title".
    • natural title - The natural content title. Eg. "Page 2" comes before "Page 10".
    • exact title
    • - The exact content title. Eg. "Page 2" comes after "Page 10".
    • space key - Sorted by the space key the content is contained in.
    • space name - Sorted by the unicode-safe natural order of the space name.
    • creation date - The date the content was created.
    • modification date - The date the content was last modified.
    • first view date - The date the content was first viewed by someone other than the creator.
    • last view date - The date the content was last viewed by someone other than the last editor.
    • view count - The number of times the content has been viewed since the firstViewed date.
  • maxResults - Outputs up to this number of results. Default is unlimited.
For values returning a number, the following parameters may also be set:
  • digits - (optional) The minimum number of digits to output. Defaults to 1.
  • type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output.
  • images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style.
For values returning a date, the following parameters may also be set:
  • format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or 'short', which will use the system defaults for those formats.

Filtering Options

In general, all filtering parameters are lists of optional, required or excluded values. Optional items simply list the value, required items are prefixed with a '+', and excluded values are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but not the "bar" label would look like this:

labels=foo, -bar

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just wrap it in a set of quotes. Eg:

labels="foo-bar"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Defaults to 'page, news, attachment'. Valid types include:
    • space - Spaces
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • userinfo - User profile
    • attachment - An attachment
{tracking-table}
{tracking-column:value=title}
{tracking-column:value=creation date|format=dd-MMM-yyyy}
{tracking-column:value=view count}
{tracking-column:value=modification date}
{tracking-table}
Defines a column to display in a {tracking-table}.
  • value - (required) The value to output. One of the following:
    • id - The content's unique id.
    • title - The content title.
    • space key - The content's space key.
    • space name - The content's space name.
    • creation date - The date the content was created.
    • modification date - The date the content was last modified.
    • first view date - The date the content was first viewed by someone other than the creator.
    • last view date - The date the content was last viewed by someone other than the last editor.
    • view count - The number of times the content has been viewed since the firstViewed date.
For values returning a number, the following parameters may also be set:
  • digits - (optional) The minimum number of digits to output. Defaults to 1.
  • type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output.
  • images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style.
For values returning a date, the following parameters may also be set:
  • format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or 'short', which will use the system defaults for those formats.
{children}

{children:all=true}

{children:depth=x}

{children:depth=x|style=h3}

{children:excerpt=true}

{children:page=Another Page}

{children:page=/}

{children:page=SPACEKEY:}

{children:page=SPACEKEY:Page Title}

{children:first=x}

{children:sort=<mode>|reverse=<true or false>}
Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants.

The 'style' attribute can be any of 'h1' through 'h6'. If you specify a style, the top level of child pages will be displayed as headings of that level, with their children then displayed as lists below. A great way to throw together a quick contents page!

You can view the children of a different page in the same space with {children:page=Another Page Title}.

If you specify a page of '/', you will list all the pages in the space with no parent (i.e. the top-level pages), excluding the current page

If you specify a page of 'FOO:' (the colon is required), you will list all the pages with no parent in the space with key "FOO".

Specify 'excerpt=true' to also display the first line of the pages excerpt (see the excerpt macro) if it exists.

Example:

  • child
  • another child
  • child
    • first grandchild
  • another child

The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date. Use the reverse attribute to optionally reverse the sorting.

The 'first' attribute allows you to restrict the number of children displayed at the top level.

{search:query=my_query}

{search:query=my_query|maxLimit=x}
Does an inline site search.
  • query: your query
  • maxLimit=x: (where x is any number > 0) to limit the search result to a number of results.
  • spacekey: specify the key of the space you want to search in
  • type: specify the content type (could be page, comment, blogpost, attachment, userinfo, spacedesc)
  • lastModified: specify a time period in which the content was last modified: (e.g. 3d = modified in the last 3 days, 1m3d = modified in the last month and three days)
  • contributor: specify the username of the contributor of the content to be retrieved

Example:

Found 2 result(s) for home

Home (My Space)
This is the home page for My Space.
PDF File file-containing-home.pdf ( download)
{blog-posts:max=5}

{blog-posts:max=5|content=excerpts}

{blog-posts:max=5|content=titles}

{blog-posts:time=7d|spaces=@all}

{blog-posts:max=15|time=14d|content=excerpts}

{blog-posts:labels=confluence,atlassian}

{blog-posts:labels=+atlassian,+confluence,+content}

Displays the most recent blog posts in this space.

  • content - lets you choose whether to display each blog post in its entirety (the default), just short excerpts from each item (see the excerpt macro), or just a list of post titles.
  • time - lets you choose how far back to look for blog posts. For example, "time=12h" would show you those items made in the last twelve hours, and "time=7d" would show items made in the last week. (The default is no limit)
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
  • type - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions
    • mail: emails in a space

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
  • max/maxResults - (optional) the maximum number of results to return. Defaults to 100.
  • sort - (optional) the sorting to apply to the results.
    Accepted values:
    • title: by content title
    • creation: by time of creation
    • modified: by time of last modification (creation is the "first" modification)
  • reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

{excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt}

{excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt}
Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content.
  • hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.
{excerpt-include:Home}

{excerpt-include:Home|nopanel=true}

{excerpt-include:blogPost=/2006/12/28/News Page}
Includes the excerpt from one page (see the excerpt macro) within another. The included page must be in the same space as the page on which the macro is used.
  • nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
{popular-labels}

{popular-labels:style=heatmap|count=15}

Renders a list (or heatmap) of the most popular labels ordered by popularity (or name).

  • count - (optional) Specify the number of labels to be displayed. If not specified, a default of 100 is used.
  • spaceKey - (optional) Restrict the popular labels to a certain space.
  • style - (optional) Allows 'heatmap'. Specifying a heatmap style will use different font sizes depending on their rank of popularity, ordered by label names. If not specified, a default list style is used ordered by popularity (highest first).

{contentbylabel:labels=dogs,cats}
{contentbylabel:labels=dogs,cats|space=PETS}
{contentbylabel:labels=dogs,cats|type=page,blogpost}
{contentbylabel:labels=dogs,cats|showLabels=false|showSpace=false}
{contentbylabel:labels=dogs,cats|excerpt=true}
{contentbylabel:labels=+dogs,+cats}
{contentbylabel:labels=+lebowski,+bowling,-walter|space=@all|type=page,-blogpost}

Displays a list of content marked with the specified labels.

  • type - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions
    • mail: emails in a space

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
  • showLabels - (optional) display the labels for each results (enabled by default)
  • showSpace - (optional) display space name for each result (enabled by default)
  • title - (optional) add a title above the results list
  • max/maxResults - (optional) the maximum number of results to display (default is 5)
  • excerpt - (optional) display first line of excerpt for each result
  • space/spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • sort - (optional) the sorting to apply to the results.
    Accepted values:
    • title: by content title
    • creation: by time of creation
    • modified: by time of last modification (creation is the "first" modification)
  • reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

{related-labels}

{related-labels:labels=labelone, labeltwo}

Renders a list of labels related to the current page's labels.

  • labels - (optional) comma-separated list of labels whose related labels will be displayed.

{recently-updated}
{recently-updated: spaces=sales,marketing | labels=timesheets,summaries}
{recently-updated: labels=+confluence,-jira | spaces=@all}
{recently-updated: spaces=NOVELS,SHORTSTORIES | sort=creation | reverse=true}

Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%

  • space/spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces. Defaults to the current space (@self).
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • width - (optional) width of table on Confluence page, defaults to 100%.
  • type/types - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces. Defaults to all types. In shared mode, the personal information type is excluded from the defaults.

{recently-used-labels}

{recently-used-labels:scope=space|count=15}

Renders a list (or table) of labels most recently used in a specified scope.

  • count - (optional) Specify the number of labels to be displayed. If not specified, a default of 10 is used.
  • scope - (optional) Allows 'global', 'space' and 'personal'. If not specified, the 'global' scope is used. The global scope will show labels that were recently used within this confluence instance. The space scope will show labels that were recently used in the current space. The personal scope will show you personal labels that you recently used.
  • style - (optional) Allows 'table'. Specifying a table style will render the most recently used labels in a table form.
  • title - (optional) Allows you to specify a heading for the table view of this macro. See the 'style' option above.

{navmap:mylabel}
{navmap:mylabel|wrapAfter=3|cellWidth=110|cellHeight=20|theme=mytheme}

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.

{listlabels:spaceKey=@all}

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.

documentation, staff, events, books, music

{spacegraph}

{spacegraph:spaceKey|showOutgoingLinks=true}

Displays a diagram of the pages in a space. By default it displays the current space. If a spacekey is supplied as the default parameter, that space is displayed. Only pages that the current user is authorized to view are displayed.

  • default parameter - use current space unless the default parameter is set to a space key.
  • showOutgoingLinks - default is false. Set to true to show links to other Confluence pages. Outgoing links are shown as dotted lines.
{spaces:width=x}

Displays a list of global 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%.

{recently-updated-dashboard}
{recently-updated-dashboard: spaces=sales,marketing | labels=timesheets,summaries}

Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%

  • spaces - (optional) comma separated list of space keys
  • labels - (optional) comma separated list of labels (content associated with at least one of these will be listed)
  • width - (optional) width of table on Confluence page, defaults to 100%.
  • types - Filter content by type. You can specify one or more types, separated by commas. Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions
    • mail: emails in a space
  • showProfilePic - if true, display the profile pictures of the users who updated the content.

{global-reports: width=x}

Renders a list of links to global reports within a table of width x (defaults to 99%).

  • width - (optional) width of table on Confluence page, defaults to 50%.

{welcome-message}

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

{create-space-button: size=large | width=32 | height=32}

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

{userlister}

{userlister:groups=confluence-administrators}

{userlister:online=true}

{userlister:groups=confluence-users|online=true}

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.

External Content

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Example:

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

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

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

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

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

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

Parameters

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

{sql:dataSource=TestDS|output=wiki}
select * from test
{sql}


There are *{sql:dataSource=TestDS|table=false} select count(*) from test01 {sql}* rows in table test01


{sql:dataSource=TestDS|p1=%test%|showsql=true}
select * from test01 where a1 like ?
{sql}

SQL Macro

Displays the result table(s) or values from an SQL statement(s), usually a query. Consider using the sql-query macro for simple queries. Data from single or multiple results sets are formatted usually as a table for display. Multiple SQL statements (semi-colon separated) can be specified within a single sql macro body (subject to support provided by specific databases). This macro supports common table capabilities with other table based macros (table-plus, csv, and excel).

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use: Four identical macros sql, sql1, sql2, and sql3 are provided to enable recursive use of the macro.

  • dataSource - Required parameter. Formerly known as the jndi parameter. For compatibility the jndi parameter will be still be used if the dataSource parameter is missing. Specify the datasource name defined in the application server. Do not use the standard prefix (java:comp/env/jdbc/) as it is added automatically if necessary. Specific values of this parameter may be restricted for security reasons. See your administrator for details.
  • output - Determines how the output is formated:
    • html - Data is output as a HTML table (default).
    • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
  • script - Location of sql statement. Default is the macro body only.
    • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • global page template name - Data is read from a global page template.
    • space:page template name - Data is read from a space template.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
  • border - The border width in pixels. Defaults to normal table border width.
  • width - The table width in pixels. Default is 100%.
  • rowOrientation - By default, data is oriented with rows appearing vertically (in rows) and columns in columns. Specify rowOrientation=horizontal to have rows appear horizontally (as columns) and columns appear as rows.
  • columnLabel - By default, database column names are used as column labels. Specify columnLabel=true to have database column labels used for column labels. Note that most databases default the column label to be the column name when no explicit column label is provided. Fly-over text for a column label will be the column name when columnLabel=true. Fly-over text for a column label will be the database column label when columnLable=false or by default.
  • limit - Sets the limit for the number of database rows that will be processed for display. The default is set by your administrator. Setting a larger value for this parameter may be restricted by your administrator. See your administrator for details.
  • showUpdateCount - Default is false. Set to true to show a count of the number of rows updated.
  • escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Set escape=true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
  • convertNull - Default is true. Converts SQL NULL values to blank. Set to false to have NULL values show up as 'null'.
  • table - Default is true. Set to false to not format the data in a table. This option can be used to run queries that produce single values that you want to include in text.
  • noDataMessage - Default is blank. Text that is displayed when there are no rows in the result set. Use @default for a default message.
  • noDataError - Default is false. Set to true to show an macro error when no data is returned from the query.
  • expandArray - Default is true to have array fields expanded one entry per line for vertical row orientation.
  • showSql - Default is false. Set to true to show a panel with the sql statement.
  • macros - Default is false. Set to true to execute any macros so their value can be passed to the SQL query.
  • SQL parameter markers - SQL supports parameter markers in statements - these are identified by ?'s. Parameters p1, p2, ... are substititued for the parameter markers. This can be used to parameterize complex scripts stored as attachments or files.
    • p1 - first parameter marker
    • p2 - second parameter marker
    • ... - ...
  • autoCommit - Advanced use only. Default is true. Set to false for sql that explicitly controls its own rollbacks and commits.
  • transactionIsolation - Advanced use only. Set the transaction isolation level for the sql statements. The default will be used unless this parameter is set to a valid value from the following list:
    • READ_COMMITTED (default) - any changes made inside a transaction are not visible outside it until the transaction is committed.
    • READ_UNCOMMITTED - allows transactions to see uncommitted changes to the data.
    • REPEATABLE_READ - rows that are read retain locks so that another transaction cannot change them when the transaction is not completed.
    • SERIALIZABLE - Tables are locked for the transaction so that WHERE conditions cannot be changed by other transactions that add values to or remove values from a table
    • NONE - Database does not support transactions
  • disableAntiXss - Default is false. Set to true to stop encoding of html special characters found in table content. For security reasons, use of this parameter is restricted to authorized users. See your administrator for details.
{sql-query:dataSource=TestDS|output=wiki}
select * from test
{sql-query}

SQL Query Macro

Displays a result table or values from an SQL select statement. The sql-query macro is recommended for better performance.

This macro supports the same parameters as the sql macro, the primary difference is optimizations possible by the database when it knows that a select statement is expected. Some databases/drivers ignore this advice and perform the same as with the sql macro.

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use: Four identical macros sql-query, sql-query1, sql-query2, and sql-query3 are provided to enable recursive use of the macro.

{junitreport:directory=file:///c:/test-reports}
(currently only picks up result files in XML format. Set ant formatter to "xml")

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

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

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

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

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

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

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

Example:

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

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

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

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

Misc

Various other syntax highlighting capabilities.

Notation Comment
\X Escape special character X (i.e. '{')
:), :( etc Graphical emoticons (smileys).
Notation :) :( :P :D ;) (y) (n) (i) (/) (x) (!)
Image
Notation (+) (-) (?) (on) (off) (*) (*r) (*g) (*b) (*y)
Image
Macros

Macros allow you to perform programmatic functions within a page, and can be used for generating more complex content structures.

Notation Comment
{vote:What is your favorite color?}
Red
Blue
None of the above
{vote}

{vote:What is your favorite color?|changeableVotes=true|voters=user1,user2}
Red
Blue
None of the above
{vote}

The vote macro allows Confluence users to vote on any topic of interest. Users are allowed to select only one of the given choices and vote one time, and the results will not be visible to them until they have voted. Users that have not logged in will be prompted to do so before allowing them to cast a vote. This macro was created to support quick, informal votes on various topics. The macro has a title and a series of choices, each choice starting on its own line.

Parameter Required Default Description

true
This is the title of the ballot and must be the first paramter.
voters false all users This is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewers false all users This is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
changeableVotes false false This parameter, if set to true, will allow the voters to change their vote after it has been cast.
locked false false Dont allow any further voting. Show a lock Symbol to indicate that.

Before the user logs in:

What is your favorite color? (Log In to vote.)
Choices Your Vote
Red
Blue
None of the above

Before the logged-in user votes:

What is your favorite color?
Choices Your Vote
Red
Blue
None of the above

After the logged-in user votes:

What is your favorite color?
Choices Your Vote Current Results: (10 total votes)
Red
(4 votes, 40%)
Blue
(5 votes, 50%)
None of the above
(1 votes, 10%)
{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Knowledge - This is the knowledge category.
Communication - This is the communication category.
{survey}

The survey macro allows Confluence users to be surveyed on several categories. For each category, users are allowed to select only one of the given choices, and the results will not be visible to them until they have voted. Users that have not logged in will be prompted to do so before allowing them to cast a vote. This macro was created to support surveys of confluence users on several categories and will provide them with the chance to give a rating (1 to 5) for each category as well as a comment.

The body of this macro defines the categories that the users will be polled on. Each line of the body will be treated as a seperate category and should be written in the format "title - description". The title is always required but the dash and the description are optional.

Parameter Required Default Description
title false default no title If a Title is specified the Survey gets a Box around which makes it looking more compact and feeling the votes are belonging more together.
voters false all users This is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewers false all users This is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
changeableVotes false false This parameter, if set to true, will allow the users to change their responses after they have been cast.
choices false default 1-5 A comma separated List of choices. This will override the Default (1-5) List, but can still be overriden by a '-' separated list in each single line.
showComments false true Show comments-menu (the whole set: show, add, edit, delete)
locked false false Dont allow any further voting. Show a lock Symbol to indicate that. Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements)