wiki notation guide

8/3/2019 Wiki Notation Guide

1/94

Wiki Notation Guide

HeadingsTo create a header, place "hn. " at the start of the line (where n can be a number from 1-6).

Notation Comment

h1. Biggest heading Biggest heading

h2. Bigger heading Bigger heading

h3. Big Heading Big Heading

h4. Normal Heading Normal Heading

h5. Small Heading Small Heading

h6. Smallest Heading Smallest HeadingText Effects

Text effects are used to change the formatting of words and sentences.Notation Comment*strong* Makes text strong.

_emphasis_ Makes text emphasis.

??citation?? Makes text in citation.

-strikethrough- Makes text as .

+underlined+ Makes text as underlined.

^superscript^ Makes text in superscript.~subscript~ Makes text in subscript.

{{text will be monospaced}} Makes text as code text.

bq. Some block quoted text

To make an entire paragraph into a block quotation, place "bq. " before it.Example:Some block quoted text

{quote}here is quoteablecontent to be quoted{quote}

Quote a block of text that's longer than oneparagraph.

Example:here is quoteablecontent to be quoted

{color:red}look ma, red text!{color}

Changes the color of a block of text.Example: look ma, red text!

Text Breaks


2/94

Most of the time, explicit paragraph breaks are not required - Confluence will be able topaginate your paragraphs properly.

Notation Comment

(empty line) Produces a new paragraph

\\ Creates a line break. Not often needed, mostof the time Confluence will guess new linesfor you appropriately.

---- creates a horizontal ruler

--- Produces symbol.-- Produces symbol.Links

Links are the heart of Confluence, so learning how to create them quickly is important.Notation Comment

