Biggest heading

Bigger heading

Big Heading

Normal Heading

Small Heading

Smallest Heading

Example:

Some block quoted text

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

here is quotable
content to be quoted

Example: look ma, red text!

Example: pagetitle

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

Example: anewpage

Example: link alias

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

Example:

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

Examples:

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

Examples:

• Re: Webwork 2 Upgrade
• my link name

Examples:

• spacekey
• custom link title
• [nosuchspace:]

Examples:

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

Examples:

• confluence@Google
• custom link text

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

Examples:

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

Example: legendaryservice@atlassian.com

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

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

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

Example:

• some
• bullet
• indented
• bullets
• points

Example:

• different
• bullet
• types

Example:

1. a
2. numbered
3. list

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

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

Example:

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

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

The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed. Despite the fact that this plugin has an ajax UI, it is still fully versioned like a normal Confluence page.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The code given here produces a table that looks like:

Defines a single column.

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

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

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

CSV Macro

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

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

Table Plus Macro

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

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

Common table capabilities

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

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

Parameters - the following parameters control these common table capabilities:

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

Example:

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

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

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

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

    Standard charts

    • pie (default)
    • bar
    • line
    • area

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

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

    Other charts

    • gantt - beta - See Gantt Charts.
    
    
  • orientation - A bar, line, or area chart will be displayed vertically (y axis is vertical) unless 'orientation=horizontal' is specified.
  • 3D - A pie, bar, or line chart will be shown in 3D if 3D=true is specified.
  • stacked - A bar or area chart will be shown with stacked values if stacked=true is specified.
  • showShapes - Shapes will be shown at each data point in a line chart unless showShapes=false.
  • opacity - A percent value between 0 (not visible) and 100 (non-transparent) that determines how opaque the foreground areas and bars display. Defaults are:
    • 75 percent for 3D charts
    • 50 percent for non-stacked area charts
    • 100 percent for all other charts
• Display control parameters
  • width - The width of the chart in pixels (default is '300')
  • height - The height of the chart in pixels (default is '300')
  • dataDisplay - Default is false to not display the rendered body of the macro (usually the data tables). When dataDisplay=true or dataDisplay=after, the data will be displayed after the chart. When dataDisplay=before, the data will be displayed before the chart.
  • imageFormat - Default is png. Format of generated image. Valid formats are png and jpg. Other formats may be also be valid if installed on your server.
• Title and label customization parameters
  • title - The title of the chart.
  • subTitle - A subtitle for the chart using a smaller font.
  • xLabel - The label to use for the x (domain) axis
  • yLabel - The label to use for the y (range) axis
  • legend - A legend will be displayed unless legend=false is specified.
• Data specification parameters - The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined to Confluence will be tried. Additional conversion options can be specified using the parameters below.
  • tables - Comma separated list of table ids and/or table numbers contained within the body of the macro that will be used as the data for the chart. Defaults to all first level tables. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros).
  • columns - Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Defaults to all columns. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row.
  • dataOrientation - The data tables will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
  • timeSeries - If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats.
  • dateFormat - For time series data, the date format allows for additional customization of the conversion of data to date values. By default, the Confluence language defined date formats will be used. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the format of the time series data. See Date Format.
  • timePeriod - Specify the time period for time series data. Default is 'Day'. This defines the granularity of how the data is interpreted. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.
  • language - If provided, the language and country specification will be used to create additional number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
  • country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
  • forgive - Default is true to try to convert numeric and date values that do not totally match any of the default or user specified formats. Specify forgive=false to enforce strict data format. Data format errors will cause the chart to not be produced.
• Color customization parameters - See Colors for how to specify colors.
  • bgColor - Color (default is 'white') to use as the background of the chart.
  • borderColor - Color of a border around the chart. Default is to not show a border.
  • colors - Comma separated list of colors used to customize category, sections, and series colors.
