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

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

{imagemap:name=[SomePage^SomePicture.jpg]}
{map:link=[myTarget]| coords=257,174,363,233| title='Jump to Target'| shape='rect'}
{imagemap}

{imagemap} Base-Plugin defining the image to use for the ImageMap.

  • name: (mandatory) Specifies the link to the image to be used as an ImageMap. Can be
    1) an absolute URL e.g. '[http://www.somedomain.com/somepicture.jpg]' or
    2) a Confluence-like link to an image-attachment [somepage^somepicture.jpg]

{map} Nested Plugin for defining clickable regions and target-links.

  • title: (optional) Tooltip text, that appears if the mouse stays over the clickable region.
  • coords: (mandatory) Coordinates of the shape:
    x1,y1,x2,y2 for rect-shapes
    x,y,r for circle-shapes
    x1,y1,x2,y2 ... xn,yn for polygon-shapes.
  • link: (mandatory) Target link where to go, after region was clicked.
    Can be
    1) an absolute URL e.g. 'http://www.google.com' or
    2) a Confluence-like link [somepage]
  • shape: (optional) The shape of the clickable region. Possible values are 'rect', 'circle' and 'polygon'. Defaults to 'rect'

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.

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

{report-table}

{xxx-reporter}

{report-column:title=Key 1}{report-info:item:key 1}{report-column}
{report-column:title=Key 2}{report-info:item:key 2}{report-column}

{report-empty}
This is displayed if no results are returned by the reporter.
{report-empty}

{report-table}

Displays the each of the items from a reporter in a table.

A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) one or more {report-column}s must be present to define what data is displayed. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter.

  • depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
  • sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the report sort criteria.
  • maxResults - (optional) The maximum number of results to display.
  • firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
  • width - (optional) The width of the table (e.g. '500px', '100%').
  • class - (optional) The CSS class to render the table with.
  • injected - (optional) If set to true, the {report-column} macros will default to injecting %prefix:key% values directly.
{report-column:title=Column Title}{report-item:value}{report-column}

Displays a single column in a {report-table}. This macro will usually contain at least one use of the {report-item} macro, or another macro which dispays information about the current item being reported on.

  • title - (required) The title to display in the table header.
  • width - (optional) The width of the column. Eg. "50px", "20em".
  • colSpan - (optional) The number of columns this column should span over.
  • rowSpan - (optional) The number of rows this column should span over.
  • newRow - (optional) If set to true, a new row will be started with this column.
  • class - (optional) The CSS class(es) to apply to this column.
  • summaryType - (optional) The type of summary to display at the end of this column. May be one of:
    • sum - The sum total of all numbers in the column.
    • count - The number of non-blank values in the column.
    • average - The average of all numbers in the column.
  • summaryValue - (optional) The key chain value for the column summary, or plain text to display if the 'summaryType' is not set for this column. E.g. "data:My Number", or "content:children > collection:size". *Note:* The summary value key can be completely unrelated to what is displaying in the column, if so desired.
  • summaryFormat - (optional) The number format to use for the summary. E.g. "$#,
  • injected - (optional) If set to true, %prefix:key% values in the body will be injected with report value before being rendered.
{report-list:depth=[1,2...all]|outline=true/false|style=[disc, decimal, etc]}

{xxx-reporter}

{report-body}
This content is repeated for each item. {report-body}

{report-empty}This is displayed if no results are returned by the reporter.{report-empty}

{report-list}

Displays the each of the items from a reporter as a list item.

A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) A {report-body} macro, which contains the wiki code which will be executed for each item. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter.

  • style - (optional) The style of bullet to display. May be any standard CSS style. Defaults to 'disc' if outlining is off, or 'decimal' if outlining is on.
  • outline - (optional) If set to 'true', the list and any sub-lists of children will be displayed with an outline number format (eg. "1.2.3"). Defaults to 'false'. Note: This setting will only display correctly in FireFox.
  • depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
  • sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the report sort criteria.
  • trim - (optional) If 'false', the body will not be trimmed. True by default.
  • injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly.
  • maxResults - (optional) The maximum number of results to display.
  • firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
{report-block}

{xxx-reporter}

{report-body}
This content is repeated for each item. {report-body}

{report-empty}This is displayed if no results are returned by the reporter.{report-empty}

{report-block}

Displays the each of the items from a reporter in a block of wiki text.

A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) A {report-body} macro, which contains the wiki code which will be executed for each item. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter.

  • separator - (optional) The type of separator to display between each item. Defaults to nothing. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item.
    • brace - Braces ('{', '}') surrounding each item.
    • comma - A comma (',') between each item.
    • paren - Parenthases ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • maxResults - (optional) The maximum number of results to display.
  • firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1.
  • depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents.
  • sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the report sort criteria.
  • injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly.
{report-header}
This content is displayed at the beginning of a non-empty report.
{report-header}

This macro contains the wiki code which will be displayed before a non-empty report. It must be contained in another report macro (e.g. {report-block}).

  • trim - (optional) If 'true', the body will be trimmed. False by default.
{report-body}
This content is repeated for each item of a report.
{report-body}

This macro contains the wiki code which will be executed for each item of the surrounding report. It is used by the {report-block} and {report-list} macros. It will usually contain one or more uses of the {report-item} macro to display reported values.

  • trim - (optional) If 'true', the body will be trimmed. False by default.
  • injected - (optional) If set to true, %prefix:key% values in the body will be injected with report values before being rendered.
{report-footer}
This content is displayed at the end of a non-empty report.
{report-footer}

This macro contains the wiki code which will be displayed after a non-empty report. It must be contained in another report macro (e.g. {report-block}).

  • trim - (optional) If 'true', the body will be trimmed. False by default.
{report-empty}
This content is displayed for reports with no items.
{report-empty}

This macro contains the wiki code which will be displayed if the surrounding report has no items. It is used by the {report-block}, {report-list} and {report-table} macros.

  • trim - (optional) If 'true', the body will have any leading or trailing white space removed before it is displayed. False by default.
{report-info:item:key|format=[number format/date format]|render=none/wiki|link=true/false}

Displays the specified key value for the current report item. The key is a set of Supplier keys, separated by ">" characters. For example, if the current item is a standard Confluence page, the following will display the page creator's full name:

        {report-info:content:creator > user:full name}
        