[#anchor][âttachment.ext]or[pagetitle][pagetitle#anchor][pagetitleâttachment.ext]or[spacekey:pagetitle][spacekey:pagetitle#anchor][spacekey:pagetitleâttachment.ext]

Creates an internal hyperlink to thespecified page in the desired space (orthe current one if you don't specifyany space). Appending the optional '#'sign followed by an anchor name willlead into a specific bookmarked pointof the desired page. Also having theoptional '^' followed by the name of an attachment will lead into a link tothe attachment of the desired page.Example: pagetitleIf such a page doesn't already exist, itwill allow you to create the page inthe current space. Create page linkswill have a after them.Example: anewpage

[link alias|#anchor|link tip][link alias|âttachment.ext|link tip]or[link alias|pagetitle|link tip][link alias|pagetitle#anchor|link tip][link alias|pagetitleâttachment.ext|link tip]or[link alias|spacekey:pagetitle|link tip][link alias|spacekey:pagetitle#anchor|link tip][link alias|spacekey:pagetitleâttachment.ext|link tip]

Creates an internal hyperlink to thespecified page in the desired space (orthe current one if you don't specifyany space) where the link text isdifferent from the actual hyperlink link. Also you can have an optional

link tip which will apear as tooltip.Appending the optional '#' signfollowed by an anchor name will leadinto a specific bookmarked point of the desired page. Also having theoptional '^' followed by the name of an attachment will lead into a link tothe attachment of the desired page.
https://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.action


3/94

Example: link alias

[/2004/01/12/Blog Post][spacekey:/2004/01/12/Blog Post]

Creates an internal hyperlink to thespecified blog post in the desiredspace (or the current one if you don'tspecify any space). You must specifythe date the post was made in

/year/month/day form as shown.Anchors and link text can be addedthe same way as described above.If you attempt to link to a blog postthat doesn't exist, no link will becreated.Example:

/2004/01/12/Blog Postmy link name

[/2004/01/12][spacekey:/2004/01/12]or[my link name|/2004/01/12][my link name|spacekey:/2004/01/12]

Creates an internal hyperlink to aview of a whole day's blog. Specifythe date you wish to link to asyear/month/day. Link titles can besupplied as with other links. It ispossible to link to days with no blogposts on them: the destination pagewill just be empty.Examples:

/2004/01/12/Blog Postmy link name

[$12345]or[my link name|$12345]

Creates a link to a piece of content byits internal database ID. This iscurrently the only way to link to amail message.Examples:Re: Webwork 2 Upgrademy link name

[spacekey:][custom link title|spacekey:]

Creates a link to the space homepage,or space summary page of a particularspace. Which of these the link pointsto depends on the configuration of thespace being linked to. If the spacedoes not exist, the link will be drawnwith a strike-through to indicate it isan invalid space.Examples:spacekeycustom link title[nosuchspace:]
https://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.action


4/94

[~username][custom link title|~username]

Creates a link to the user profile pageof a particular user. By default, will bedrawn with a user icon and the user'sfull name, but if you supply a customlink text, the icon will not be drawn. If

the user being linked to does not exist,the link will be drawn with a strike-through.Examples:

User Full Namecustom link title[~nosuchuser]

[phrase@shortcut][custom link text|phrase@shortcut]

Creates a shortcut link to the specifiedshortcut site. Shortcuts are configuredby the site administrator. You can adda link title to shortcuts in the samemanner as other links.Examples:http://www.google.com/search?q=confluencecustom link text

[http://confluence.atlassian.com]

[Atlassian|http://atlassian.com]

Creates a link to an external resource,special characters that come after theURL and are not part of it must beseparated with a space. External linksare denoted with an arrow icon.Note: the [] around external links areoptional in the case you do not wantto use any alias for the link.Examples:http://confluence.atlassian.com/ Atlassian

[mailto:[email protected]]

Creates a link to an email address,complete with mail icon.Example:https://wiki.myatos.net/renderer/notationhelp.action#

[file://c:/temp/foo.txt][file://z:/file/on/network/share.txt]

This only works on Internet ExplorerCreates a link to file on your computeror on a network share that you havemapped to a drive

{doc:/display/DOC/Confluence+Documentation+Home}Confluence Documentation{doc}

A macro that allows you to quicklycreate links to content athttp://confluence.atlassian.com/.
https://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttp://www.google.com/search?q=confluencehttp://www.google.com/search?q=confluencehttp://www.google.com/search?q=confluencehttp://confluence.atlassian.com/http://atlassian.com/https://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttp://confluence.atlassian.com/http://confluence.atlassian.com/https://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.actionhttp://atlassian.com/http://confluence.atlassian.com/http://www.google.com/search?q=confluencehttp://www.google.com/search?q=confluencehttp://www.google.com/search?q=confluencehttps://wiki.myatos.net/renderer/notationhelp.actionhttps://wiki.myatos.net/renderer/notationhelp.action


5/94

Default parameter The link to thecontent relative tohttp://confluence.atlassian.com/. Macro body The link text,interpreted as wiki markup.

{add-page:template=My Template|parent=PageParent}Click to add page{add-page}

Generates an 'Add Page' link which,when clicked, can take the userdirectly to a template and/or set thepage parent.template - (optional) the name of thetemplate to use when creating thepage.live - (optional) if set to 'true', thetemplate will be live when the page iscreated. Defaults to false.parent - (optional) the name of theparent page (empty by default). Mayalso have the following markers:@self - (default) the parent will be thepage the macro is in.@parent - the parent will be the parentof the page the macro is in.@home - the parent will be homepage for the Space the page is in.title - (optional) if you want popuptext to appear when the mouse ishovered over the link, enter it here.labels - (optional) the list of labels toapply to the new page. Does not work for non-live templates.allowRename - (optional) if set totrue, the user will be allowed torename the page while it is beingcreated.

{add-page-form:template=MyTemplate|parent=Page Parent}Click to add newpage{add-page-form}

Generates an 'Add Page' form with afield for the title.template - (optional) the name of thetemplate to use when creating thepage.live - (optional) if set to 'true', thetemplate will be live when the page iscreated. Defaults to false.parent - (optional) the name of theparent page (empty by default). Mayalso have the following markers:
http://confluence.atlassian.com/http://confluence.atlassian.com/


6/94

@self - (default) the parent will be thepage the macro is in.@parent - the parent will be the parentof the page the macro is in.@home - the parent will be home

page for the Space the page is in.labels - (optional) the list of labels toapply to the new page. Does not work for non-live templates.allowRename - (optional) if set totrue, the user will be allowed torename the page while it is beingcreated.width - (optional) The width of thetitle text field. Eg. '250px' or '70%'.

{link-page:template=My Template|parent=PageParent}Click to add page{link-page}{link-page:Page Title|template=My Template}ASpecific Page{link-page}

Links to a page in the current space. If the page doesn't exist or is untitled, itgenerates a 'Add Page' link which,when clicked, can take the userdirectly to a template and/or set thepage parent.The title may also contain substitutionmarkers, indicated with '%'surrounding a Supplier key chainvalue. Eg:{link-page:name=%content:title% -%global:current user > user:fullname%}your page{link-page}This will link to a page with the namebeing the parent page's title, followedby " - " followed by the current user'sname.[default]/name - (optional) the title of the page. If not supplied, clicking thelink will always create a new page.template - (optional) the name of thetemplate to use when creating thepage.live - (optional) if set to 'true', thetemplate will be live when the page iscreated. Defaults to false.parent - (optional) the name of theparent page (empty by default). Mayalso have the following markers:@self - (default) the parent will be thepage the macro is in.
http://www.customware.net/repository/display/AtlassianPlugins/Suppliershttp://www.customware.net/repository/display/AtlassianPlugins/Suppliers


7/94

@parent - the parent will be the parentof the page the macro is in.@home - the parent will be homepage for the Space the page is in.title - (optional) if you want popup

text to appear when the mouse ishovered over the link, enter it here.labels - (optional) the list of labels toapply to the new page. Does not work for non-live templates.allowRename - (optional) if set totrue, the user will be allowed torename the page while it is beingcreated.

{link-to:dashboard}Go to Dashboard{link-to}{link-to:news|space=ANOTHERSPACEKEY}Go toanother space's news{link-to}{link-to:page source|popup=true}View pagesource{link-to}

Creates a link to special Confluencelocations. All locations are non-case-sensitive.Parameters[default] - The location to link to. Seethe list of locations below.space - (optional) The spacekey tolink to.page - (optional) The name of thepage/news item/etc to link to.popup - (optional) If 'true', the link will open in a popup window.popupWidth - (optional) The width of the popup window. Defaults to 600px.popupHeight - (optional) The heightof the popup window. Defaults to400px.popupScroll - (optional) If false, noscrollbar is displayed. Defaults to true.target - (optional) The name of thepopup window to open.title - (optional) if you want popuptext to appear when the mouse ishovered over the link, enter it here.Global Locationsadmin - The administration section.dashboard - The Dashboard.global templates - The globaltemplates page.homepage - The user's homepage.login - The login page.logout - The logout page.


8/94

signup - The signup page.notation guide - The notation guide.rss feed builder - The RSS FeedBuilder (Confluence 2.x)spaces - The list of spaces the user has

access to. (Confluence 1.4)user profile - The currently logged inuser's profile.user history - The currently logged inuser's history.Space LocationsYou can specify which space to link to by setting the 'space=key'parameter, or it will default to thecurrent space.add news - Add a news post.

browse space - Go to the 'BrowseSpace' view.mail - The mail page.news - The news page.pages alphabetical - The list of pagesin alphabetical order.pages tree - The hierarchical view of pages in the space.pages updated - The recently updatedpages list.space attachments - The attachments

list for the space.space templates - The space templateslist.popular labels - A page listing popularpage labels in the space. (Confluence2.x)all labels - A page listing all labelsacross the space. (Confluence 2.x)RSS FeedsAgain, you can specify the space, orthe current one will be used as the

default.rss comments - New comments areadded to this feed.rss news - News items for the spaceare added to the feed.rss new pages - Any new pages in thespace are added to the feed.rss updated pages - Any updated


9/94

pages in the space are added to thefeed.Page LocationsYou can specify the space key asabove, and you can specify the page

or news item with the 'page=PageName' parameter.@parent - Links to the page's parent,if it has one.@self - Links to the page the macro ison.add comment - Opens the 'addcomment' section of the page.page comments - Jumps to the pagecomments.page attachments - The attachments

tab for the page.page children - Jumps to the pagechildren list.page edit - The edit tab for the page.page history - The page history view.page info - The page info view.page source - The page source viewpdf export - Export the page to PDF.word export - Export the page inMicrosoft Word format.print - The print view for the page.

{link-window:Another Page}Open Another Pagein Another Window{link-window}

Links to a page or URL, popping it upinto a new window.[default]/href - The name of the page,or the URL.type - Either 'normal' (the default) or'popup'. If set to popup, many of thesettings below will default to thoseappropriate for a popup window.width - The width of the new window.height - The height of the newwindow.scrollbars - If false, the scrollbar willbe hidden.menubar - If false, the menubar willbe hidden.location - If false, the location bar willbe hidden.statusbar - If false, the status bar willbe hidden.


10/94

resizable - If false, the window willnot be resizable.target - The title of the target window.Use this to open multiple links in thesame popup window.

tip - The tip to display while themouse is hovering over the link.icon - If false, the link will not havean 'open new window' icon.

{anchor:anchorname}

Creates a bookmark anchor inside thepage. You can then create linksdirectly to that anchor. So the link [My Page#here] will link to whereverin "My Page" there is an{anchor:here} macro, and the link [#there] will link to wherever in thecurrent page there is an{anchor:there} macro.

ListsLists allow you to present information as a series of ordered items.Notation Comment

* some* bullet** indented** bullets* points

A bulleted list (must be in first column). Use more (**) for deeperindentations.Example:somebullet

indentedbulletspoints

- different- bullet- types

A list item (with -), several lines create a single list.Example:differentbullettypes

# a# numbered# list

A numbered list (must be in first column). Use more (##, ###) fordeeper indentations.

Example:anumberedlist

# a# numbered#* with#* nested

You can even go with any kind of mixed nested lists:Example:anumbered


11/94

#* bullet# list* a* bulletted*# with

*# nested*# numbered* list

withnestedbulletlist

abullettedwithnestednumberedlist

{dynamictasklist:thingsToDo}

The Dynamic Tasklist Macro displays a task list which can bemodified in the page as it is viewed. Despite the fact that this pluginhas an ajax UI, it is still fully versioned like a normal Confluencepage.Example:

What you needto type

What you will get

{dynamictasklist:Arthurs To-Do's}

ImagesImages can be embedded into Confluence pages from attached files or remote sources.Notation Comment

!http://www.host.com/image.gif!or!attached-image.gif!

Inserts an image into the page.If a fully qualified URL is given the imagewill be displayed from the remote source,otherwise an attached image file isdisplayed.

!spaceKey:pageTitle^image.gif!

!/2007/05/23/My Blog Post^image.gif!

Inserts an image that is attached on anotherpage or blog post.

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

!image.jpg|thumbnail!

Insert a thumbnail of the image into thepage (only works with images that areattached to the page). Users can click onthe thumbnail to see the full-sized image.Thumbnails must be enabled by the siteadministrator for this to work.


12/94

!image.gif|align=right, vspace=4!For any image, you can also specifyattributes of the image tag as a commaseparated list of name=value pairs like so.

{gallery}

{gallery:columns=3}

{gallery:title=Some office photos, and awaterfall|columns=3}

{gallery:title=Some office photos, withoutthe waterfall|exclude=waterfall.jpg}

{gallery:title=One office photo, and awaterfall|include=office1.jpg,waterfall.jpg}

{gallery:title=Some office photos, and a

waterfall|page=Gallery of Pictures}{gallery:title=Some office photos, and awaterfall|page=DOC:Gallery of Pictures}

{gallery:title=Some office photos, and awaterfall|sort=name}

{gallery:title=Some office photos, and awaterfall|sort=date|reverse=true}

Create a gallery of thumbnails of allimages attached to a page. This will onlywork on pagesthat allow attachments,obviously.The title parameter allows you to supply atitle for the galleryThe columns parameter allows you tospecify the number of columns in thegallery (by default, 4)The exclude parameter allows you tospecify the name of attached images toignore (i.e., they will not be included in thegallery). You can specify more than onepicture, separated by commas. Example:exclude=my picture.png,my picture2.gif The include parameter allows you tospecifically include one or more attachedimages. The gallery will show only thosepictures. You can specify more than onepicture, separated by commas. Example:include=my picture.png,my picture2.gif The page parameter allows you specify thetitle of one or more pages which containsthe images you want displayed. If a page isin the same space as the page containingthe macro, use the format page=My PageName. To specify a page in a differentspace, use page=SPACEKEY:My PageName, such as page=DOC:Gallery Macro.You can specify more than one page,separated by commas. Example:page=Image Gallery,STAFF:Group PhotosIf a page or attachment file name contains acomma, you can use it in the include,exclude, or page parameters by enclosing itin single or doublequotes. Example:include="this,that.jpg",theother.pngThe sort parameter allows you to controlthe order of the images. The options arename,comment, date, or size.The reverse parameter is used inconjunction with the sort parameter toreverse the order of the specified sort.


13/94

Valid values are true and false.Previous versions of the Gallery macro hadan additional slideshow parameter. This isno longer used in the latest version, and theslide show is always enabled. We have left

the parameter here for compatibility witholder versions of the macro.

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

{imagemap} Base-Plugin defining theimage to use for the ImageMap.name: (mandatory) Specifies the link to theimage to be used as an ImageMap. Can be1) an absolute URL e.g.'[http://www.somedomain.com/somepicture.jpg]' or2) a Confluence-like link to an image-attachment [somepage^somepicture.jpg]width: (optional) Specifies the width of theimageheight: (optional) Specifies the height of the image{map} Nested Plugin for defining clickableregions and target-links.title: (optional) Tooltip text, that appears if the mouse stays over the clickable region.coords: (mandatory) Coordinates of theshape:x1,y1,x2,y2 for rect-shapesx,y,r for circle-shapesx1,y1,x2,y2 ... xn,yn for polygon-shapes.link: (mandatory) Target link where to go,after region was clicked.Can be1) an absolute URL e.g.'http://www.google.com' or2) a Confluence-like link [somepage]shape: (optional) The shape of the clickableregion. Possible values are 'rect', 'circle'and 'polygon'. Defaults to 'rect'target: (optional) Specifies the target-frameof the link. E.g. target='_blank' opens thelink in a new window

TablesTables allow you to organise content in a rows and columns, with a header row if required.

Notation Comment


14/94

||heading 1||heading 2||heading 3|||col A1|col A2|col A3||col B1|col B2|col B3|

Makes a table. Use double bars for a tableheading row. Note that each table-row has tobe defined on a single line.The code given here produces a table thatlooks like:

heading 1 heading 2 heading 3col A1 col A2 col A3

col B1 col B2 col B3

{column:width=50%}Text in this column.{column}

Defines a single column.width: - (optional) the width of the column.Must be defined in a section macro.

{section}

{column:width=30%}Column one text goes here{column}

{column:width=70%}Column two text goes here{column}

{section}

{section:border=true}...{section}

If you want to use columns instead of tables,you can define them first by marking a{section}, and then placing any number of {column}s inside.border: - (optional) set to "true" to draw aborder around the section and columns.

Advanced FormattingMore advanced text formatting.Notation Comment{code:title=Bar.java|borderStyle=solid}

// Some comments herepublic String getFoo(){

return foo;

}{code}

{code:xml}

{code}

Makes a preformatted block of code with syntax highlighting.All the optional parameters of {panel} macro are valid for{code} too. The default

language is Java but you canspecify JavaScript,ActionScript, XML, HTML andSQL too.Example:Bar.java

// Some comments herepublic String getFoo()
https://wiki.myatos.net/renderer/notationhelp.action#atlassian-macro-sectionhttps://wiki.myatos.net/renderer/notationhelp.action#atlassian-macro-section


15/94

{return foo;

}

{report-table}

{xxx-reporter}

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

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

{report-table}

Displays the each of the itemsfrom a reporter in a table.A report block must containtwo things: 1) A reporter macro(such as {content-reporter} or{user-reporter}) , which findsthe list of items to report on,and 2) one or more {report-column}s must be present todefine what data is displayed. Itmay also optionally include a{report-empty} macro, whichspecifies what will be displayedif no items are returned fromthe reporter.depth - (optional) If the itemhas children, the depth dodisplay its descendents.Defaults to 0. May be 'all' forall descendents.sortDescendents - (optional) If set to false, the descendentsdisplayed if 'depth' is greaterthan 1 are not sorted using thereport sort criteria.maxResults - (optional) Themaximum number of results todisplay.firstResult - (optional) Specifythe number of the first result tostart displaying in the report.The first item has a number of 1.width - (optional) The width of the table (e.g. '500px', '100%').class - (optional) The CSS classto render the table with.injected - (optional) If set totrue, the {report-column}
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportcolumnhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportcolumnhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportcolumnhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportcolumnhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporter


16/94

macros will default to injecting%prefix:key% values directly.

{report-column:title=Column Title}{report-item:value}{report-column}

Displays a single column in a{report-table}. This macro willusually contain at least one useof the {report-item} macro, oranother macro which dispaysinformation about the currentitem being reported on.title - (required) The title todisplay in the table header.width - (optional) The width of the column. Eg. "50px","20em".colSpan - (optional) Thenumber of columns this columnshould span over.rowSpan - (optional) Thenumber of rows this columnshould span over.newRow - (optional) If set totrue, a new row will be startedwith this column.class - (optional) The CSSclass(es) to apply to thiscolumn.summaryType - (optional) Thetype of summary to display atthe end of this column. May beone of:sum - The sum total of allnumbers in the column.count - The number of non-blank values in the column.average - The average of allnumbers in the column.summaryValue - (optional) Thekey chain value for the columnsummary, or plain text todisplay if the 'summaryType' isnot set for this column. E.g."data:My Number", or"content:children >collection:size". *Note:* Thesummary value key can becompletely unrelated to what is
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reporttablehttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportitemhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportitemhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reporttable


17/94

displaying in the column, if sodesired.summaryFormat - (optional)The number format to use forthe summary. E.g. "$#,

injected - (optional) If set totrue, %prefix:key% values inthe body will be injected withreport value before beingrendered.

{report-list:depth=[1,2...all]|outline=true/false|style=[disc,decimal, etc]}

{xxx-reporter}

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

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

{report-list}

Displays the each of the itemsfrom a reporter as a list item.A report block must containtwo things: 1) A reporter macro(such as {content-reporter} or{user-reporter}) , which findsthe list of items to report on,and 2) A {report-body} macro,which contains the wiki codewhich will be executed for eachitem. It may also optionallyinclude a {report-empty}macro, which specifies whatwill be displayed if no items arereturned from the reporter.style - (optional) The style of bullet to display. May be anystandard CSS style. Defaults to'disc' if outlining is off, or'decimal' if outlining is on.outline - (optional) If set to'true', the list and any sub-listsof children will be displayedwith an outline number format(eg. "1.2.3"). Defaults to 'false'.Note: This setting will onlydisplay correctly in FireFox.depth - (optional) If the itemhas children, the depth dodisplay its descendents.Defaults to 0. May be 'all' forall descendents.sortDescendents - (optional) If set to false, the descendentsdisplayed if 'depth' is greaterthan 1 are not sorted using the
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporter


18/94

report sort criteria.trim - (optional) If 'false', thebody will not be trimmed. Trueby default.injected - (optional) If set to

true, the {report-body} macroswill default to injecting%prefix:key% values directly.maxResults - (optional) Themaximum number of results todisplay.firstResult - (optional) Specifythe number of the first result tostart displaying in the report.The first item has a number of 1.

{report-block}

{xxx-reporter}

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

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

{report-block}

Displays the each of the itemsfrom a reporter in a block of wiki text.A report block must containtwo things: 1) A reporter macro(such as {content-reporter} or{user-reporter}) , which findsthe list of items to report on,and 2) A {report-body} macro,which contains the wiki codewhich will be executed for eachitem. It may also optionallyinclude a {report-empty}macro, which specifies whatwill be displayed if no items arereturned from the reporter.separator - (optional) The typeof separator to display betweeneach item. Defaults to nothing.May be one of the following:bracket - Square brackets ('[',']') surrounding each item.brace - Braces ('{', '}')surrounding each item.comma - A comma (',') betweeneach item.paren - Parenthases ('(', ')')surrounding each item.pipe - A pipe ('|') between eachitem.
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportbodyhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-userreporterhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-contentreporter