• Axis customization parameters - Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these paramters.
  • rangeAxisLowerBound - range axis lower bound
  • rangeAxisUpperBound - range axis upper bound
  • rangeAxisTickUnit - range axis units between axis tick marks
  • rangeAxisLabelAngle - angle for the range axis label in degrees
  • domainAxisLowerBound - domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (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

Date Format

Copied from Java SimpleDateFormat specification.

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "'" represents a single quote. All other characters are not interpreted; theyre simply copied into the output string during formatting or matched against the input string during parsing.

The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless its needed to separate two adjacent fields.
• Year: For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.

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

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

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

       GMTOffsetTimeZone:
               GMT Sign Hours : Minutes
  
       Sign: one of
               + -
       Hours:
               Digit
               Digit Digit
  
       Minutes:
               Digit Digit
       Digit: one of
               0 1 2 3 4 5 6 7 8 9

  Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.

  For parsing, RFC 822 time zones are also accepted.

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

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit

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

  For parsing, general time zones are also accepted.

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.

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.
• 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.
• noPanel - When output=wiki, show the data within a panel (default) unless nopanel=true.

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

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

• output - Determines how the output is formated:
  • html - Data is output as a HTML (default).
  • wiki - Data is output as Confluence wiki text. Use this option if you want the data to be formated by the Confluence wiki renderer.
• source - Location of source XML code. Default is the macro body.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • #http://... - Data is read from the URL specified.
  • global page template name - Data is read from a global page template.
  • space:page template name - Data is read from a space template.
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
• style - Location of source XSL code. Required if source XML is in the macro body, otherwise defaults to the macro body.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • #http://... - Data is read from the URL specified.
  • global page template name - Data is read from a global page template.
  • space:page template name - Data is read from a space template.
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

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.

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

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

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

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

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

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

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

• id - List of comma separated calendar IDs to embed.
• defaultView - (Optional) The default view of the calendar. Valid values are month, week and list. The default is month.
• width - (Optional) If no width is specified, the calendar will be inserted at full width.

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

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

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

Prints a simple note to the user.

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

Be Careful The body of the note here..

Prints a warning note to the user.

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

Warning Insert warning message here!

Prints an informational note.

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

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

Prints a helpful tip for the user.

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

Handy Hint Join the Confluence Mailing-List!

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.

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.

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

pre-formatted piece of text
so *no* further _formatting_ is done here

• title: Title of the panel
• borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
• borderColor: The color of the border this panel uses
• borderWidth: The width of the border this panel uses
• bgColor: The background color of this panel
• titleBGColor: The background color of the title section of this panel

Example:

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

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

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.

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

Simply place the {viewtracker} macro on a Confluence page or blog post and your counter is ready to go.

Displays pages you have recently visited throughout all your accessible spaces within a Confluence installation.

• maxResults: (optional) The maximum number of results to display. (default = 20)
• hideHeader: (optional) true/false flag that allows you to hide the header of the table. (default = false)

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

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

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

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

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

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

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

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

Show search results keystroke by keystroke.

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

Creates a table of contributor information from the current page or a group of pages.

Table Options

• groupby - (optional) Specify if the table should be grouped by contributors or pages. Default value is contributors
• columns - (optional) Specify the columns that should appear in the table as a comma separated list. Default value is edits,comments,labels. Valid values:
  • edits Edit Count Column
  • edited List of pages or contributors
  • comments Comment Count Column
  • commented List of pages or contributors
  • labels Label Count Column
  • labeled List of pages or contributors
  • labellist List of labels
  • watches Watch Count Column
  • watching List of pages or contributors
  • lastupdate Last time a page was updated or a contributor changed some content.
• order - (optional) The order the contributors or pages will appear in. By default the table is ordered by the number of edits.
  • edits Orders the list with the highest number of edits first in the list
  • name Orders the list by name alphabetically
  • editTime Orders the list by the time they last edit time
  • update Order by the last update time of any content
• reverse - (optional) If true the sort order will be reversed.
• limit - (optional) Limit the number of contributors displayed to this amount
• showAnonymous - (optional) Show updates by anonymous users. Default is false.
• showZeroCounts - (optional) If all the selected columns are zero, or empty should the contributor or page be displayed in the table. Default is false.

Page Searching Options The following parameters control what pages are used to build the contributors list.

• page The page to count statistics from. If no spaces or labels are specified this will default to the current page.
• labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)
• spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The following shortcut space names can also be used:
  • @all All Spaces
  • @global All Global Spaces
  • @personal All Personal Spaces
