Example:

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

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

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

See Also: User Guide and Examples

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

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.

The page-info is used for retrieving information about the current page

• displayType - required - selects the kind ad style of data displayed
  • created-user - displays the user who created the page
  • created-date - displays the date the page was created
  • modified-user - displays the user who last modified the page
  • modified-users - displays a list of all the users who have modified the page
  • modified-date - displays the date the page was last modified
  • participants - displays a list of the users who have modified or commented on the page
  • commenters - displays a list of the users who have commented on the page
  • current-version - displays the most recent version number for the page
  • versions - displays a comma separated list of version numbers, clickable to take you to view that version
  • diffs - displays a list of version numbers, clickable to take you to view the differences between that version and the next version
  • labels - displays a list of labels, clickable to take you to view that label
  • title - displays the title of the specified page
  • tinyurl - displays a tinyurl link to the specified page
  • pageID - displays the ID of the specified page
• page - optional - selects the page for which information is being retrieved, if unspecified the current page is used
• dateFormat - optional - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
• prefix - optional - selects the prefix applied to lists
• reverse - optional - reverses the order of the items found (versions & diffs only)
• count - optional - sets the number of items to be displayed (versions & diffs only)
• type - optional - displays lists of information as a flat comma separated list (default), or as an unordered list
• wrap - optional - wraps lists in a span (default true)
• caption - optional - caption to use with tinyurl links (@tinyid, @tinyurl, @title - default=title)

See Also: User Guide and Examples

Displays version history data about a page in a tabular format

• page - selects the page for which information is being retrieved, if unspecified the current page is used
• dateFormat - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
• reverse - displays data in reverse revision order when set to true
• first - limits the number of entries displayed

See Also: User Guide and Examples

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.

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.

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.

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 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:controls=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 showing the controls.

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

{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:controls=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 showing the controls.

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

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!

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

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

The columns in the table are interpreted as follows:

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

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

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

• Flowchart Macro.
• Graphviz Documentation.

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

Displays a graph drawn using the GraphViz language.

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

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

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

Inserts a trade mark: Builder Hosting^TM

See Also: User Guide and Examples

Inserts a service mark: Builder Hosting^SM

See Also: User Guide and Examples

Inserts a registered trade mark: Adaptavist^�

See Also: User Guide and Examples

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

See Also: User Guide and Examples

Insert a style sheet in to your content.

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

See Also: User Guide and Examples

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

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

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

See Also: User Guide and Examples

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

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

Add a search box to your page:

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

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

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

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

See Also: User Guide and Examples

Inserts a table.

Parameters:

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

See Also: User Guide and Examples

Inserts a table row.

Parameters:

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

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

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

See Also: User Guide and Examples

Inserts a table heading cell.

Parameters:

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

See Also: User Guide and Examples

Inserts a table body.

Parameters:

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

See Also: User Guide and Examples

Inserts a table heading.

Parameters:

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

See Also: User Guide and Examples

Creates an ordered list tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

Creates an unordered list tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

Creates a list item tag.

Do not include quotes in the class name or styles.

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

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

Properties:

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

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

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

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

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

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

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

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

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

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

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

Shows a card in the specified deck.

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