19/94

newline - A line break aftereach item."custom" - Any other characteryou wish, specified betweenquotes.

maxResults - (optional) Themaximum number of results todisplay.firstResult - (optional) Specifythe number of the first result tostart displaying in the report.The first item has a number of 1.depth - (optional) If the itemhas children, the depth dodisplay its descendents.

Defaults to 0. May be 'all' forall descendents.sortDescendents - (optional) If set to false, the descendentsdisplayed if 'depth' is greaterthan 1 are not sorted using thereport sort criteria.injected - (optional) If set totrue, the {report-body} macroswill default to injecting%prefix:key% values directly.

{report-header}This content is displayed at the beginning of a non-empty report.{report-header}

This macro contains the wikicode which will be displayedbefore a non-empty report. Itmust be contained in anotherreport macro (e.g. {report-block}) .trim - (optional) If 'true', thebody will be trimmed. False bydefault.

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

This macro contains the wikicode which will be executed foreach item of the surroundingreport. It is used by the {report-block} and {report-list}macros. It will usually containone or more uses of the {report-item} macro to display reportedvalues.
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportlisthttps://wiki.myatos.net/renderer/customware-macro-reportitemhttps://wiki.myatos.net/renderer/customware-macro-reportitemhttps://wiki.myatos.net/renderer/customware-macro-reportitemhttps://wiki.myatos.net/renderer/customware-macro-reportitemhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportlisthttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22