It first looks up the creator of the current item, then get the full name for that user.

  • default/key - (required) the key value to display.
  • format - (optional) The date (eg. 'dd MMM, yyyy') or number (eg. '#, This will only be used if the data is a date or a number, respectively. Otherwise, it will be ignored.
  • link - (optional) If set to 'true' and the current item/key has a URL link, the text generated will be linked to that URL. Defaults to 'false'.
  • render - (optional) If set to 'wiki', the generated text will be rendered as wiki text. Defaults to 'none'.
  • default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text. Alternately, the body of the macro can also be used, if more complex wiki text is required.
  • separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item.
    • brace - Braces ('{', '}') surrounding each item.
    • comma - A comma (',') between each item.
    • paren - Parenthases ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
{report-link:item:key|info=Mouse-over information|target=_blank}Link text{report-link}

Displays the specified key value as a link. It is assumed that the item/key value is an absolute or server-relative link. If not, the 'prefix' and 'postfix' parameters can be used to prepend or append extra values to the URL.

  • default/key - (required) the key value to use as the link URL.
  • info - (optional) The text which will be displayed when the user hovers their mouse over the link.
  • target - (optional) The target frame to open the link in. May be any standard HTML target.
  • prefix - (optional) The text to prepend to the item/key value in the link.
  • postfix - (optional) The item to append to the item/key value in the link.
  • trim - (optional) If set to 'false', the URL will not be trimmed. Defaults to 'true'.
{report-image:item:key|width=16px|height=16px}

Displays the specifed key value for the current item as an image. It is assumed that the key value retrieved is an absolute (eg. "http://server/folder/file.gif") or server-relative (eg. "/folder/file.gif") URL.

  • default/key - (required) the key value to use as the image URL.
  • width - (optional) The width of the image, using standard CSS units (eg. "20px" or "80em").
  • height - (optional) The height of the image, using standard CSS units (eg. "20px" or "80em").
  • border - (optional) The border style of the image, using standard CSS values (eg. "red dash 2px").
{report-on:item:key}
Sub-Item 1: {report-info:item:subkey 1}
Sub-Item 2: {report-info:item:subkey 2}
{report-on}

Sets the item context to the item/key value specified. This is useful when you wish to display several key values from a sub-item of the item currently being reported on. For example, you may wish to use the full name and email address of the current page's last modifier:

        {report-on:content:modifier}
        Last Modifier: {report-info:user:full name|link=true} ({report-info:user:email|link=true})
        {report-on}
        
  • default/key - (required) the key value to display.
  • default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text. Alternately, the body of macro can also be used, if more complex wiki text is required.
  • separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item.
    • brace - Braces ('{', '}') surrounding each item.
    • comma - A comma (',') between each item.
    • paren - Parentheses ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • injected - (optional) If set to true, %prefix:key% values will be injected with report values before being rendered.
{report-variable:[name]|format=[number format/date format]|value=%prefix:key%|default=%prefix:key%}
{report-variable:[name]|format=[number format/date format]|default=%prefix:key%}{xxx-reporter:...}{report-eval}

Stores the value, as defined by either the 'value' parameter, or the body of the macro, into the named variable in the local context, accessible via the 'variable:' prefix. If inside a report-body or report-column section, it will only be stored for the lifetime of the current item. If a 'reporter' macro is put into the macro body, it will be stored and can be reused across multiple reports.

  • default/name - (required) the name of the variable to store the result in.
  • value - (optional) The %injected% value of to store. If not provided, the macro body is used.
  • default - (optional) The contents of this parameter will be used if the item/key is empty. This can be an %injected% value.
  • format - (optional) Number format (eg. '#,
{report-eval:[name]|format=[number format/date format]}%X% + %Y%{report-eval}

Evaluates the mathematical expression contained in the body, injecting Supplier values from the local context. Basic mathematical operators such as '+', '-', '/', '*', '^' and brackets are available.

  • default/name - (optional) the name of the variable to store the result in. Accessible via 'variable:[name]'.
  • format - (optional) Number format (eg. '#,
  • hidden - (optional) If set to 'true', the result will not be output.
  • default - (optional) The contents of this parameter will be used if the item/key is empty. This can be an %injected% value.
{local-reporter:prefix:key}
{xxx-sort:prefix:subkey|order=[ascending, descending]}
{xxx-filter:prefix:subkey|extra parameters go here}
{local-reporter}

Allows a sub-report to be created from within another report. This reporter will display the contents of any sub-item of the current item, identified using the "prefix:key" value.

  • default/key - (required) the key value to display.
  • source - (optional) The location to set as the source context. If unspecified, the current report item (if in a report) or current page/news item will be the context.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{space-reporter:space=KEY}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{space-reporter}

Reports on Confluence Spaces. It must be used in a report of some type (eg. {report-block}). It will only list spaces visible to the current user. Also, further filtering can be made by specifying the 'spaces' parameter, or using custom filters.

  • space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following:
    • @self - (default) The space the current content is in.
    • @personal - Personal spaces only.
    • @global - Global spaces, that is, non-personal spaces.
    • @all - All spaces, both global and personal
    • SPACE KEY - Any other space key may be specified explicitly.
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{content-reporter:space=KEY|types=[page, +news, -comment]|scope=Page [> required scope]|labels=[one, +two, -three]}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{content-reporter}

Reports on Confluence content (pages, news, comments, attachments, etc). The content can be filtered by space, type, scope or labels, as well as any custom filters specified in the body of the macro.

  • space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following:
    • @self - (default) The space the current content is in.
    • @personal - Personal spaces only.
    • @global - Global spaces, that is, non-personal spaces.
    • @all - All spaces, both global and personal
    • SPACE KEY - Any other space key may be specified explicitly.
  • type(s) - (optional) The list of content types to allow. Defaults to allowing all types. Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following:
    • page
    • news
    • comment
    • attachment
    • spacedescription
  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{user-reporter:user=[usernames]|group=[group names]|space=SPACEKEY:view/edit/admin/news}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{user-reporter}

Reports on Confluence users matching the specified criteria.

  • user(s) - (optional) the (list of) users who can see the content.
  • group(s) - (optional) the (list of) groups who can see the conent.
  • space(s) - (optional) KEY > permission - the (list of) spaces where, if the user can view the space, they can see the content. The permission is optional - view is used by default. Otherwise, you may specify one of the following after the '>'.
    • view - (default) the user can view the space.
    • edit - the user can edit pages.
    • admin - the user has administration access.
    • news - the user can post a news entry.
    • comment - the user can post a comment.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{user-group-reporter}
{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{user-group-reporter}

Reports on the available user groups in Confluence. This list is only available to administrators and users who can create or administrate spaces.

  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{expanding-reporter:prefix:key|as=something}
{xxx-reporter}

{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{expanding-reporter}

This macro will expand upon the selected 'prefix:key' of each of the result items returned by the contained reporter. In database query terms, this is essentially a 'join' operation, and is mostly useful for many-to-many relationships. For example, a user can be a member of many groups, and each group can have many users as members. If you wish to display a list of all groups and their members in a single table, with only one group and one user listed per row, you need to expand on one or the other. You will end up with both being repeated multiple times, but such is the nature of the relationship. Using the {user-group-reporter} it would look something like this:

        {expanded-reporter:user-group:members|as=member}
          {user-group-reporter}
            {text-sort:user-group:name}
          {user-group-reporter}
          {text-sort:user:name}
        {expanded-reporter}
        

You would then display your results by doing something like this:

        {report-column:title=Group Name}{report-info:expanded:item > name}{report-column}
        {report-column:title=Username}{report-info:expanded:member > name}{report-column}
        {report-column:title=Email}{report-info:expanded:member > email|link=true}{report-column}
        

Note the use of 'expanded:item' and 'expanded:member'. 'expanded:item' always referrs to the original item being expanded on, in this case the user group. 'expanded:member' is used because the original {expand-on} macro declared that each of the items in 'user-group:members' would be known as 'member'.

Note also that you can specify sort order inside the {expanded-reporter} macro. You can also add any filters you wish to, and they will only apply to the items being expanded on.

  • default/key - (required) The key value to expand on.
  • as - (required) The name to set each expanded item as when accessing it in the report. May not be 'item', as this is reserved for the original item being expanded.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
  • allowEmpty - (optional) Defaults to false. If set to true, the parent item will still be returned even if the specified key value is empty.
{combining-reporter}
{xxx-reporter}
{yyy-reporter}
{zzz-reporter}

{xxx-sort:item:key|order=[ascending, descending]}
{xxx-filter:item:key|extra parameters go here}
{combining-reporter}

This macro combines two or more reports into a single set of results for output. The results of the reporter do not have to be of the same type, although sorting and filtering will probably not work as expected if they are not.

The reporter can contain filter and sort macros. Filters will be applied on each item from each report as it is retrieved from the sub-report. Sorting will be done on the complete set of results after being filtered and combined.

By default, no uniqueness checking is done, but you can specify it with the 'unique' parameter. There will be a performance penalty for turning this option on, however. If the set of results is unsorted, only the first instance of a value will be returned - duplicates are ignored.

  • unique - (optional) If true, the set of results will only contain a single instance of each item.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria.
{boolean-filter:prefix:key|value=true/false|required=true/false}

This filter will ensure that the specified 'prefix:key' value matches the required true/false value. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • value - (optional) If specified, the value of the key value must match the one specified.
  • required - (optional) If set to 'true', the key value must have a value of some sort, either true or false.
{date-filter:prefix:key|minValue=[date]|maxValue=[date]|format=[date format]|required=true/false}

This filter will ensure that the specified 'prefix:key' value is a date, and that it matches the required criteria. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • minValue - (optional) If specified, the date must be greater than or equal to the specified date. This may also be a period from today's date, such as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'. E.g. '-2y 6m' is 2 years, 6 months in the past.
  • maxValue - (optional) If specified, the date must be less than or equal to the specified date value. This may also be a period from today's date, such as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'.
  • format - (optional) If either minValue or maxValue are a specific date, this parameter must also be specified to inform the filter of the date format used in those parameters. It is not required for relative dates.
  • required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty.
{number-filter:prefix:key|minValue=[number]|maxValue=[number]|decimal=true/false|required=true/false}

This filter will ensure that the specified 'prefix:key' value is a number, and that it matches the required criteria. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • minValue - (optional) If specified, the number must be greater than or equal to the specified value.
  • maxValue - (optional) If specified, the number must be less than or equal to the specified value.
  • decimal - (optional) If specified, setting it to 'true' will require that the number is a decimal type, and setting it to false will require it is a whole number.
  • required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty.
{text-filter:prefix:key|minLength=[#]|maxLength=[#]|include=[regexp]|exclude=[regexp]|required=true/false}

This filter will ensure that the specified 'prefix:key' value matches the required true/false value. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • minLength - (optional) If specified, value must have at least this many characters.
  • maxLength - (optional) If specified, the value must have at most this many characters.
  • include - (optional) If specified, this is a regular expression specifying the pattern required to be included.
  • exclude - (optional) If specified, this is a regular expression specifying the pattern required to be excluded.
  • required - (optional) If set to 'true', the key value must have a value of some sort, either true or false.
{content-filter:prefix:key|space=[space keys]|types=[types]|scope=[page scopes]|labels=[labels]}

This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following:
    • @self - (default) The space the current content is in.
    • @personal - Personal spaces only.
    • @global - Global spaces, that is, non-personal spaces.
    • @all - All spaces, both global and personal
    • SPACE KEY - Any other space key may be specified explicitly.
  • type(s) - (optional) The list of content types to allow. Defaults to allowing all types. Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following:
    • page
    • news
    • comment
    • attachment
    • spacedescription
  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • matchAll - (optional) If set to 'false', content matching any of the criteria will be let through.
{user-filter:prefix:key|user=[user list]|group=[group list]|space=[space permission list]}

This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value. It must be used in a reporter macro.

  • default/key - (required) The key value to filter on.
  • user(s) - (optional) The list of users to match. May be '@self' to indicate the currently-logged-in user.
  • group(s) - (optional) This list of user groups to match.
  • space(s) - (optional) The list of space keys, followed by an optional permission type, to match against. The form is 'SPACEKEY:permission' (e.g. 'MYSPACE:edit'). The available permissions to check against are:
    • view - (default) The user can view the space.
    • edit - The user can edit the pages in the space.
    • news - The user can add news items to the space.
    • comment - The user can add comments to the space.
    • admin
    • - The user can administer the space.
  • matchAll - (optional) Defaults to 'true'. If set to 'false', content matching any of the criteria will be let through.
{collection-filter:prefix:key|matchItems=all/any/none|matchFilters=all/any/none} {xxx-filter:prefix:key} {yyy-filter:prefix:key} {collection-filter}

This filter will check that any contained filter values exist on all/any/none of the items in the collection specified by the filter's "prefix:key" value.

Tip: You can use 'collection-filter-1' to 'collection-filter-5' if you need to nest collection filters.

  • default/key - (required) The key value to filter on.
  • matchItems - (optional) Define how many of the collection's items can match the sub-filers. Defaults to 'all'. May be one of the following:
    • all - (default) All items must match the sub-filter set.
    • any - At least one item must match the sub-filter set.
    • none - None of the items may match the sub-filter set.
  • matchFilters - (optional) Define how many of the sub-filters must match for the item to be let through. May be one of the following:
    • all - (default) All sub-filters must match the item.
    • any - At least one sub-filter must match the item.
    • none - None of the sub-filters may match item.
{repeat-filter:prefix:key|match=[first/repeats]}

This filter checks if the current value is different from the previous one passed to the filter. If so, it passes, otherwise it will fail.

  • default/key - (required) The key value to filter on.
  • match - (optional) Either 'first' (the default) to match only the first item or 'repeats' to match only the repetitions, not the original value.
{and-filter} {xxx-filter:prefix:key} {yyy-filter:prefix:key} {and-filter}

This filter will checks that all the contained filters evaluate to 'true'. If so, it also returns 'true'.

{or-filter} {xxx-filter:prefix:key} {yyy-filter:prefix:key} {or-filter}

This filter will checks that any of the contained filters evaluate to 'true'. If so, it also returns 'true'.

{boolean-sort:prefix:key|order=ascending/descending}

This will sort the results by the specified boolean key value. By default, empty values will be listed before false, which will be before true, using ascending order.

  • order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{date-sort:prefix:key|order=ascending/descending}

This will sort the results by the specified date key value. By default, empty values will be listed first, then the rest using ascending order.

  • order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{number-sort:prefix:key|order=ascending/descending}

This will sort the results by the specified number key value. By default, empty values will be listed first, then the rest using ascending order.

  • order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{text-sort:prefix:key|mode=natural/locale/bitwise|locale=@user/@global/@server/other|order=ascending/descending}

This will sort the results by the specified text key value. By default, empty values will be listed first, then the rest using ascending order.

  • mode - (optional) May be one of the following:
    • natural - (default) The text is sorted in natural order, taking into account symbols, numbers and capitalisation. Will recognise the 'local' parameter
    • locale - The text is sorted in local-specific character order.
    • bitwise - The text is sorted according to the bit value of each character.
  • order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
  • locale - (optional) The locale to use when sorting text in either 'natural' or 'locale' mode. Defaults to '@user'. May be one of the following:
    • @user - (default) The current user's selected locale. Uses @global if no specific locale is selected by the user.
    • @global - The global default locale for Confluence.
    • @server - The server's default locale (may be different to @global)
    • xx_yy - A standard local value, such as "en_AU" or "de".
{natural-sort:prefix:key|order=ascending/descending}

This will sort the results by the specified key value.

  • order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{zone-template}
... Define zones here
{zone-template}

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

More Information

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

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

Parameters

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

{zone:product-version|render=false}
{zone:installation-guide}

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

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

Parameters

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

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

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

Parameters

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


{html:script=#example.html}
{html}

{html:script=^example.html}
{html}

{html:output=wiki|noPanel=true}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam fermentum vestibulum est. Cras rhoncus.
{html}

{html2:script=#http://localhost/example.html}
{html2}

Includes HTML data into a Confluence page. HTML and BODY tags are removed when output=html so the display of the Confluence page is not disrupted. The html2 macro is the same as the html macro.

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

  • output - Determines how the output is formated:
    • html - Data is output as HTML (default).
    • wiki - Data is surrounded by a {noformat} macro.
  • noPanel - When output=wiki, show the data within a panel (default) unless nopanel=true.
  • script - Location of HTML 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.
    • #http://... - Data is read from the URL 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.
  • encoding - File encoding for an external file if different from the system default handling. Example: *UTF-8*.
  • tidy - Default is false. Process the html with jTidy to ensure HTML is well formed. Malformed HTML can cause display problems on your Confluence page.
  • clean - Default is true. Some HTML tags (like body and html) are removed to help with formatting in Confluence. Set to false to surround the complete html with an iframe.
  • width - Default is 500. Sets the width for the iframe (when clean=true).
  • height - Default is 500. Sets the height for the iframe (when clean=true).
{xslt:style=^cdcatalog.xsl} <catalog> <cd> <title>Empire Burlesque</title> <artist>Bob Dylan</artist> <country>USA</country> </cd> <cd> <title>Maggie May</title> <artist>Rod Stewart</artist> <country>UK</country> </cd> </catalog> {xslt}

{xslt:source=^cdcatalog.xml|style=#http://www.w3schools.com/xsl/cdcatalog.xsl}
{xslt}

Transforms XML to a Confluence page via an XSLT style sheet. Note that macro parameters not recognized by the xslt macro are automatically passed through to the xslt engine.

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

  • output - Determines how the output is formated:
    • html - Data is output as a HTML (default).
    • wiki - Data is output as Confluence wiki text. Use this option if you want the data to be formated by the Confluence wiki renderer.
  • source - Location of source XML code. Default is the macro body.
    • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • #http://... - Data is read from the URL specified.
    • global page template name - Data is read from a global page template.
    • space:page template name - Data is read from a space template.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
  • style - Location of source XSL code. Required if source XML is in the macro body, otherwise defaults to the macro body.
    • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • #http://... - Data is read from the URL specified.
    • global page template name - Data is read from a global page template.
    • space:page template name - Data is read from a space template.
    • ^attachment - Data is read from an attachment to the current page.
    • page^attachment - Data is read from an attachment to the page name provided.
    • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
{show-to:user=bob|group=a-group,another-group|space=MYSPACE:edit}
This text is only visible to bob, users in a-group or another-group, and users who can edit the MYSPACE Space. {show-to}

Shows the content to users who meet any of the specified requirements.

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 user "foo" and not "bar" can view the content, do this:

user=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:

user="foo-bar"
  • user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:
    • @self - the user current user.
    • @anonymous - no user is logged in.
    • @authenticated - any user is authenticated.
  • group - (optional) the (list of) groups who can see the conent.
  • space:perm - (optional) the (list of) spaces where, if the user can view the space, they can see the content. The user's permission type to that space may be added also.
    • view - (default) the user can view the space.
    • edit - the user can edit pages.
    • admin - the user has administration access.
    • news - the user can post a news entry.
  • trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).
  • match - (optional) specify the match type.
    • any - (default) the content is displayed if the user matches any of the criteria.
    • all - the content is displayed if the user matches *all* the criteria.
  • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
{hide-from:user=bob|group=a-group,another-group|space=MYSPACE:edit}
This text is only hidden from bob, users in a-group or another-group, and users who can edit the MYSPACE Space.
{hide-from}

Shows the content to users who do not meet any of the specified requirements.

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 user "foo" and not "bar" can view the content, do this:

user=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:

user="foo-bar"
  • user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:
    • @self - the user current user.
    • @anonymous - no user is logged in.
    • @authenticated - any user is authenticated.
  • group - (optional) the (list of) groups who cannot see the conent.
  • space:perm - (optional) the (list of) spaces where, if the user can view the space, they cannot see the content. The user's permission type to that space may be added also.
    • view - (default) the user has permission to view the space.
    • edit - the user has permission to edit pages.
    • admin - the user has administration access.
    • news - the user has permission post a news entry.
  • trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).
  • match - (optional) specify the match type.
    • any - (default) the content is hidden if the user matches any of the criteria.
    • all - the content is hiddent if the user matches *all* the criteria.
  • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
{show-if:type=news|display=printable|space=MYSPACE|action=edit}
This text is show if the page is a news item, is in printing mode, is in MYSPACE, or is being edited.
{show-if}

Shows its content if the context meets any of the specified requirements.

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"
  • type(s) - (optional) the (list of) page types. May be:
    • page
    • news
    • comment
    • spacedescription
  • display(s) - (optional) the (list of) display modes. May be:
    • default - The standard display mode.
    • printable - Printer, PDF or Word mode.
    • pdf - PDF export mode.
    • word - Word export mode.
    • preview - Edit preview mode.
  • space(s) - (optional) the (list of) spaces.
  • action(s) - (optional) the action taking place.
    • view - The content is editable and is currently being viewed.
    • edit - The content is editable and is currently being edited.
    • template - The content is a template being previewed.
    • dashboard
    • - The content is the dashboard.
  • header(s) - (optional) the list of HTTP headers from the browser to check. Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g: "header=referrer:/index.html" will match a referrer of exactly "/index.html". "header=referrer::.*/index.html" will match a referrer which ends with "/index.html". Multiple headers can be checked by separating with "," and optionally adding "+" for required or "-" for excluded.
  • label(s) - (optional) the list of labels to check the page has. E.g: "labels=one, two" or "labels=+one, -two"
  • match - If set to 'all', then all items listed must match. Defaults to 'any'.
  • trim - If set to 'false', the content will not be trimmed before being output (if appropriate).
  • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
{hide-if:type=news|display=printable|space=MYSPACE|action=edit}
This text is hidden if the page is a news item, is in printing mode, is in MYSPACE, or is being edited.
{hide-if}

Shows its content if the context does not meet any of the specified requirements.

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"
  • type(s) - (optional) the (list of) page types. May be:
    • page
    • news
    • comment
    • spacedescription
  • display(s) - (optional) the (list of) display modes. May be:
    • default - The standard display mode.
    • printable - Printer, PDF or Word mode.
    • pdf - PDF export mode.
    • word - Word export mode.
    • preview - Edit preview mode.
  • space(s) - (optional) the (list of) spaces.
  • action(s) - (optional) the action taking place.
    • view - The content is editable and is currently being viewed.
    • edit - The content is editable and is currently being edited.
    • template - The content is a template being previewed.
    • dashboard
    • - The content is the dashboard.
  • header(s) - (optional) the list of HTTP headers from the browser to check. Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g: "header=referrer:/index.html" will match a referrer of exactly "/index.html". "header=referrer::.*/index.html" will match a referrer which ends with "/index.html". Multiple headers can be checked by separating with "," and optionally adding "+" for required or "-" for excluded.
  • label(s) - (optional) the list of labels to check the page has. E.g: "labels=one, two" or "labels=+one, -two"
  • header - (optional) The (list of) headers.
  • match - If set to 'all', then all items listed must match. Defaults to 'any'.
  • trim - If set to 'false', the content will not be trimmed before being output (if appropriate).
  • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
{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}
{newcode}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code. The language defaults to Java.
Default highlighted code

{newcode:vbnet}
Public Module Test
  Public Sub Main()
    Console.WriteLine("Hello World!");
  End Sub
End Module
{newcode}
{newcode:language=vbnet}
Public Module Test
  Public Sub Main()
    Console.WriteLine("Hello World!");
  End Sub
End Module
{newcode}

Specify the language using the default parameter of the "lang" parameter.
VisualBasic.Net highlighted code

{newcode:title=Test title}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, including a title.
Highlighted code, including title

{newcode:collapse=true}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a collapsed version of syntax highlighted version of the code.
Highlighted code, collapsed

{newcode:linenumbers=false}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without line numbers.
Highlighted code, excluding line numbers

{newcode:firstline=10}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without an alternative number as the first line.
Highlighted code, alternative firstline

{newcode:ruler=true}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, with a ruler to indicate the columns.
Highlighted code, including ruler

{newcode:theme=django}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without an alternative theme.
Highlighted code, including ruler

{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.
{macro-list}

Prints a list of all enabled macros in this installation.

This is useful where you wish to let your users see exactly which macros are available for them to use.

{shortcut-list}

Prints a list of all configured shortcuts in this installation.

This is useful where you wish to let your users see exactly which shortcuts are available for them to use.

{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!

{cache}
Something to cache for a day
{cache}

{cache:refresh=30m}
This will be cached for 30 minutes
{cache}

{cache:refresh=2 hours}
The excel data will be cached for 2 hours
{excel:file=^Report.xls}
{cache}

{cache:cron=30 * * * *|showRefresh=true|showDate=true|title=Refresh data from database}
This will be cached until 30 minutes past each hour of the day
{sql-query:dataSource=ReportDS}
select * from report
{sql}
{cache}

{cache:index=true}
The results from the SQL query will be indexed for search.
{sql-query:dataSource=ReportDS}
select * from report
{sql}
{cache}

Caches the rendered contents of the body of this macro. Very useful when using macros that might be slow to render content, but where it does not really need to be dynamically generated for each and every request. Specifically, this can improve performance for accessing dynamic data from sql, excel, and similar macros. Cache will be refreshed if the body of the macro changes or if attachments to this page have been added, removed, or have newer versions. The cache applies to all users that view this page.

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

Optional Parameters

  • refresh - Cache refresh period. Default is a day. A number will be treated as seconds. A number followed by one of the following characters will be treated as follows:
    • s - seconds.
    • m - minutes.
    • h - hours.
    • d - days.
    Any data after a s, m, h, or d is ignored. For example, 10days is the same as 10d or 10 days.
  • cron - Cron-like expression for finer grained expiration. See Cron Expressions.
  • showRefresh - Show a refresh icon if showRefresh=true. Default is false. When the refresh icon is clicked, the cache for this macro will be discarded forcing the data to be regenerated.
  • showDate - Show the date and time the data was generated if showDate=true. Default is false. The date field follows the refresh icon and before the data.
  • checkAttachments - Default is true. If true, the cache will be refreshed if there is any change to the attachments on this page. This includes adding, removing, or changing the version of any attachment. For instance, if you are caching the rendering of an excel spreadsheet, then the data will be refresh if the attached spreadsheet is updated.
  • title - Title to show when mouse is over the refresh icon. Default is "Refresh".
  • index - If index=true, the cached content will be added to the Confluence search index. Default is "false". Whenever the cached data is updated, the page will be re-indexed.

Based on OSCache.

{text-extractor}
|| Heading1 || Heading2 ||
| text11 | text12 |
| text21 | text22 |
{text-extractor}

{text-extractor}
{html:script=#http://www.atlassian.com/about/}
{html}
{text-extractor}

This macro extracts text from HTML and returns it as simple text.

Optional Parameters

  • attributes - Default is a true which means to include HTML attributes in the output text. Attributes include values of title, alt, label, summary, and content attributes of normal tags.
  • compress - Default is a false. Set to true to remove duplicate words from the output.

Based on the Jericho HTML Parser.

sp

Allows you to define a link that creates a new page based on a name given by the user at runtime

  • parent - the name of parent to the new page. May be one of the following:
    • @self - the current page (default)
    • @parent - the parentto the current page
    • pagename - any predefined page
  • space - the space that the parent page exists within (defaults to current page's space)
  • fallback - the spacekey AND page to fallback to (specified as SPACEKEY:pagename)
  • boilerplate - the boilerplate to inject into the new page
  • template - the template to be copied into the new page
  • prefix - a prefix to be applied to the page title given by the user
  • postfix - the suffix to be applied to the name given by the user
  • target - If set to 'edit', once the page is created the user will be prompted to enter any template variables, and then taken to the edit screen rather than the 'view' screen.
  • title - A static title to be used (cannot be used with prefix, postfix, or prompt). This title can contain the following parameters - %parenttitle%, which will insert the title of the parent page, and %ident%, which will insert the lowest number needed to make the page title unique. This allows you to create numbered child pages without user prompting.
  • addspace - whether to insert spaces between the suffix & postfix and the name given by the user or not (default = true)
  • prompt - The text to use when asking the user for the new page title(default = Please enter the new page name)
  • title - a name for the new page (disables prompting)
  • target - whether to go to edit or view mode
  • addImg - display the + sign next to the link (default = true)

See Also: User Guide and Examples

{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

{clickable:tooltip|link}content{clickable}

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

See Also: User Guide and Examples

{lozenge:title=Adaptavist.com|link=http://adaptavist.com|color=red}Click to visit...{lozenge}

Inserts a graphical lozenge panel, ideal for creating buttons, etc.

Parameters:

  • link - if you want to link to a page, insert the page title or url
  • icon - if you want to display an icon (48x48 pixels or smaller) in the left panel, use wiki notaiton for an image. Alternatively, specify normal text to display text in the left panel.
  • color - the color of the left panel: bronze, silver (default), gold, blue, cyan, green, purple, pink, red
  • arrow - display or hide the arrow in the left panel: none (default if no link), blue (default if link specified), green
  • title - the title of the lozenge, also used as the tooltip for links
  • width - the width of the entire lozenge specified as pixels (347px default), percentage (eg. 70%) or auto to stretch to fit contents.

See Also: User Guide and Examples

{tm:class=myclass}Builder Theme{tm}

Inserts a trade mark: Builder HostingTM

See Also: User Guide and Examples

{sm:class=myclass}Builder Hosting{sm}

Inserts a service mark: Builder HostingSM

See Also: User Guide and Examples

{reg-tm:class=myclass}Adaptavist{reg-tm}

Inserts a registered trade mark: Adaptavist

See Also: User Guide and Examples

{copyright:class=myclass}2005 [Adaptavist.com Ltd|http://adaptavist.com].{copyright}

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

See Also: User Guide and Examples

{style:media=x,y,z|import=url}
style sheet
{style}

Insert a style sheet in to your content.

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

See Also: User Guide and Examples

{span:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{span}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{bgcolor:red|class=myclass}content{bgcolor}
{bgcolor:#FF0000}content{bgcolor}

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

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

See Also: User Guide and Examples

{highlight:blue|class=myclass}content{highlight}
{highlight:#0000FF}content{highlight}

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

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

See Also: User Guide and Examples

{center:class=myclass}content{center}

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

See Also: User Guide and Examples

{strike:class=myclass}stikeout{strike}

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

See Also: User Guide and Examples

{privacy-policy:page|class=myclass}statement{privacy-policy}

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

See Also: User Guide and Examples

{privacy-mark:Tooltip}

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

See Also: User Guide and Examples

{search-box}
{search-box:all=true}

Add a search box to your page:

  • default - no parameters - Search the current space
  • default - spacekey - Search a specific space, list of spaces, @all spaces, @personal spaces, @global spaces, @favourite spaces, @current space (default)
  • teams - filter the list of spaces by team labels (only the selected space is searched)
  • group - group results by space/type/@select
  • lastModified - filter list of search results by last modified date (today/yesterday/lastweek/lastmonth/@select)
  • type - only return objects of type (page/blogpost/mail/comment/attachment/userinfo/spacedesc/@select)
  • globalText - The text to use for labeling global searches (Global Spaces)
  • personalText - The text to use for labeling personal searches (Personal Spaces)
  • favouritesText - The text to use for labeling global searches (Favourite Spaces)
  • allText - The text to use for labeling global searches (All Spaces)
  • buttonText - The text to use for the search button (Search)
  • label - adds a label to the search input
  • accesskey - adds an access key to the search button
  • button - Display the search button (true/false)
  • all - Search all spaces - overrides spaces list (true/false)

See Also: User Guide and Examples

{roundrect:title=Some Title}Some content{roundrect}

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

Parameters:

  • title - displays wiki content in the space above the main content area between the upper corners
  • footer - displays wiki content in the space below the main content area between the lower corners
  • bgcolor - the background color of the content area
  • titlebgcolor - the background color of the title area (defaults to bgcolor)
  • footerbgcolor - the background color of the footer area (defaults to bgcolor)
  • width - the width of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
  • height - the minimum height of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
  • cornersize - defines the radius of the rounded corners
  • hSize - overrides cornersize to allow setting of the width of the corners
  • vSize - overrides cornersize to allow setting of the height of the corners
  • corners - a comma separated list of flags stating which corners should be rounded: Top Left, Top Right, Bottom Left, Bottom Right (default is true,true,true,true)
  • rows - a comma separated list of flags stating which rows should be displayed: Top, Middle, Bottom (default is true,true,true)
  • antialias - use Adobe Flash to antialias the corners (default false)
  • class - a list of classes to be applied to the roundrect table

See Also: User Guide and Examples

{align:mode|class=myclass}content{align}

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

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

See Also: User Guide and Examples

{rollover:class=test}{div}content{div}{rollover} {table}{tr}{rollover:class=test}{td}content{td}{rollover}{tr}{table}

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

Parameters:

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

See Also: User Guide and Examples

{HTMLcomment}HTML comment text{HTMLcomment} {HTMLcomment:hidden}HTML comment text{HTMLcomment}

Inserts comments into wiki markup, without arguments the macro produces an HTML comment in the output, when the 'hidden' flag is passed the comment is not output to HTML

See Also: User Guide and Examples

{fancy-bullets:myimage.jpg}
* list
** sublist
{fancy-bullets}

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

Parameters:

  • _default_ - The image to use as the bullet in SPACEKEY:page^attachment format
  • image - Select from a range of bullet types (eg; disc, circle, square, decimal, and more)
  • id - a unique id (must be supplied when using fancy bullets outside of a page)
  • padding - the padding to apply to the list items

See Also: User Guide and Examples

{pre:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{pre}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{iframe}Some content{iframe}

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

Parameters:

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

See Also: User Guide and Examples

{colgroup}Some content{colgroup}

Inserts a table cell.

Parameters:

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

See Also: User Guide and Examples

{table}Some content{table}

Inserts a table.

Parameters:

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

See Also: User Guide and Examples

{table-row}Some content{table-row} {tr}Some content{tr}

Inserts a table row.

Parameters:

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

See Also: User Guide and Examples

{table-cell}Some content{table-cell} {td}Some content{td}

Inserts a table cell.

Parameters:

  • abbr - Specifies an abbreviated version of the content in a cell
  • align - Specifies the horizontal alignment of cell content
  • axis - Defines a name for a cell
  • bgcolor - Specifies the background color of the table cell
  • char - Specifies which character to align text on
  • charoff - Specifies the alignment offset to the first character to align on
  • colspan - Indicates the number of columns this cell should span
  • headers - A space-separated list of cell IDs that supply header information for the cell. This attribute allows text-only browsers to render the header information for a given cell
  • height - Specifies the height of the table cell
  • nowrap - Whether to disable or enable automatic text wrapping in this cell
  • rowspan - Indicates the number of rows this cell should span
  • scope - Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it
  • valign - Specifies the vertical alignment of cell content
  • width - Specifies the width of the table cell
  • id - A unique id for the element
  • class - The class of the element
  • title - Text to display in a tool tip
  • style - An inline style definition
  • dir - Sets the text direction
  • lang - Sets the language code

See Also: User Guide and Examples

{th}Some content{th}

Inserts a table heading cell.

Parameters:

  • abbr - Specifies an abbreviated version of the content in a cell
  • align - Specifies the horizontal alignment of cell content
  • axis - Defines a name for a cell
  • bgcolor - Specifies the background color of the table cell
  • char - Specifies which character to align text on
  • charoff - Specifies the alignment offset to the first character to align on
  • colspan - Indicates the number of columns this cell should span
  • headers - A space-separated list of cell IDs that supply header information for the cell. This attribute allows text-only browsers to render the header information for a given cell
  • height - Specifies the height of the table cell
  • nowrap - Whether to disable or enable automatic text wrapping in this cell
  • rowspan - Indicates the number of rows this cell should span
  • scope - Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it
  • valign - Specifies the vertical alignment of cell content
  • width - Specifies the width of the table cell
  • id - A unique id for the element
  • class - The class of the element
  • title - Text to display in a tool tip
  • style - An inline style definition
  • dir - Sets the text direction
  • lang - Sets the language code

See Also: User Guide and Examples

{tbody}Some content{tbody}

Inserts a table body.

Parameters:

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

See Also: User Guide and Examples

{thead}Some content{thead}

Inserts a table heading.

Parameters:

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

See Also: User Guide and Examples

{ol:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{ol}

Creates an ordered list tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{ul:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{ul}

Creates an unordered list tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{li:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{li}

Creates a list item tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

{img:src=http://domain.com/path/file.ext}

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

Parameters:

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

See Also: User Guide and Examples

{composition-setup:defaults=Home^composition.properties}
cloak.memory.duration = 3 #days
cloak.toggle.type = custom
cloak.toggle.open = ^open.gif
cloak.toggle.close = ^close.gif
{composition-setup}

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

Parameters:

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

Properties:

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

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

  • [default]/side - (required) The side the content will float on (left or right).
  • width - (optional) The width of the floating content (eg. '100px').
  • background - (optional) The background colour or picture settings.
  • border - (optional) The border settings.
  • margin - (optional) The margin settings.
  • padding - (optional) The padding settings.
{cloak:id=Cloaked Content}
This section will be cloaked until it is toggled.
{cloak}

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

  • id - (required) The unique ID of the cloaked section.
  • visible - (optional) If 'true', the section will be visible initially. Defaults to 'false'.
h1. {toggle-cloak:id=Cloaked Content} Cloaked Content

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

  • id - (required) The unique ID of the cloaked section to toggle.
  • exclusive - (optional) If true, all other sections at the same level will be cloaked when this is shown.
Tabbed deck
{deck:id=My Deck}
{card:label=Card 1}
Card 1 contents.
{card}
{card:label=Card 2}
Card 2 contents.
{card}
{deck}

Slideshow
{deck:id=My Deck|effectType=fade|nextAfter=5|loopCards=true|tabLocation=none}
{card:label=Card 1}
!image1.png!
{card}
{card:label=Card 2}
!image2.png!
{card}
{deck}

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

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

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

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

Shows a card in the specified deck.

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

{footnote}text of footnote{footnote}

Creates a footnote to be displayed by the {display-footnotes} macro

See Also: User Guide and Examples

{display-footnotes}

Displays the footnotes defined by ocurrences of the {footnote} macro elsewhere on the page

Parameters:

  • reset - Set to true to reset the count of footnotes

See Also: User Guide and Examples

{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 page's 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

{incoming-links}No links exist{incoming-links}

{incoming-links:style=square|excerpt=true}

{incoming-links:scope=Another Page>children}

{incoming-links:scope=A Different Page>descendents}

{incoming-links:spaces=MYSPACE}

{incoming-links:page=Another Page|types=page,comment}

Creates a list of pages which link to the current page. Wiki content may be included as the body to be shown if no links exist.

Display Options

  • page - The page to search on.
  • mode - The mode in which incoming links are displayed. Available modes:
    • list - Links are displayed in a bullet-pointed list.
    • flat - Links are displayed in a single row, with a separator between each item.
  • separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
    • brackets - Each item is surrounded by square brackets ('[' and ']').
    • braces - Each item is surrounded by curly braces ('{' and '}').
    • parens - Each item is surrounded by parentheses ('(' and ')').
    • pipe - Each item is separated by a pipe ('|').
    • other - The value is the separator.
  • style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
    • icons - displays the Confluence page-type icon (default)
    • none - no bullet point displayed
    • other CSS styles - disc, square, upper-roman, lower-roman, etc
  • excerpt - Will output any excerpts which have been set on the linking page.
  • sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
    • natural title - Sorted by the unicode-safe natural order of the content title. (Default)
    • exact title - Sorted by the exact content title.
    • creation date - Sorted by the creation date of the content.
    • modification date - Sorted by the last-modified date of the content.
    • space key - Sorted by the space key the content is contained in.
    • space name - Sorted by the unicode-safe natural order of the space name.
  • maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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

labels=foo, -bar

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

labels="foo-bar"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • spacedescription - Space description
    • userinfo - User profile
    • attachment - An attachment
    • mail - Mail archive
    • mailto - A 'mailto' link
    • url - An external URL.
    • unresolved - An unresolved link.

{outgoing-links}No links exist{outgoing-links}

{outgoing-links:style=square|excerpt=true}

{outgoing-links:scope=Another Page>children}

{outgoing-links:scope=A Different Page>descendents}

{outgoing-links:spaces=MYSPACE}

{outgoing-links:types=page,comment}

Creates a list of pages, websites and email addresses the current page links to. Wiki content may be included as the body to be shown if no links exist.

Display Options

  • page - The page to search on.
  • mode - The mode in which links are displayed. Available modes:
    • list - Links are displayed in a bullet-pointed list.
    • flat - Links are displayed in a single row, with a separator between each item.
  • separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
    • brackets - Each item is surrounded by square brackets ('[' and ']').
    • braces - Each item is surrounded by curly braces ('{' and '}').
    • parens - Each item is surrounded by parentheses ('(' and ')').
    • pipe - Each item is separated by a pipe ('|').
    • other - The value is the separator.
  • style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
    • icons - displays the Confluence page-type icon (default)
    • none - no bullet point displayed
    • other CSS styles - disc, square, upper-roman, lower-roman, etc
  • excerpt - Will output any excerpts which have been set on the linking page.
  • sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
    • natural title - Sorted by the unicode-safe natural order of the content title. (Default)
    • exact title - Sorted by the exact content title.
    • creation date - Sorted by the creation date of the content.
    • modification date - Sorted by the last-modified date of the content.
    • space key - Sorted by the space key the content is contained in.
    • space name - Sorted by the unicode-safe natural order of the space name.
  • maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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

labels=foo, -bar

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

labels="foo-bar"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • spacedescription - Space description
    • userinfo - User profile
    • attachment - An attachment
    • mail - Mail archive
    • mailto - A 'mailto' link
    • url - An external URL.
    • unresolved - An unresolved link.

{orphaned-links}No links exist{orphaned-links}

{orphaned-links:style=square|excerpt=true}

{orphaned-links:scope=Another Page>children}

{orphaned-links:scope=A Different Page>descendents}

{orphaned-links:spaces=MYSPACE}

{orphaned-links:types=page,comment}

Creates a list of pages which do not have any other pages linking to them. Wiki content may be included as the body to be shown if no links exist.

Display Options

  • page - The page to search on.
  • mode - The mode in which links are displayed. Available modes:
    • list - Links are displayed in a bullet-pointed list.
    • flat - Links are displayed in a single row, with a separator between each item.
  • separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
    • brackets - Each item is surrounded by square brackets ('[' and ']').
    • braces - Each item is surrounded by curly braces ('{' and '}').
    • parens - Each item is surrounded by parentheses ('(' and ')').
    • pipe - Each item is separated by a pipe ('|').
    • other - The value is the separator.
  • style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
    • icons - displays the Confluence page-type icon (default)
    • none - no bullet point displayed
    • other CSS styles - disc, square, upper-roman, lower-roman, etc
  • excerpt - Will output any excerpts which have been set on the linking page.
  • sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
    • natural title - Sorted by the unicode-safe natural order of the content title. (Default)
    • exact title - Sorted by the exact content title.
    • creation date - Sorted by the creation date of the content.
    • modification date - Sorted by the last-modified date of the content.
    • space key - Sorted by the space key the content is contained in.
    • space name - Sorted by the unicode-safe natural order of the space name.
  • maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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

labels=foo, -bar

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

labels="foo-bar"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • spacedescription - Space description
    • userinfo - User profile
    • attachment - An attachment
    • mail - Mail archive
    • mailto - A 'mailto' link
    • url - An external URL.
    • unresolved - An unresolved link.

{undefined-links}No links exist{undefined-links}

{undefined-links:style=square|excerpt=true}

{undefined-links:scope=Another Page>children}

{undefined-links:scope=A Different Page>descenents}

{undefined-links:spaces=MYSPACE}

{undefined-links:types=page,comment}

Creates a list of pages which are linked to but have not yet been created. Wiki content may be included as the body to be shown if no links exist.

Display Options

  • page - The page to search on.
  • mode - The mode in which links are displayed. Available modes:
    • list - Links are displayed in a bullet-pointed list.
    • flat - Links are displayed in a single row, with a separator between each item.
  • separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
    • brackets - Each item is surrounded by square brackets ('[' and ']').
    • braces - Each item is surrounded by curly braces ('{' and '}').
    • parens - Each item is surrounded by parentheses ('(' and ')').
    • pipe - Each item is separated by a pipe ('|').
    • other - The value is the separator.
  • style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
    • icons - displays the Confluence page-type icon (default)
    • none - no bullet point displayed
    • other CSS styles - disc, square, upper-roman, lower-roman, etc
  • excerpt - Will output any excerpts which have been set on the linking page.
  • sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
    • natural title - Sorted by the unicode-safe natural order of the content title. (Default)
    • exact title - Sorted by the exact content title.
    • creation date - Sorted by the creation date of the content.
    • modification date - Sorted by the last-modified date of the content.
    • space key - Sorted by the space key the content is contained in.
    • space name - Sorted by the unicode-safe natural order of the space name.
  • maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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

labels=foo, -bar

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

labels="foo-bar"

This will work for all filter properties below.

  • scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
    • >children - The direct children of the specified page. Eg. 'scope=My Page>children'
    • >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
    • >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
  • labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
  • spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
    • @all - All spaces, both personal and global
    • @personal - All personal spaces
    • @global - All non-personal spaces
    • @favourites - All the current user's favourite spaces
  • types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
    • page - Wiki pages
    • news - Blog/News posts
    • comment - Page or blog comments
    • spacedescription - Space description
    • userinfo - User profile
    • attachment - An attachment
    • mail - Mail archive
    • mailto - A 'mailto' link
    • url - An external URL.
    • unresolved - An unresolved link.
{scrollbar}

Generates a set of scroll bar links within the same page hierarchy, one previous and one next (if they exist).

  • up - (optional) if 'false', no link to the parent page will be created (default is true).
  • icons - (optional) if 'false', no icons will be generated (default is true).
  • class - (optional) set the CSS class the scrollbar table will be set to.

{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

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

{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
{add-label:label1,label2,label3}

Ensures that the current page is labelled with the ones listed

See Also: User Guide and Examples

{choose-label:labels=orange,red,blue|title=Please Choose...|descriptions=An Orange,A Deep Red,An Ocean Blue}

If none of the labels listed are already defined, presents the user with a choice of labels

Parameters:

  • labels A comma separated list of labels. These will be added when clicked on
  • title A title to show above the list of labels
  • descriptions An optional description for each label that is more human readable. This list must be the same length as the labels list.

See Also: User Guide and Examples

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)