• contentType Valid options are:
  • pages
  • blogposts
  If not specified blog posts and pages are included.
• publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
• scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
  • children include statistics from the immediate children of the page
  • descendants include statistics from all descendants of the page

Creates a list of contributors who have contributed to a page or a list of pages.

Display Options

• include - (optional) What type of content from the pages to base the contributor list (and the counts) on. Multiple values can be specified with a comma separated list
  • authors Include page authors (default).
  • comments Include page comments
  • labels Include page labels
  • watches Include page watches
• order - (optional) The order the contributors will appear in.
  • count Order by the total count (default)
  • name Order by the names of the contributors
  • update Order by the last update time
  Both the count and update orderings will use values from only the content specified with the include parameter.
• reverse - (optional) If true the sort order will be reversed.
• limit - (optional) Limit the number of contributors initially displayed to this amount
• mode - (optional) Sets the display mode of the macro
• inline The contributors will be displayed across the screen (default)
• list The contributors will be displayed in a list down the screen
• showAnonymous - (optional) Show edits by anonymous users. Default is false.
• showCount - (optional) Show the count for each user. Default is false.
• showLastTime - (optional) Show the last time a contribution was made by each user for any content specified by the include parameter. Default is false.

Page Searching Options The following parameters control what pages are used to build the contributors list.

• page The page to count statistics from. If no spaces or labels are specified this will default to the current page.
• labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)
• spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The followingshortcut space names can also be used:
  • @all All Spaces
  • @global All Global Spaces
  • @personal All Personal Spaces
• contentType Valid options are:
  • pages
  • blogposts
  If not specified blog posts and pages are included.
• publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
• scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
  • children include statistics from the immediate children of the page
  • descendants include statistics from all descendants of the page

Advanced Options

• showPages - show a list of pages returned above the list. Useful for debugging.
• noneFoundMessage - override the default message that is displayed when no contributors are found.

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

• Microsoft Word Documents
- Embedded as html
• Microsoft Excel Spreadsheets
- Embedded as html
• Microsoft Powerpoint Presentations
- Embedded in a flash slideshow control or as a single image for individual pages
• Adobe PDF files
- Embedded in a flash slideshow control or as a single image for individual pages

• space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
• page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
• date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
• name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}

• grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
• sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
• row - (optional)the last row in the worksheet to render. The default is the last row with content.
• col - (optional)the last column in the worksheet to render. The default the last column with content.

• slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
• height - (optional)overrides the default height of the flash control or image.
• width - (optional)overrides the default width of the flash control or image.

{english}This text is only shown
if the user has set english as his
preferred language.{english}

{german}Dieser Text wird nur
angezeigt, wenn der User als Sprache
Deutsch gewaehlt hat.{german}

{french}Ce texte est seulement
montre quand on a choisi la langue
"francais".{french}

{chinese}...{chinese}
{czech}...{czech}
{danish}...{danish}
{finnish}...{finnish}
{greek}...{greek}
{hungarian}...{hungarian}
{italian}...{italian}
{japanese}...{japanese}
{korean}...{korean}
{norwegian}...{norwegian}
{polish}...{polish}
{portuguese}...{portuguese}
{russian}...{russian}
{spanish}...{spanish}
{swedish}...{swedish}
{turkish}...{turkish}