20/94

trim - (optional) If 'true', thebody will be trimmed. False bydefault.injected - (optional) If set totrue, %prefix:key% values in

the body will be injected withreport values before beingrendered.

{report-footer}This content is displayed at the end of a non-emptyreport.{report-footer}

This macro contains the wikicode which will be displayedafter a non-empty report. Itmust be contained in anotherreport macro (e.g. {report-block}) .trim - (optional) If 'true', thebody will be trimmed. False bydefault.

{report-empty}This content is displayed for reports with no items.{report-empty}

This macro contains the wikicode which will be displayed if the surrounding report has noitems. It is used by the {report-block}, {report-list} and{report-table} macros.trim - (optional) If 'true', thebody will have any leading ortrailing white space removedbefore it is displayed. False bydefault.

{report-info:item:key|format=[number format/dateformat]|render=none/wiki|link=true/false}

Displays the specified keyvalue for the current reportitem. The key is a set of Supplier keys, separated by ">"characters. For example, if thecurrent item is a standardConfluence page, the followingwill display the page creator'sfull name:

{report-info:content:creator > user:fullname}

It first looks up the creator of the current item, then get thefull name for that user.default/key - (required) the key
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportlisthttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reporttablehttp://www.customware.net/repository/display/AtlassianPlugins/Suppliershttp://www.customware.net/repository/display/AtlassianPlugins/Suppliershttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reporttablehttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportlisthttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock%22


21/94

value to display.format - (optional) The date(eg. 'dd MMM, yyyy') ornumber (eg. '#, This will onlybe used if the data is a date or a

number, respectively.Otherwise, it will be ignored.link - (optional) If set to 'true'and the current item/key has aURL link, the text generatedwill be linked to that URL.Defaults to 'false'.render - (optional) If set to'wiki', the generated text will berendered as wiki text. Defaultsto 'none'.

default - (optional) Thecontents of this parameter willbe used if the item/key isempty. It will be rendered aswiki text. Alternately, the bodyof the macro can also be used,if more complex wiki text isrequired.separator - (optional) If theitem/key points to a list of results, the type of separator to

display between each item.Defaults to 'comma'. May beone of the following:bracket - Square brackets ('[',']') surrounding each item.brace - Braces ('{', '}')surrounding each item.comma - A comma (',') betweeneach item.paren - Parenthases ('(', ')')surrounding each item.

pipe - A pipe ('|') between eachitem.newline - A line break aftereach item."custom" - Any other characteryou wish, specified betweenquotes.

{report-link:item:key|info=Mouse-over Displays the specified key


22/94

information|target=_blank}Link text{report-link} value as a link. It is assumedthat the item/key value is anabsolute or server-relative link.If not, the 'prefix' and 'postfix'parameters can be used to

prepend or append extra valuesto the URL.default/key - (required) the keyvalue to use as the link URL.info - (optional) The text whichwill be displayed when the userhovers their mouse over thelink.target - (optional) The targetframe to open the link in. Maybe any standard HTML target.

prefix - (optional) The text toprepend to the item/key valuein the link.postfix - (optional) The item toappend to the item/key value inthe link.trim - (optional) If set to 'false',the URL will not be trimmed.Defaults to 'true'.

{report-image:item:key|width=16px|height=16px}

Displays the specifed key valuefor the current item as animage. It is assumed that thekey value retrieved is anabsolute (eg."http://server/folder/file.gif") orserver-relative (eg."/folder/file.gif") URL.default/key - (required) the keyvalue to use as the image URL.width - (optional) The width of the image, using standard CSSunits (eg. "20px" or "80em").height - (optional) The heightof the image, using standardCSS units (eg. "20px" or"80em").border - (optional) The borderstyle of the image, usingstandard CSS values (eg. "reddash 2px").


23/94

{report-on:item:key}Sub-Item 1: {report-info:item:subkey 1}Sub-Item 2: {report-info:item:subkey 2}{report-on}

Sets the item context to theitem/key value specified. Thisis useful when you wish todisplay several key values froma sub-item of the item currently

being reported on. For example,you may wish to use the fullname and email address of thecurrent page's last modifier:

{report-on:content:modifier}

Last Modifier: {report-info:user:full name|link=true}({report-info:user:email|link=true})

{report-on}

default/key - (required) the keyvalue to display.default - (optional) Thecontents of this parameter willbe used if the item/key isempty. It will be rendered aswiki text. Alternately, the bodyof macro can also be used, if more complex wiki text isrequired.

separator - (optional) If theitem/key points to a list of results, the type of separator todisplay between each item.Defaults to 'comma'. May beone of the following:bracket - Square brackets ('[',']') surrounding each item.brace - Braces ('{', '}')surrounding each item.comma - A comma (',') between

each item.paren - Parentheses ('(', ')')surrounding each item.pipe - A pipe ('|') between eachitem.newline - A line break aftereach item."custom" - Any other character


24/94

you wish, specified betweenquotes.injected - (optional) If set totrue, %prefix:key% values willbe injected with report values

before being rendered.

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

Allows a sub-report to becreated from within anotherreport. This reporter willdisplay the contents of any sub-item of the current item,identified using the"prefix:key" value.default/key - (required) the keyvalue to display.source - (optional) The locationto set as the source context. If unspecified, the current reportitem (if in a report) or currentpage/news item will be thecontext.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content mustmatch all criteria.

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

Reports on Confluence Spaces.It must be used in a report of some type (eg. {report-block}) .It will only list spaces visible tothe current user. Also, furtherfiltering can be made byspecifying the 'spaces'parameter, or using customfilters.space(s) - (optional) The list of spaces to search in. Each spacemay be prefixed by either '+' (toindicate the space is required)or '-' (to indicate the space mustbe excluded). Defaults to'@self'. May be one of thefollowing:@self - (default) The space thecurrent content is in.
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblockhttps://wiki.myatos.net/renderer/notationhelp.action#customware-macro-reportblock


25/94

@personal - Personal spacesonly.@global - Global spaces, thatis, non-personal spaces.@all - All spaces, both global

and personalSPACE KEY - Any other spacekey may be specified explicitly.labels - List of label checks. Eg."one, +two, -three" would listcontent which had the "two"label but not the "three" label.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content must

match all criteria.

{content-reporter:space=KEY|types=[page, +news, -comment]|scope=Page [> required scope]|labels=[one,+two, -three]}{xxx-sort:item:key|order=[ascending, descending]}{xxx-filter:item:key|extra parameters go here}{content-reporter}

Reports on Confluence content(pages, news, comments,attachments, etc). The contentcan be filtered by space, type,scope or labels, as well as anycustom filters specified in thebody of the macro.space(s) - (optional) The list of spaces to search in. Each spacemay be prefixed by either '+' (toindicate the space is required)or '-' (to indicate the space mustbe excluded). Defaults to'@self'. May be one of thefollowing:@self - (default) The space thecurrent content is in.@personal - Personal spacesonly.@global - Global spaces, thatis, non-personal spaces.@all - All spaces, both globaland personalSPACE KEY - Any other spacekey may be specified explicitly.type(s) - (optional) The list of content types to allow. Defaultsto allowing all types. Each typemay be prefixed by either a '+'


26/94

(to indicate it is require) or '-'(to indicate it must beexcluded). May be any of thefollowing:page

newscommentattachmentspacedescriptionscope - List of pages, newsitems, etc which are in scope. If the content is a page, the scopecan be expanded to theirchildren, descendents orancestors:>children - The direct children

of the specified page. Eg.'scope=My Page>children'>descendents - All descendentsof the specified page. Eg.'scope="MyPage">descendents'>ancestors - All ancestors of the specified page. Eg.'scope=My Page>ancestors'labels - List of label checks. Eg."one, +two, -three" would list

content which had the "two"label but not the "three" label.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content mustmatch all criteria.

{user-reporter:user=[usernames]|group=[groupnames]|space=SPACEKEY:view/edit/admin/news}{xxx-sort:item:key|order=[ascending, descending]}{xxx-filter:item:key|extra parameters go here}{user-reporter}

Reports on Confluence usersmatching the specified criteria.user(s) - (optional) the (list of)users who can see the content.group(s) - (optional) the (list of)groups who can see the conent.space(s) - (optional) KEY >permission - the (list of) spaceswhere, if the user can view thespace, they can see the content.The permission is optional -view is used by default.


27/94

Otherwise, you may specifyone of the following after the'>'.view - (default) the user canview the space.

edit - the user can edit pages.admin - the user hasadministration access.news - the user can post a newsentry.comment - the user can post acomment.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content must

match all criteria.

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

Reports on the available usergroups in Confluence. This listis only available toadministrators and users whocan create or administratespaces.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content mustmatch all criteria.

{expanding-reporter:prefix:key|as=something}{xxx-reporter}

{xxx-sort:item:key|order=[ascending, descending]}

{xxx-filter:item:key|extra parameters go here}{expanding-reporter}

This macro will expand uponthe selected 'prefix:key' of eachof the result items returned bythe contained reporter. Indatabase query terms, this isessentially a 'join' operation,and is mostly useful for many-to-many relationships. Forexample, a user can be amember of many groups, andeach group can have manyusers as members. If you wishto display a list of all groupsand their members in a singletable, with only one group andone user listed per row, youneed to expand on one or the


28/94

other. You will end up withboth being repeated multipletimes, but such is the nature of the relationship. Using the{user-group-reporter} it would

look something like this:{expanded-reporter:user-group:members|as=member}

{user-group-reporter}{text-sort:user-

group:name}{user-group-reporter}{text-sort:user:name}

{expanded-reporter}

You would then display your

results by doing something likethis:{report-

column:title=GroupName}{report-info:expanded:item >name}{report-column}

{report-column:title=Username}{report-info:expanded:member >name}{report-column}

{report-column:title=Email}{report-info:expanded:member >email|link=true}{report-column}

Note the use of 'expanded:item'and 'expanded:member'.'expanded:item' always referrsto the original item beingexpanded on, in this case the

user group. 'expanded:member'is used because the original{expand-on} macro declaredthat each of the items in 'user-group:members' would beknown as 'member'.Note also that you can specifysort order inside the {expanded-
https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-usergroupreporter%22https://wiki.myatos.net/renderer/notationhelp.action#customware-macro-usergroupreporter%22


29/94

reporter} macro. You can alsoadd any filters you wish to, andthey will only apply to theitems being expanded on.default/key - (required) The key

value to expand on.as - (required) The name to seteach expanded item as whenaccessing it in the report. Maynot be 'item', as this is reservedfor the original item beingexpanded.matchAll - (optional) If set to'false', content matching any of the criteria will be returned.Otherwise, the content must

match all criteria.allowEmpty - (optional)Defaults to false. If set to true,the parent item will still bereturned even if the specifiedkey value is empty.

{combining-reporter}{xxx-reporter}{yyy-reporter}{zzz-reporter}

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

This macro combines two ormore reports into a single set of results for output. The results of the reporter do not have to be of the same type, although sortingand filtering will probably notwork as expected if they arenot.The reporter can contain filterand sort macros. Filters will beapplied on each item from eachreport as it is retrieved from thesub-report. Sorting will be doneon the complete set of resultsafter being filtered andcombined.By default, no uniquenesschecking is done, but you canspecify it with the 'unique'parameter. There will be aperformance penalty for turningthis option on, however. If theset of results is unsorted, onlythe first instance of a value will


30/94


31/94

as '1y 2m 3w 4d 5h 6m 7s'. Tospecify a period in the past,prefix with '-'.format - (optional) If eitherminValue or maxValue are a

specific date, this parametermust also be specified to informthe filter of the date formatused in those parameters. It isnot required for relative dates.required - (optional) If set to'true', the key value must have avalue of some sort - it may notbe empty.

{number-filter:prefix:key|minValue=[number]|maxValue=[number]|decimal=true/false|required=true/false}

This filter will ensure that thespecified 'prefix:key' value is anumber, and that it matches therequired criteria. It must beused in a reporter macro.default/key - (required) The keyvalue to filter on.minValue - (optional) If specified, the number must begreater than or equal to thespecified value.maxValue - (optional) If specified, the number must beless than or equal to thespecified value.decimal - (optional) If specified, setting it to 'true' willrequire that the number is adecimal type, and setting it tofalse will require it is a wholenumber.required - (optional) If set to'true', the key value must have avalue of some sort - it may notbe empty.

{text-filter:prefix:key|minLength=[#]|maxLength=[#]|include=[regexp]|exclude=[regexp]|required=true/false}

This filter will ensure that thespecified 'prefix:key' valuematches the required true/falsevalue. It must be used in areporter macro.default/key - (required) The key


32/94

value to filter on.minLength - (optional) If specified, value must have atleast this many characters.maxLength - (optional) If

specified, the value must haveat most this many characters.include - (optional) If specified,this is a regular expressionspecifying the pattern requiredto be included.exclude - (optional) If specified, this is a regularexpression specifying thepattern required to be excluded.required - (optional) If set to

'true', the key value must have avalue of some sort, either trueor false.

{content-filter:prefix:key|space=[spacekeys]|types=[types]|scope=[pagescopes]|labels=[labels]}

This filter will ensure that thespecified 'prefix:key' valuematches the requiredConfluence content value. Itmust be used in a reportermacro.default/key - (required) The keyvalue to filter on.space(s) - (optional) The list of spaces to search in. Each spacemay be prefixed by either '+' (toindicate the space is required)or '-' (to indicate the space mustbe excluded). Defaults to'@self'. May be one of thefollowing:@self - (default) The space thecurrent content is in.@personal - Personal spacesonly.@global - Global spaces, thatis, non-personal spaces.@all - All spaces, both globaland personalSPACE KEY - Any other spacekey may be specified explicitly.type(s) - (optional) The list of


33/94

content types to allow. Defaultsto allowing all types. Each typemay be prefixed by either a '+'(to indicate it is require) or '-'(to indicate it must be

excluded). May be any of thefollowing:pagenewscommentattachmentspacedescriptionscope - List of pages, newsitems, etc which are in scope. If the content is a page, the scopecan be expanded to their

children, descendents orancestors:>children - The direct childrenof the specified page. Eg.'scope=My Page>children'>descendents - All descendentsof the specified page. Eg.'scope="MyPage">descendents'>ancestors - All ancestors of the specified page. Eg.

'scope=My Page>ancestors'labels - List of label checks. Eg."one, +two, -three" would listcontent which had the "two"label but not the "three" label.matchAll - (optional) If set to'false', content matching any of the criteria will be let through.

{user-filter:prefix:key|user=[user list]|group=[grouplist]|space=[space permission list]}

This filter will ensure that thespecified 'prefix:key' valuematches the requiredConfluence content value. Itmust be used in a reportermacro.default/key - (required) The keyvalue to filter on.user(s) - (optional) The list of users to match. May be '@self'to indicate the currently-


34/94

logged-in user.group(s) - (optional) This list of user groups to match.space(s) - (optional) The list of space keys, followed by an

optional permission type, tomatch against. The form is'SPACEKEY:permission' (e.g.'MYSPACE:edit'). Theavailable permissions to check against are:view - (default) The user canview the space.edit - The user can edit thepages in the space.news - The user can add news

items to the space.comment - The user can addcomments to the space.admin - The user canadminister the space.matchAll - (optional) Defaultsto 'true'. If set to 'false', contentmatching any of the criteria willbe let through.

{collection-filter:prefix:key|matchItems=all/any/none|matchFilters=all/any/none} {xxx-filter:prefix:key} {yyy-filter:prefix:key} {collection-filter}

This filter will check that anycontained filter values exist onall/any/none of the items in thecollection specified by thefilter's "prefix:key" value.Tip: You can use 'collection-filter-1' to 'collection-filter-5' if you need to nest collectionfilters.default/key - (required) The keyvalue to filter on.matchItems - (optional) Definehow many of the collection'sitems can match the sub-filers.Defaults to 'all'. May be one of the following:all - (default) All items mustmatch the sub-filter set.any - At least one item mustmatch the sub-filter set.none - None of the items may


35/94

match the sub-filter set.matchFilters - (optional) Definehow many of the sub-filtersmust match for the item to belet through. May be one of the

following:all - (default) All sub-filtersmust match the item.any - At least one sub-filtermust match the item.none - None of the sub-filtersmay match item.

{repeat-filter:prefix:key|match=[first/repeats]}

This filter checks if the currentvalue is different from theprevious one passed to thefilter. If so, it passes, otherwiseit will fail.default/key - (required) The keyvalue to filter on.match - (optional) Either 'first'(the default) to match only thefirst item or 'repeats' to matchonly the repetitions, not theoriginal value.

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

This will sort the results by thespecified boolean key value. Bydefault, empty values will belisted before false, which willbe before true, using ascendingorder.order - (optional) May be'ascending' or 'descending'.Defaults to ascending.

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

This will sort the results by thespecified date key value. Bydefault, empty values will belisted first, then the rest using

ascending order.order - (optional) May be'ascending' or 'descending'.Defaults to ascending.

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

This will sort the results by thespecified number key value. Bydefault, empty values will belisted first, then the rest using


36/94

ascending order.order - (optional) May be'ascending' or 'descending'.Defaults to ascending.

{text-sort:prefix:key|mode=natural/locale/bitwise|locale=@user/@global/@server/other|order=ascending/descending}

This will sort the results by thespecified text key value. Bydefault, empty values will belisted first, then the rest usingascending order.mode - (optional) May be oneof the following:natural - (default) The text issorted in natural order, takinginto account symbols, numbersand capitalisation. Willrecognise the 'local' parameterlocale - The text is sorted inlocal-specific character order.bitwise - The text is sortedaccording to the bit value of each character.order - (optional) May be'ascending' or 'descending'.Defaults to ascending.locale - (optional) The locale touse when sorting text in either'natural' or 'locale' mode.Defaults to '@user'. May be oneof the following:@user - (default) The currentuser's selected locale. Uses@global if no specific locale isselected by the user.@global - The global defaultlocale for Confluence.@server - The server's defaultlocale (may be different to@global)xx_yy - A standard local value,such as "en_AU" or "de".

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

This will sort the results by thespecified key value.order - (optional) May be'ascending' or 'descending'.Defaults to ascending.


37/94

{widget:url=http://au.youtube.com/watch?v=cOE8ukQo

z6E}{widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E | width=500 | height=400}

Widget Connectorurl - (required) The URL to thewidget you want to display inConfluence{widget:url=http://au.youtube.c

om/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}

{content-by-user:fred}

Displays a simple table of allthe content (pages, comments,blog posts, user profiles andspace descriptions) created by auser (here 'fred').

{index}

Displays an index of all thepages in the current space,cross linked and sortedalphabetically.

{include:Home}

{include:FOO:Home}

{include:spaceKey=FOO|pageTitle=Home}

Includes one page withinanother (this example includesa page called "Home"). Pagesfrom another space can beincluded by prefacing the page

title with a space key and acolon.The user viewing the page musthave permission to view thepage being included, or it willnot be displayed.

{live-template:Template Name}

Imports and executes thespecified template to thecurrent page. This is differentto creating a page using atemplate because it will alwaysdisplay the latest version of thetemplate, rather than copyingthe original version.[default]/name - (required) Thetemplate to import and display.

{get-data:Text Field}Default value{get-data}{get-data:name=Number Field|format=$#,{get-data:A

Displays stored field data.Numbers and dates may be


38/94

Group.Date Field|format=d MMM,yyyy|default=Never}

formatted nicely.[default]/name - (required) Thename of the field. May be a'field path' (e.g. 'GroupName.Field Name')

default - (optional) The defaultvalue to display (rendered aswiki directly) if the field is notset. Alternately, the default canbe set as the body of thismacro.format - (optional) The numberformat (e.g. '#, to use whenparsing the value being set. Theparameter will be ignored fordata types other than 'number'

or 'date'.render - (optional) Defaults to'wiki'. May be set to 'none' todisplay any content unrendered.separator - (optional) If theitem/key points to a list of results, the type of separator todisplay between each item.Defaults to 'comma'. May beone of the following:bracket - Square brackets ('[',

']') surrounding each item.brace - Braces ('{', '}')surrounding each item.comma - A comma (',') betweeneach item.paren - Parenthases ('(', ')')surrounding each item.pipe - A pipe ('|') between eachitem.newline - A line break aftereach item.

"custom" - Any other characteryou wish, specified betweenquotes.

{set-data:Text Field}Default value{set-data}{set-data:Number Field|type=number}123.45{set-data}{set-data:Date Field|type=date|format=d MMM, yyyy}1Jan, 2007{set-data}{set-data:Page Field|type=content|value=My Page

Allows entering of text in asingle- or multiple-line textfield. Must be contained insidea scaffold macro.[default]/name - (required) The
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffold


39/94

Title}{set-data:User Field|type=user|value=administrator}

name of the field.value - (required) The value toset. You can alternatively usethe body of the macro, which isuseful if setting more complex

wiki markup.type - (optional) The type of field to display. May be one of the following:text - (default) Text data.number - An integer or decimalvalue.date - A date.boolean - A true/false value.content - A link to a singleConfluence page/news item.

E.g. 'SPACEKEY:My Page' or just 'My Other Page'.attachment - A link to apage/news item attachment.E.g. '^mypicture.jpg'.user - A link to a registereduser. This is their username, nottheir full name. E.g. 'joebloe' or'administrator'.format - (optional) The numberformat (e.g. '#, to use when

parsing the value being set. Theparameter will be ignored fordata types other than 'number'or 'date'. This is basicallyrequired when the data type is'date', since the default dateformat is unlikely to be usedwhen setting a date.hidden - (optional) When set to'true', the value being set willnot be displayed to the page

viewer.

{group-data:name=My Group}scaffold data{group-data}

Groups the contained datatogether under the specifiedname.[default]/name - (required) Thename of the scaffold.

{text-data:Text Field}Default value{text-data} Allows entering of text in a


40/94

single- or multiple-line textfield. Must be contained insidea scaffold macro.[default]/name - (required) Thename of the field.

type - (optional) The type of field to display. May be one of the following:line - (default) A single-linetext field.password - A single-linepassword field.area - A multi-line text areafield.content - (optional) The type of content in the field. May be one

of the following:wiki - (default) The content iswiki markup.text - The content is plain text.noformat - The content willappear inside a {noformat}section.quote - The content will bequoted.code:language - The contentwill be rendered as code, with

an optional programminglanguage such as Java or XML.E.g. 'content=code:JavaScript'.minLength - (optional) Theminimum number of charactersthat may be entered.maxLength - (optional) Themaximum number of charactersthat may be entered.pattern - (optional) The regularexpression the text must match.

patternInfo - (optional) If thepattern is specified, this isdisplayed if the saved valuedoes not match it.required - (optional) If 'true',the field cannot be empty.

{excerpt-data:Excerpt Field}{excerpt-data} Allows editing of page'sexcerpt text via a text field. All


41/94

the options for {text-data} willwork here. Must be containedinside a scaffold macro.

{number-data:Number Field}0{number-data}

Allows entering of a wholenumber value (eg 1, 4000).Must be contained inside ascaffold macro.[default]/name - (required) Thename of the field.type - (optional) The type of field to display. May be one of the following:line - (default) A single-linenumber field.select - A single-selection drop-down list box. Note: this typerequires that there is amaximum range of 1000between the min-value andmax-value.decimal - (optional) If 'true', thefield will allow decimal valuesto be entered. Warning:Decimals are by their natureimprecise, and may result insome arithmatic errors at times.Only use them if necessary, anddon't expect min-value andmax-value to always be preciseas boundaries.minValue - (optional) Theminimum value the numbermay be (inclusive).maxValue - (optional) Themaximum value the numbermay be (inclusive).step - (optional) The amounteach option should step when in'select' mode. Eg. a step of 2will produce options 1, 3, 5,etc. Defaults to 1.format - (optional) The formatthe number should be output inwhen not being edited. See

java.text.DecimalFormat fordetails.
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-textdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttp://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.htmlhttp://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.htmlhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-textdata


42/94

required - (optional) If 'true',the field cannot be empty.

{eval-data:Evaluated Field} ${Foo} + ${Bar} {eval-data} {eval-data:Evaluated Field} round(${Foo} / ${Bar}, 2) {eval-data}

Evaluates mathematicalequations, optionally usingvalues from other field data inthe same scaffold. Other fieldscan be referenced by puttingthem inside '${}' markers. Theexamples to the left add anddivide the current values of the'Foo' and 'Bar' fields,respectively. Must be containedinside a scaffold macro.Parameters[default]/name - (required) Thename of the field.format - (optional) The formatthe number should be output inwhen not being edited. See

java.text.DecimalFormat fordetails.Functionsround([number], [places]) -Rounds the number to thespecified number of decimalplaces. Eg: round(1.4634, 2)rounds to 1.46.sumtable([table], [column]) -Sums the values of thespecified column in thespecified table. Eg:sumtable("My Table", "NumberColumn").avgtable([table], [column]) -Averages the values of thespecified column in thespecified table. Eg:avgtable("My Table", "NumberColumn").

{date-data:List Field|format=dd-MMMM-yyyy}

Allows editing of date field.Must be contained inside ascaffold macro.[default]/name - (required) Thename of the field.format - (required) The format
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttp://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.htmlhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttp://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.htmlhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffold


43/94

of the date content. Maycontain any of the followingspecial 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').minYear - (optional) The

minimum year that is allowed.May be absolute (eg. '1980') orrelative to the current year (eg.'-5'). Defaults to '-10'.

maxYear - (optional) Themaximum year that is allowed.May be absolute (eg. '2020') orrelative to the current year (eg.

'+15'). Defaults to '+10'.required - (optional) If 'true',the field cannot be empty.

{repeating-data:RepeatingData|order=desc|initialRows=5}Something: {text-data:Something}{text-data}Something Else: {number-data:SomethingElse}{number-data} {repeating-data}

Defines a repeating section.The contents of the macro willbe repeated 0-n times,depending how many havebeen added in edit mode. Mustbe contained inside a scaffoldmacro.[default]/name - (required) Thename of the field.order - (optional) If set to 'desc',the rows will list from bottomto top.initialRows - (optional) Thenumber of times the sectionshould be repeated initially.


44/94

{table-data:Editable Table}|| Name || Value || Expires || | {text-data:Name} |{number-data:Value} | {data-data:Expires|format=dd-MMM-yyyy} | {table-data}

Defines an editable table.Should contain a single headerrow ('||') and a single data row('|'). The header row will bedisplayed once at the start of

the table. The data row will berepeated for each row in thetable. Make sure there arespaces around the '|' charactersmarking table cell boundaries.Must be contained inside ascaffold macro.[default]/name - (required) Thename of the field.order - (optional) If set to 'desc',the rows will list from bottom

to top.initialRows - (optional) Thenumber of times the sectionshould be repeated initially.

{list-data:List Field}{list-option:Label}Value{list-option}{list-data}

Allows selecting one or moreoptions. Must be containedinside a scaffold macro.[default]/name - (required) Thename of the field.type - (optional) The type of field to display. May be one of the following:select - (default) A selectablelist is displayed.check - A list of checkableitems are displayed.

maxResults - (optional) Themaximum number of itemswhich will be in the list.

required - (optional) If 'true',a non-empty item must beselected. Defaults to 'false'.

blank - (optional) If 'true', ablank item is added to the list.Only applies to select lists.

blankText - (optional) Thetext to put in the blank option,if it is enabled.

multiple - (optional) If 'true',multiple options may be
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffold


45/94

selected.width - (optional) The width

of the field. Any CSS width isallowed. Note: Only applieswhen type is 'select'.

height - (optional) Theheight of the field. Any CSSheight is allowed. Note: Onlyapplies when type is 'select'.

separator - (optional) If multiple items are selected, thetype of separator to displaybetween each item. Defaults toone item per line. May be oneof the following:bracket - Square brackets ('[',

']') surrounding each item.brace - Braces ('{', '}')surrounding each item.comma - A comma (',') betweeneach item.paren - Parentheses ('(', ')')surrounding each item.pipe - A pipe ('|') between eachitem.newline - A line break aftereach item.

"custom" - Any other characteryou wish, specified betweenquotes.

{list-option:Label}*Wiki Text*{list-option}

Defines a simple option for alist. Must be contained inside alist-data macro.[default] - (required) The non-wiki label for the option.

{content-options:parent=A Page}

Creates a set of list optionslinking to content matching thefilter options. Must becontained inside a list-datamacro.parent - (optional) Onlyimmediate children of thespecified page will be listed.ancestor - (optional) Anydecendent of the specified page
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdata


46/94

will be listed.spaces - (optional) Only listspages from the specified list of spaces.branches - (optional) Specifies

the type of pages that will belisted. May be one of:all - All page types arereturned.parents - Only pages withchildren are listed.children - Only pages with nochildren are listed.

labels - (optional) Only listpages which contain (or do notcontain) certain labels

{attachment-options:content=A Page}

Creates a set of list optionslinking to the attachments onthe specified content the filteroptions. Must be containedinside a list-data macro.content - (optional) If specified,the page or other content thefiles are attached to. Defaults tothe current page.include - (optional) A regularexpression specifying whichfile names to include. E.g.".*gif" for all GIF files.exclude - (optional) A regularexpression specifying whichfile names to exclude. E.g.".*zip" for all ZIP files.

{user-options:groups=a-user-group}

Creates a set of list optionslinking to users matching thefilter options. Must becontained inside a list-datamacro.groups - (optional) Only usersin the specified groups will belisted.spaces - (optional) Only userswith the required access to thespecified spaces will be listed.Permissions can be specified
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdata


47/94

for each space. Eg:SPACEKEY:view - (default)Only users with view access tothe SPACEKEY will be listed.SPACEKEY:edit - Only users

with edit access to the spacewill be listed.SPACEKEY:admin - Onlyusers with administrationaccess to the space will belisted.SPACEKEY:blog - Only userswho can post a blog (aka News)message will be listed.users - (optional) Only usersspecified will be listed.

match - (optional) If set to 'all',the user must match all settingsspecified. Defaults to 'any'.

{label-options:label1, label2, label3}

Creates a list of labels to attachto the current page. Must becontained inside a list-datamacro.(default)/names - The list of labels which are available toselect.

{hidden-data}Only visible when editing: {number-data:MyNumber}{number-data}{hidden-data}

{hidden-data:whenEmpty=My Number}Only visible when a number is set: {number-data:MyNumber}{number-data}{hidden-data}

Hides its contents whenviewing a page, but reveils itwhen editing. Must becontained inside a scaffoldmacro.whenEmpty - (optional) If present, the field valuespecified will be checked, andthe contents of this hidden-datamacro will be hidden if thefield is empty.whenNotEmpty - (optional) If present, the field valuespecified will be checked, andthe contents of this hidden-datamacro will be hidden if thefield is not empty.whenHasRows - (optional) If present, the table/repeation
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-scaffoldhttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdata


48/94

section specified will bechecked, and the contents of this hidden-data macro will behidden if it has any rows.whenNoRows - (optional) If

present, the table/repeationsection specified will bechecked, and the contents of this hidden-data macro will behidden if it has no rows.

{attachment-data:Field Name|include=.*jpg,.*gif}

Creates a set of list optionslinking to the attachments onthe specified content the filteroptions. Must be containedinside a list-data macro.[default]/name - The name of the field.include - (optional) A regularexpression specifying whichfile names to include. E.g.".*gif" for all GIF files.exclude - (optional) A regularexpression specifying whichfile names to exclude. E.g.".*zip" for all ZIP files.

{note:title=Be Careful}The body of the note here..{note}

Prints a simple note to the user.title: - (optional) the title of thenote.icon: - (optional) if "false", dontdisplay the icon.

Be Careful

The body of the notehere..

{warning:title=Warning}Insert warning message here!{warning}

Prints a warning note to theuser.title: - (optional) the title of thewarning.icon: - (optional) if "false", dontdisplay the icon.

Warning

Insert warningmessage here!
https://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdatahttps://wiki.myatos.net/renderer/notationhelp.action#randombits-macro-listdata


49/94

{info:title=Be Careful}

This macro is useful for including helpful informationin your confluence pages{info}

Prints an informational note.title: - (optional) the title of theinformation box.icon: - (optional) if "false", dontdisplay the icon.

Useful Information

This macro is usefulfor including helpfulinformation in yourconfluence pages

{tip:title=Handy Hint}

Join the Confluence Mailing-List!{tip}

Prints a helpful tip for the user.title: - (optional) the title of thetip.icon: - (optional) if "false", dontdisplay the icon.

Handy Hint

Join the ConfluenceMailing-List!

{noformat}

preformatted piece of textso *no* further _formatting_ is done here{noformat}

Makes a preformatted block of text with no syntaxhighlighting. All the optionalparameters of {panel} macroare valid for {noformat} too.nopanel: If the value of "nopanel" is true, then theexcerpt will be drawn withoutits surrounding panel.Example:preformatted piece of textso *no* further _formatting_ isdone here

{panel}Some text{panel}

{panel:title=My Title}Some text with a title{panel}

{panel:title=My Title| borderStyle=dashed|borderColor=#ccc| titleBGColor=#F7D6C1|bgColor=#FFFFCE}a block of text surrounded with a *panel*yet _another_ line{panel}

Embraces a block of text withina fully customizable panel. Theoptional parameters you candefine are the following ones:title: Title of the panelborderStyle: The style of theborder this panel uses (solid,dashed and other valid CSSborder styles)borderColor: The color of theborder this panel uses


50/94

borderWidth: The width of theborder this panel usesbgColor: The background colorof this paneltitleBGColor: The background

color of the title section of thispanelExample:My Titlea block of text surrounded witha panelyet another line

Confluence ContentWays to include, summarise or refer to other Confluence content.Notation Comment

!quicktime.mov!

!spaceKey:pageTitle^attachment.mov!

!quicktime.mov|width=300,height=400!

!media.wmv|id=media!

Embeds an object in a page,taking in a comma-separated of properties.

Default supported formats:Flash (.swf)Quicktime movies (.mov)Windows Media (.wma, .wmv)Real Media (.rm, .ram)MP3 files (.mp3)

Other types of files can be used,but may require the specificationof the "classid", "codebase" and"pluginspage" properties in orderto be recognised by web browsers.

Common properties are:width - the width of the media fileheight - the height of the mediafileid - the ID assigned to theembedded object

Due to security issues, fileslocated on remote servers are notpermittedStylingBy default, each embedded objectis wrapped in a "div" tag. If you


51/94

wish to style the div and itscontents, override the"embeddedObject" CSS class.Specifying an ID as a propertyalso allows you to style different

embedded objects differently. CSSclass names in the format"embeddedObject-ID" are used.

{attachments:patterns=.*doc|old=true}

Prints a list of attachmentspatterns: - (optional) a commaseparated list of regularexpressions. Only file namesmatching one of these aredisplayed.old: - (optional) if "true", displayold versions of attachments aswell.upload: - (optional) if "true",allow the upload of newattachments.

{bookmarks}

Displays a list of bookmarks usingthe criteria supplied.Searching Optionsspaces comma separated list of spaces to search for. Meta spacenames @all, @personal, @globalcan also be used. (If no labels andspaces are supplied will default tocurrent space.)labels list of labels that are appliedto the bookmarks. (If multiplelabels are specified bookmarksonly have to match one label to beincluded.)creators comma separated list of users that have createdbookmarks.Sorting Optionssort comma separated list of attributes to sort the bookmarksby. Valid values are:creation Bookmark Created Datecreator Bookmark Creator Nametitle Bookmark titleDefault is by created date.


52/94

reverseSort Reverse the order of the bookmarks. Default is false.Display Options All optionsdefault to true.showAuthor The user that created

the bookmark.showDate The relative date thebookmark was created.showDescription The bookmark description.showEditLinks If the current userhas permission, show quick linksto edit or remove the bookmark.showLabels The labels for thebookmark.showListHeader The bookmark

list header (with the rss feed link).max The maximum number of bookmarks to display. Defaults to15.showSpace The space thebookmark is saved inshowViewLink A link to theactual bookmark page

{pagetree}{pagetree:root=PageName}{pagetree:root=PageName|sort=natural|excerpt=true|reverse=false}{pagetree:root=@home|startDepth=3}{pagetree:searchBox=true}{pagetree:expandCollapseAll=true}

Provides page hierachal treewithin a space. If no parametersare specified the root of the treewill be the home page, a differentroot page can be specified byproviding the page to the rootparameter.root: - (optional) page where thetree would be rooted from. Metaroot names @self, @parent,@home can also be used.sort: - (optional) sorts the treenode. It my be one of thefollowing: bitwise, creation,modified, natural, position.Default sorting is positionexcerpt: - (optional) true/false flagthat indicate if a page excerptwould be included in the treedisplay (default is false).reverse: - (optional) true/false flagthat allows you to reverse the


53/94

order of the display (default isfalse).searchBox: - (optional) true/falseflag that allows you to add asearch box in the tree that would

search from the root page (defaultis false).expandCollapseAll: - (optional)true/false flag that allows you toadd an expand all and a collapseall row (default is false).startDepth: - (optional) a numberthat indicates the initial depth thatthe tree would display (defaultvalue is 1).

{pagetreesearch}{pagetreesearch:rootPage=PageName}{pagetreesearch:rootPage=Space:PageName}

Provides a search box to search apage hierachal tree within a space.If no parameters are specified theroot of the tree will be the currentpage, a different root page can bespecified by providing the page tothe rootPage parameter.

{toc:style=disc|indent=20px}{toc:outline=true|indent=0px|minLevel=2}{toc:type=flat|separator=pipe|maxLevel=3}

Creates a Table of Contents forheadings on the the current page.type - (optional) The type of output. May be one of thefollowing:list - (default) The headings areoutput in hierarchical list format.flat - The headings are listed on asingle line with a separatorbetween them.class - (optional) If specified, theTOC will be output with thespecified CSS class. Also, if set,no other style values will beoutput.style - (optional) The style of thelist items if in list mode. The stylemay be any of the following:none - (default) Headings areoutput in indented lists with nobullet points or numbers prefixingthem.any CSS style - Headings are


54/94

output in indented lists with thespecified CSS style.outline - (optional) If set to true,each item will be prefixed with anumber in the format 'X.Y'. The

numbers will increaseautomatically, and extra levelswill be added for lower-levelheadings.ident - (optional) The amount toindent each list sub-heading by(default is '10px').separator - (optional) The type of separator to use if the style is flat.May be one of the following:bracket - Square brackets ('[', ']')

surrounding each item. (default)brace - Square brackets ('[', ']')surrounding each item. (default)comma - A comma (',') betweeneach item.paren - Parentheses ('(', ')')surrounding each item.pipe - A pipe ('|') between eachitem.newline - A line break after eachitem.

"custom" - Any other characteryou wish, specified betweenquotes.minLevel - (optional) The lowestheading level to include(inclusive). (default is 1).maxLevel - (optional) The highestheading level to include(inclusive). (default is 7).include - (optional) If set, anyheadings not matching the regular

expression will be ignored. Due to'|' being the parameter separator inmacros, use ',' where you wouldhave usually used '|'.exclude - (optional) If set, anyheadings matching the regularexpression will be excluded. Dueto '|' being the parameter separator


55/94

in macros, use ',' where you wouldhave usually used '|

wiki notation guide

Documents