Notation Guide - Confluence
http://confluence.atlassian.com/renderer/notationhelp.action?section=all
30 of 32 10/07/2007 3:21 PM
{opml:source=^attachment.opml}
{opml}
Displays an OPML file with expanding sections for each outline item. Should contain {opml-column}
macros to define extra attribute/column values.
source - (required) The source of the OPML file. Either an attachment ('^attachment.opml') or a
full URL ('http://server/file.opml').
width - (optional) The width of the table. Eg. '100%' or '400px'.
iconType - (optional) The type of content to use for the icons. May be one of the following:
image - (default) The icon values point to an image file, either an attachment or a URL.
wiki - The icon values are wiki text.
text - The icon values are plain text.
expandIcon - The value of the expand icon.
collapseIcon - The value of the collapse icon.
singleIcon - The value of the single item icon.
class - (optional) The custom CSS class for the OPML display.
{opml-column:name=text|title=A title}
{opml-column:name=Attribute}+A title+{opml-column}
Specifies the settings for a column of data in an OPML document. The data comes from extra attributes
on <outline> elements. Must be contained inside an {opml} macro.
name - (required) The name of the attribute the column gets data from.
title - (optional) The title of the column. This is wiki text, and you may alternately use the macro
body to set the title if there is more complex text you wish to use.
type - (optional) The type of data contained in the
text - (default) Plain text.
html - HTML text (note - this may be dangerous if there is bad HTML in the source).
number - A number. This may not contain any non-digit values. Eg. '9.5' is good, '$9.50' is
bad.
date - A date. You will usually want to specify the source format so that the date can be
interpreted correctly.
sourceFormat - The format of the date in the OPML file (eg. 'dd MMM, yyyy').
displayFormat - The format to display the value as, either a number format (eg. '$#0.00') or
date (eg. 'dd-MM-yyyy').
width - The width of the column. Eg. '100%', '400px'.
{yahoo:myyahooid}
{yahoo:myyahooid|showid=false}
Displays a graphic indication of whether a Yahoo! Instant Messenger user is online. You must supply a
valid Yahoo! ID as the default argument.
Specifying showid=false will cause the macro to only output the image, not the user's Yahoo! ID in text
format.
{aim:myscreenname}
{aim:myscreenname|showid=false}
Displays a graphic indication of whether an AIM user is online. You must supply a valid AIM screen name
as the default argument.
Specifying showid=false will cause the macro to only output the image, not the user's AIM screen name
in text format.
{icq:12344563}
{icq:12344563|showid=false}
{icq:12344563|image=5}
Displays a graphic indication of whether an ICQ user is online. You must supply a valid ICQ UIN as the
default argument.
Specifying showid=false will cause the macro to only output the image, not the user's ICQ UIN in text
format.
Specifying
image=X
will cause the macro to use ICQ image set X. Examples of image sets can be found
here. The default image set is 5.
{excel:file=^Report.xls}
{excel:file=Year 2005^Report.xls|sheet=First Quarter,
Second Quarter}
{excel:file=excel/Report.xls|sheet=1,2,4}
Displays one or more worksheets from Microsoft Excel spreadsheets (Excel 97, 2000, 2003 workbooks).
Each worksheet is shown as a table. This macro supports common table capabilities with other table based
macros (table-plus, csv, and sql).
file - A required parameter unless url is specified. It specifies the location of the Excel file.
^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.
filename - Data is read from the file located in confluence home directory/script/filename.
Subdirectories can be specified.
url - Only required if file is not specified. Specifies the URL of an Excel file. Use of this parameter
may be restricted for security reasons. See your administrator for details.
sheets - By default, each sheet in the workbook will produce a table. Use the sheets parameter to
control what sheets will be shown. The parameter value can be a comma separated list of sheet
names (case sensitive) or sheet numbers (1-based counting)
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.
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%.
showHidden - By default, hidden sheets, rows, and columns will not be shown. Set
showHidden=true to show all data.
showSheetName - By default, the sheet name will not be shown. Set showSheetName=true to
show a the sheet name before the table.
formatCell - By default, no special formating will be applied to the cells. Set formatCell=true to
process each cell for special properties. Currently supported properties are:
html - Font and background color.
wiki - None at this time.
formatColumn - By default, the format for a column will be used to apply formating for all cells in
the column. Set formatColumn=false to not use the column formating information from the excel
sheet. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
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.
escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{',