{pagetitle:This is the new pagetitle!}

Overrides the real page title. The real title can still be seen in the bread-crumbs.

The page title can be set according to the users preferred language, set in the "General User Preferences", in conjunction with the {german}, {english} or {french} macro.

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.

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

Example:

Found 2 result(s) for home

Home (My Space) This is the home page for My Space.

file-containing-home.pdf ( download)

Displays the most recent 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.

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

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

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

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

Displays a list of content marked with the specified labels.

• type - (optional) search for types of content.
  Accepted values:
  • page: basic pages
  • comment: comments on pages or blogs
  • blogpost/news: blog posts
  • attachment: attachments to pages or blogs
  • userinfo: personal information
  • spacedesc: space descriptions
  • personalspacedesc: personal space descriptions
  • mail: emails in a space
  
  Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
• showLabels - (optional) display the labels for each results (enabled by default)
• showSpace - (optional) display space name for each result (enabled by default)
• title - (optional) add a title above the results list
• max/maxResults - (optional) the maximum number of results to display (default is 5)
• excerpt - (optional) display first line of excerpt for each result
• space/spaces - (optional) spaces to search.
  Accepted values:
  • space keys (case-sensitive)
  • @self: current space
  • @personal: personal spaces
  • @global: global spaces
  • @favorite/@favourite: user's favourite spaces
  • @all/*: all spaces (that the user has permission to view)
  
  Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
• label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
• sort - (optional) the sorting to apply to the results.
  Accepted values:
  • title: by content title
  • creation: by time of creation
  • modified: by time of last modification (creation is the "first" modification)
• reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

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

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

Include a list of 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.

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

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

Renders the list of pages associated with the specified label as a navigable map.
A label must be specified for this macro. The following parameters are all optional:

• title - the title for this navigation map.
• wrapAfter - the number of cells to span horizontally before wrapping to the next line. (default: 5)
• cellWidth - width of individual cells in the map in pixels. (default: 90px)
• cellHeight - height of individual cells in the map in pixels. (default: 60px)
• theme - if you want to create your own look and feel for the navmap (say one with rounded corners), you can do so by adding a file to the WEB-INF/classes/templates/macros directory. The file name convention to use is: navmap-mytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you specify this when calling the macro using theme=mytheme.

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

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

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

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.

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

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

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

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

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

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.

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:

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

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

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

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

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

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

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

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

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

Example:

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

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

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.

The {html-include} macro allows you to include the contents of an HTML file in a Confluence page.

CAUTION: Including unknown HTML inside a webpage is dangerous. Because HTML can contain active scripting components, it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a users authentication cookie and give the attacker their Confluence login password.

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

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.

Generates a PlantUML diagram.

• type: - (optional) the type of the diagram. Possible values are: 'plantuml' (default), 'ditaa' or 'dot'
• align: - (optional) align the diagram. Supported values are 'none' (default), 'left', 'center' and 'right'.
• border: - (optional) border size in pixel. Value must be integer > 0.
• hspace: - (optional) extra space left and right from the image. Value must be integer > 0.
• vspace: - (optional) extra space below and above the image. Value must be integer > 0.
• title: - (optional) the title of the diagram, default is none title. Only valid if type=plantuml.
• dropshadow: - (optional) drop shadow. Only valid if type=ditaa.
• separation: - (optional) separation of common edges of shapes. Only valid if type=ditaa.
• format: - (optional) Image output format. SVG or PNG. Default: PNG
• exportName: - (optional) stores the generated image as attachment if a name is given.
• debug: - (optional) show debug information when set to true.
• macro body: - (required) the PlantUML block. The @start and @end tags are not required. The detailed documentation of the syntax is available on the PlantUML website.

This is the output of the sample on the left side:

Generates a flowchart diagram.

• edgeArrowSize: - (optional) Size of arrows. Value must be number. Default: 0.8
• nodeShape: - (optional) Supported values are: rect, ellipse, tab, note, component, folder, box3d and square. Default: rect
• nodeStyle: - (optional) Supported values are: diagonals, rounded, dashed, dotted, solid and bold. Default: filled
• nodeFillColor: - (optional) Background color if nodeStyle=filled. Colors might be defined by name or as RGB values (#RRGGBB). Default: lightyellow
• nodeFontname: - (optional) Name of the node font. Default: Verdana
• nodeFontsize: - (optional) Size of font. Value must be integer. Default: 9
• format: - (optional) Image output format. SVG or PNG. Default: PNG
• exportName: - (optional) stores the generated image as attachment if a name is given.
• debug: - (optional) show debug information when set to true
• macro body: - (required) the Dot block. The starting digraph { and ending } must not be given. The detailed documentation of the syntax is available on the Graphviz website.

This is the output of the sample on the left side:

Generates a graphical overview of wiki pages in a Confluence space.

• space: - (optional) Key of space to create graph for. Default: current space
• page: - (optional) Title of page that will be treated as root of the graph. Only its descendants will be shown in graph. Supported are
  @self start at the current page,
  pagetitle and
  spacekey:pagetitle.
  The parameter space will be ignored if a spacekey is given here. Default: use all top level pages
• depth: - (optional) Number of levels descendent pages will be shown. 0 only root pages, 1 only direct children. Value must bei integer. Default: 3
• nodeFontsize: - (optional) Size of font. Value must be integer. Default: 9
• direction: - (optional) Layout of graph. Supported are
  TB top to bottom and
  LR left to right.
  Default: LR
• format: - (optional) Image output format. SVG or PNG. Default: PNG
• exportName: - (optional) stores the generated image as attachment if a name is given.
• debug: - (optional) show debug information when set to true

This is the output of the sample on the left side:

Generates a graphical overview of a database.

• datasource: - (required) Datasource name. Must be configured by Confluence admin.
• schemaName: - (optional) name of schema to visualize.
• tableTypes: - (optional) Comma separated list of types to show in graphics. It depends on the database which types are available. Common ones are TABLE, INDEX, SEQUENCE, VIEW. Macro database-info gives a list of available types.
• tableNameFilter: - (optional) Show only tables with these names in generated graphic. Wildcards _ and % can be used as in a SQL SELECT. An additional filtering is possible with tableNameRegEx.
• columnNameFilter: - (optional) Show only columns with these names in generated graphic. It works like tableNameFilter.
• tableNameRegEx: - (optional) Show only tables with these names in generated graphic. Table names are defined as regular expression, e.g. show all tables whose names start with A,B,C or D: [A-D].*.
• columnNameRegEx: - (optional) Show only columns with these names in generated graphic. It works like tableNameRegEx.
• showColumns: - (optional) If true column names and their data types are shown. Default: true
• showComments: - (optional) If true and comments are available, they are shown after --. Default: false
• showDefaults: - (optional) If true the default values are defined they are shown after =. Default: false
• showIndexes: - (optional) If true the indexes of each table are shown below the column names. Indexes can also be shown by adding INDEX to the list of tableTypes but this will need more space on the graphic. Default: false
• additional: - (optional) The appearance of the graphics can be changed by adding some DOT commands here. This will overwrite the default set by the macro.
• nodeFontsize: - (optional) Size of font. Value must be integer. Default: 9
• format: - (optional) Image output format. SVG or PNG. Default: PNG
• exportName: - (optional) stores the generated image as attachment if a name is given.
• debug: - (optional) show debug information when set to true. Default: false

This is the output of the sample on the left side:

Show information about databases and JDBC drivers.

• datasources: - (optional) Names of databases to show information about. They must be configured as datasource by a Confluence admin. Leave empty to show information about all available databases. Multiple names can be separated by comma.
• attributes: - (optional) All available attributes will be shown (default). Attributes to show can be given as comma separated list.

This is the output of the sample on the left side: