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

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

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

Example:

Example:

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

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

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

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

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

• type - The type of chart to display. May be:
  • pie - A pie chart (default)
  • bar - A bar chart
  • line - A line chart
  • area - An area chart
  • XY plots - The standard XY plot has numerical x and y axes. The x values may optionally be time based. See the timeSeries parameter.
  • xyArea - A XY area chart
  • xyBar - A XY bar chart
  • xyLine - A XY line chart
  • xyStep - A XY step chart
  • xyStepArea - A XY step area chart
  • scatter - A scatter plot
  • timeSeries - A time series chart
• title - The title of the chart.
• xLabel - The label to use for the x axis
• yLabel - The label to use for the y axis
• legend - A legend will be displayed unless 'legend=false' is specified.
• width - The width of the chart in pixels (default is '300')
• height - The height of the chart in pixels (default is '300')
• dataDisplay - If 'true', the data table will be displayed below the chart.
• dataOrientation - The data table will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
• 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.
• dateFormat - For time series data, the date format determines the conversion of data to 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'. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.
• timeSeries - If 'true', the x values in an XY plot will be treated as time series data and so will be converted according to dateFormat and timePeriod.
• 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
• axis customization - 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
• domainAxisLowerBound - domain axis lower bound
• domainAxisUpperBound - domain axis upper bound
• domainAxisTickUnit - domain axis units between axis tick marks
• bgColor - Color (default is 'white') to use as the background of the chart. See Colors.
• borderColor - Color of a border around the chart. Default is to not show a border. See Colors.
• colors - Comma separated list of colors used to customize category, sections, and series colors. See Colors.

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; they're simply copied into the output string during formatting or matched against the input string during parsing.

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

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800

Pattern letters are usually repeated, as their number determines the exact presentation:

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's 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 isn't 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.

Prints an informational note

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

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

Prints a warning note to the user

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

Warning Insert warning message here!

Prints a helpful tip for the user

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

Handy Hint Join the Confluence Mailing-List!

Prints a simple note to the user.

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

Be Careful The body of the note here.. /confluence/images/icons/emoticons/warning.gif

Defines a repeating section. The contents of the macro will be repeated 0-n times, depending how many have been added in edit mode. Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• order - (optional) If set to 'desc', the rows will list from bottom to top.
• initialRows - (optional) The number of times the section should be repeated initially.

Defines a simple option for a list. Must be contained inside a list-data macro.

• [default] - (required) The non-wiki label for the option.

Allows entering of text in a single- or multiple-line text field. Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• type - (optional) The type of field to display. May be one of the following:
• line - (default) A single-line text field.
• password - A single-line password field.
• area - A multi-line text area field.
• content - (optional) The type of content in the field. May be one of the following:
• wiki - (default) The content is wiki markup.
• text - The content is plain text.
• noformat - The content will appear inside a {noformat} section.
• quote - The content will be quoted.
• code:language - The content will be rendered as code, with an optional programming language such as Java or XML. E.g. 'content=code:JavaScript'.
• min-length - (optional) The minimum number of characters that may be entered.
• max-length - (optional) The maximum number of characters that may be entered.

Allows editing of date field. Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• format - (optional) The format of the date content. May contain any of the following special characters:
• y - The year (eg. 'yy' = '05', 'yyyy' = 2005).
• M - The month (eg. 'MMMM' = 'April', 'MMM' = 'Apr', 'MM' = '04').
• d - The day (eg. 'dd' = '09', 'd' = '9').
• H - The hour - 24 hour time (eg. 'HH' = '13').
• h - The hour - 12 hour time (eg. 'hh' = '01').
• m - The minute (eg. 'mm' = '23').
• s - The second (eg. 'ss' = '14').
• a - AM/PM (eg. 'a' = 'PM').

Imports the specified template to the current page. This is different to creating a page using a template because it will always display the latest version of the template, rather than copying the original version.

• [default]/name - (required) The template to import and display.

Defines an editable table. Should contain a single header row ('||') and a single data row ('|'). The header row will be displayed once at the start of the table. The data row will be repeated for each row in the table. Make sure there are spaces around the '|' characters marking table cell boundaries. Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• order - (optional) If set to 'desc', the rows will list from bottom to top.
• initialRows - (optional) The number of times the section should be repeated initially.

Creates a set of list options linking to the attachments on the specified content the filter options. Must be contained inside a list-data macro.

• content - (optional) If specified, the page or other content the files are attached to. Defaults to the current page.
• filter - (optional) A regular expression filtering the attachment file name. E.g. ".*gif" for all GIF files.

Allows editing of page's excerpt text via a text field. All the options for {text-data} will work here. Must be contained inside a scaffold macro.

Evaluates mathematical equations, optionally using values from other field data in the same scaffold. Other fields can be referenced by putting them inside '${}' markers. The examples to the left add and divide the current values of the 'Foo' and 'Bar' fields, respectively. Must be contained inside a scaffold macro.

Parameters

• [default]/name - (required) The name of the field.
• format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details.

Functions

• round([number], [places]) - Rounds the number to the specified number of decimal places. Eg: round(1.4634, 2) rounds to 1.46.
• sumtable([table], [column]) - Sums the values of the specified column in the specified table. Eg: sumtable("My Table", "Number Column").
• avgtable([table], [column]) - Averages the values of the specified column in the specified table. Eg: avgtable("My Table", "Number Column").

Creates a set of list options linking to content matching the filter options. Must be contained inside a list-data macro.

• parent - (optional) Only children of the specified page will be listed.
• ancestor - (optional) Any decendent of the specified page will be listed.
• spaces - (optional) Only lists pages from the specified list of spaces.
• branches - (optional) Specifies the type of pages that will be listed. May be one of:
• all - All page types are returned.
• parents - Only pages with children are listed.
• children - Only pages with no children are listed.

Creates a set of list options linking to users matching the filter options. Must be contained inside a list-data macro.

• groups - (optional) Only users in the specified groups will be listed.
• spaces - (optional) Only users with the required access to the specified spaces will be listed. Permissions can be specified for each space. Eg:
• SPACEKEY:view - (default) Only users with view access to the SPACEKEY will be listed.
• SPACEKEY:edit - Only users with edit access to the space will be listed.
• SPACEKEY:admin - Only users with administration access to the space will be listed.
• SPACEKEY:blog - Only users who can post a blog (aka News) message will be listed.
• users - (optional) Only users specified will be listed.

Creates a framework for users to edit specific parts of the page in a more structured way.

By default, anyone who has edit access to the page can modify the page data.

• [default]/name - (required) The name of the scaffold.
• users - (optional) A comma-separated list of extra users who can edit the scaffold.
• groups - (optional) A comma-separated list of extra groups who can edit the scaffold.

Hides its contents when viewing a page, but reveils it when editing. Must be contained inside a scaffold macro.

• whenEmpty - (optional) If present, the field value specified will be checked, and the contents of this hidden-data macro will be hidden if the field is empty.
• whenHasRows - (optional) If present, the table/repeation section specified will be checked, and the contents of this hidden-data macro will be hidden if it has any rows.
• whenNoRows - (optional) If present, the table/repeation section specified will be checked, and the contents of this hidden-data macro will be hidden if it has no rows.

Allows selecting one or more options. Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• type - (optional) The type of field to display. May be one of the following:
• select - (default) A selectable list is displayed.
• check - A list of checkable items are displayed.

Creates a set of list build from pre-set values provided by other plugins:

Allows entering of a whole number value (eg 1, 4000). Must be contained inside a scaffold macro.

• [default]/name - (required) The name of the field.
• type - (optional) The type of field to display. May be one of the following:
• line - (default) A single-line number field.
• select - A single-selection drop-down list box. Note: this type requires that there is a maximum range of 1000 between the min-value and max-value.
• decimal - (optional) If 'true', the field will allow decimal values to be entered. Warning: Decimals are by their nature imprecise, and may result in some arithmatic errors at times. Only use them if necessary, and don't expect min-value and max-value to always be precise as boundaries.
• minValue - (optional) The minimum value the number may be (inclusive).
• maxValue - (optional) The maximum value the number may be (inclusive).
• step - (optional) The amount each option should step when in 'select' mode. Eg. a step of 2 will produce options 1, 3, 5, etc. Defaults to 1.
• format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details.

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.
• title - Title to show when mouse is over the refresh icon. Default is "Refresh".

Based on OSCache.

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.

Show flash based content on a confluence page.

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

Converts csv and other deliminated data into a table.

• 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.
• heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
• border - The border width in pixels. Defaults to normal table border width.
• width - The table width in pixels. Default is 100%.
• 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.
  • blanks - Blank or blanks only.
  • other single character delimiter - may be within double quotes with some restictions. Examples: ";", "=",
• quote - the character used to represent quoted data. Quoted data may contain delimiters or new lines. Quote character data 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.
• highlightRow - As the mouse moves over a table row, the row will be highlighted by default. Set highlightRow=false to stop this behavior.

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. Note that the excel, csv, or sql macros already have most of these capabilities. Clicking on a column heading will cause that column to be sorted. Clicking again will reverse the order.

• 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.
• width - The table width in pixels. Default is 100%.
• border - The border width in pixels. Defaults to normal table border width.
• highlightRow - As the mouse moves over a table row, the row will be highlighted by default. Set highlightRow=false to stop this behavior.
• columnTypes - By default, all columns are treated as strings for sorting purposes. Specify a comma separated list of column type indicators to identify column types.
  • string - S
  • integer - I
  • float - F
• Other parameters - Other parameters are passed through to the html table markup for more advanced capabilities or to override the default class

Transforms XML to a Confluence page via an XSLT style sheet.

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.

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.
• 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 the result table or values from the SQL query.

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

• dataSource - Required parameter. Formerly known as the jndi parameter. For compatibility the jndi parameter will be still be used if the dataSource parameter is missing. Specify the datasource name defined in the application server. Do not use the standard prefix (java:comp/env/jdbc/) as it is added automatically if necessary. Specific values of this parameter may be restricted for security reasons. See your administrator for details.
• output - Determines how the output is formated:
  • html - Data is output as a HTML table (default).
  • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
• script - Location of sql statement. Default is the macro body only.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • global page template name - Data is read from a global page template.
  • space:page template name - Data is read from a space template.
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
• heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
• border - The border width in pixels. Defaults to normal table border width.
• width - The table width in pixels. Default is 100%.
• rowOrientation - By default, data is oriented with rows appearing vertically (in rows) and columns in columns. Specify rowOrientation=horizontal to have rows appear horizontally (as columns) and columns appear as rows.
• useColumnLabel - By default, database column names are used as column labels. Specify useColumnLabels=true to have database column labels used for column labels. Note that most databases default the column label to be the column name when no explicit column label is provided. Fly-over text for a column label will be the column name when useColumnLabel=true. Fly-over text for a column label will be the database column label when useColumnLable=false or by default.
• escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Set escape=true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
• convertNull - Default is true. Converts SQL NULL values to blank. Set to false to have NULL values show up as 'null'.
• highlightRow - As the mouse moves over a table row, the row will be highlighted by default. Set highlightRow=false to stop this behavior.
• table - Default is true. Set to false to not format the data in a table. This option can be used to run queries that produce single values that you want to include in text.
• noDataError - Default is false. Set to true to show an macro error when no data is returned from the query.
• showSql - Default is false. Set to true to show a panel with the sql statement.
• SQL parameter markers - SQL supports parameter markers in statements - these are identified by ?'s. Parameters p1, p2, ... are substititued for the parameter markers. This can be used to parameterize complex scripts stored as attachments or files.
  • p1 - first parameter marker
  • p2 - second parameter marker
  • ... - ...

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 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'

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

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.

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

Displays a graph drawn using the GraphViz language.

Displays a printable sudoku grid of the chosen dificulty, if no difficulty is selected then 'normal' will be used

• easy - The easiest skill level will be displayed
• normal - The normal skill level will be displayed
• hard - The hard skill level will be displayed

See Also: User Guide and Examples

Displays a javascript driven interactive sudoku game

See Also: User Guide and Examples

Displays either the user's personal high scores, or the overall leaderboard

The type may be one of the following values:

• personal - The user's personal high scores will be displayed (This will be the default value when none is specified and the high scores macro is displayed within a user profile)
• leaderboard - The overall 'leaderboard' high scored will be displayed (This will be the default value when none is specified and the high scores macro is displayed on a normal page)

See Also: User Guide and Examples

Displays an interactive sudoku game using Macromedia/Adobe Flash for the UI

Parameters:

• defaultTileset - Allows setting of the tileset initially displayed to the user, this parameter can have one of the following values
  • ninjafarm
  • footballmadness
  • chinese
  • digital (default)
  • eggheads
  • greenwithenvy
  • decimal
  • redherring
  • villainsandheroes
  • occupationalhazzard
  • roman
  • starstruck
  • roadrage
• allowChange - A true/false flag to state whether the game player can change the tile-set from its default value or not (default is 'true')
• helpsource - The name of a page to which a text file 'sudoku.txt' is attached, this text file is used to populate the instructions display on the main page of the interface (deafults to the current page)

See Also: User Guide and Examples

Displays either the user's personal high scores, or the overall leaderboard

The type may be one of the following values:

• personal - The user's personal high scores will be displayed (This will be the default value when none is specified and the high scores macro is displayed within a user profile)
• leaderboard - The overall 'leaderboard' high scores will be displayed (This will be the default value when none is specified and the high scores macro is displayed on a normal page)

See Also: User Guide and Examples

Displays an interactive sudoku game using Macromedia/Adobe Flash for the UI

Parameters:

• defaultTileset - Allows setting of the tileset initially displayed to the user, this parameter can have one of the following values
  • ninjafarm
  • footballmadness
  • chinese
  • digital (default)
  • eggheads
  • greenwithenvy
  • decimal
  • redherring
  • villainsandheroes
  • occupationalhazzard
  • roman
  • starstruck
  • roadrage
• allowChange - A true/false flag to state whether the game player can change the tile-set from its default value or not (default is 'true')
• helpsource - The name of a page to which a text file 'sudoku.txt' is attached, this text file is used to populate the instructions display on the main page of the interface (deafults to the current page)

See Also: User Guide and Examples

Displays either the logo used in the flash UI

The size defines the width of the logo displayed, the height is derived automatically from the width to keep the logo proprtional

See Also: User Guide and Examples

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

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

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

• user: - (optional) the (list of) users who cannot see the content.
• 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.

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

• user - (optional) the (list of) users who can see the content.
• 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.

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

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