Archive
Posts Tagged ‘Wiki’
Confluence Macro Quick Reference
September 2, 2009
5 comments
Below is the complete list of macros supported by Confluence 3.0.0, with usage and link to documentation. The list can also be downloaded as a PDF reference card – Confluence Reference Card.
Macro Name | Description | Usage | |
---|---|---|---|
1. | Anchor | Creates an anchor inside the page, which can be hyperlinked |
{anchor:anchorname} |
2. | Blog Posts | Lists the most recent news items in the space |
{blog-posts: time=24h} |
3. | Attachments | Creates a list of attachments belonging to this page |
{attachments: patterns=.*jpg| old=true| sortBy=size| upload=true} |
4. | Bookmarks | Includes a list of bookmarks on a Confluence page |
{bookmarks: spaces=spacename| labels=labelname| creators=admin| reverseSort=true| showAuthor=false| showDate=false| showDescription=false| showEditLinks=false| showLabels=false| showListHeader=false| showSpace=false| showViewLink=false} |
5. | Change History | Shows the history of version comments for the current page or news item |
{change-history} |
6. | Chart | Displays a chart using data from the supplied table or tables |
{chart:type=bar| title=charttitle| xLabel=x-axislabel| yLabel=y-axislabel| legend=false| orientation=horizontal| 3D=true| width=400| height=400| colors=red,green| rangeAxisLowerBound=0| rangeAxisUpperBound=400| dataOrientation=vertical} | col 1 | col 2| col 3| | row 1 | 10 | 20 | 30 | | row 2 | 100 | 200 | 300 | {chart} |
7. | Cheese | Inserts the text ‘I like cheese!’, used for testing macro functionality |
{cheese} |
8. | Children Display | Lists a page’s children and their descendant pages |
{children: all=true| page=parentpage| first=10| depth=5| style=h1| excerpt=true| sort=creation| reverse=true} |
9. | Code Block | Displays source code in your page with the appropriate syntax highlighting |
{code: lang=java| title=title| borderStyle=solid| borderColor=bordercolour| borderWidth=2| bgColor=white| titleBGColor=grey} /*String Test*/ System.out.println("abc"); String cde = "cde"; System.out.println("abc" + cde); {code} |
10. | Colour Text | Change the colour of a block of text |
{color:red} This is block text in RED {color} |
11. | Column | Defines a column on the page. (Must be used within a Section macro.) |
{section: border=true} This is a section {column:width=25%} Column1 content {column} {column:width=75%} Column2 Content {column} {section} |
12. | Content by Label | Lists pages tagged with one or more specific labels |
{contentbylabel: labels=labelname| type=page,comment| showLabels=false| showSpace=false| title=listtitle| max=20|excerpt=true| spaces=spacename| sort=creation| reverse=true} |
13. | Content by User | Lists pages created by a particular user |
{content-by-user: username} |
14. | Contributors | Displays a list of contributors to a page, its hierarchy or selected spaces, or watches of these pages |
{contributors: include=authors| order=name| reverse=true| limit=3| mode=list| showAnonymous=true| showCount=true| showLastTime=true| page=pagename| labels=labelname| spaces=spacename| contentType=pages| publishDate=2009/09/01} |
15. | Contributors Summary | Displays a summary of contributions to a page, its hierarchy or selected spaces, in tabular form |
{contributors-summary: groupby=pages| order=name| reverse=true| limit=5| showAnonymous=true| showZeroCounts=true| labels=labelname} |
16. | Create Space Button | Displays a create space icon that links to the create space page |
{create-space-button: size=small} |
17. | Documentation Link | Links to documentation on http://confluence.atlassian.com/ |
[Atlassian Support| http://confluence. atlassian.com/display/CONFEXT] |
18. | Edit in Word Link | Display an Edit in Word icon link on your page |
{editinwordlink} |
19. | Excerpt | Marks part of the page’s content for use by other macros |
{excerpt:hidden=true} This excerpt can be reused {excerpt} |
20. | Excerpt Include | Displays the excerpted contents from another page within the same space |
{excerpt-include: pagename| nopanel=true} |
21. | Favourite Pages | Lists your favourite pages |
{favpages: maxResults=10} |
22. | Gallery | Creates a thumbnail gallery from a page’s attachments |
{gallery: title=gallerytitle| exclude=imagetoexclude.png| include=imagetoinclude.png| page=spacekey:pagetitle| sort=name| reverseSort=true} |
23. | Global Reports | Displays a list of links to global reports |
{global-reports: width=50%} bodytext {global-reports} |
24. | IM Presence | Displays a graphic indicating if a contact is signed into their Instant Messenger service |
{im:skypeid| service=skype} |
25. | Include Page | Includes the contents of a page within another. |
{include: spacekey:pagename} |
26. | Info | Highlights content as an informational note with a blue background |
{info: title=infotitle} This is an information {info} |
27. | JIRA Issues | Displays a list of issues from a JIRA site on your Confluence page |
{jiraissues: url=http://jiraurl| columns=type,summary| count=true| cache=off| anonymous=true| title=title| renderMode=static} |
28. | JIRA Portlet | Displays a JIRA dashboard portlet on your Confluence page |
{jiraportlet: url=http://jiraportleturl| anonymous=true| baseurl=http://baseurl} |
29. | JUnit Report | Displays the results of JUnit tests. JUnit is a unit testing framework for Java |
{junitreport: url=http://junitxmlurl| directory=file:///path| reportdetail=summary| debug=true} |
30. | Labels List | Lists all labels of a space, grouped alphabetically |
{listlabels: spaceKey=spacekey} |
31. | Livesearch | Embeds a search box into your Confluence page to show search results as you type |
{livesearch:id=id| spaceKey=spacekey} |
32. | Loremipsum | Displays paragraphs of pseudo-Latin (space-filler) text |
{loremipsum:5} |
33. | Metadata | Embeds metadata into pages and blog posts for presentation with the ‘Metadata Summary’ macro |
{details: label=metalabel}authorname date{details} |
34. | Metadata Summary | Shows a tabulated report of metadata created with the ‘Metadata’ macro |
{detailssummary: label=metalabel} |
35. | Navigation Map | Creates a map of pages associated with a specified label |
{navmap:label| title=maptitle| wrapAfter=10| cellWidth=100px| cellHeight=80px| theme=navmap-mytheme.vm} |
36. | Network | Displays the network of a user |
{network:followers| username=username| theme=full| max=10} |
37. | No Format | Displays text in monospace font within a panel, with no other formatting applied. |
\{noformat: nopanel=true} Unformatted text \{noformat} |
38. | No Link | Displays a web address or URL without hyperlinking to the URL |
{nolink: http://url} |
39. | Note | Highlights content as a note with a yellow background |
{note} This is a note {note} |
40. | Office Excel | Embeds an Office Excel document (.xls) into your Confluence page |
{{viewxls: page=pagename| name=office.xls| date=mm/dd/yyy| space=spacekey| grid=false| sheet=worksheetname| row=2| col=2} |
41. | Office Powerpoint | Embeds an Office Powerpoint document (.ppt) into your Confluence page |
{viewppt: page=pagename| name=office.ppt| date=mm/dd/yyyy| space=spacekey| slide=2| height=50%| width=50%} |
42. | Office Word | Embeds an Office Word document (.doc) file into your Confluence page |
{viewdoc: page=pagename| name=office.doc| date=mm/dd/yyyy| space=spacekey} |
43. | Page Index | Creates an index of all pages within the spac |
{index} |
44. | Page Tree | Displays a dynamic, hierarchical list of pages starting from a specified parent (root) page |
{pagetree:root=rootpage| sort=creation| excerpt=true| reverse=true| searchBox=true| expandCollapseAll=true| startDepth=4} |
45. | Page Tree Search | Provides a search box that searches a hierarchy of pages (Page Tree) from a specified root page. |
{pagetreesearch: rootPage=rootpage} |
46. | Panel | Displays a block of text within a customisable panel. |
{panel: title=paneltitle| borderStyle=solid| borderColor=red| borderWidth=2| bgColor=yellow| titleBGColor=blue} body text {panel} |
47. | Popular Labels | Generates a list or ‘heatmap’ of the most popular labels |
{popular-labels: count=50| spaceKey=spacekey| style=heatmap} |
48. | Quote | Formats a block of text consisting of one or more paragraphs into a quote |
{quote} some quote {quote} |
49. | Recently Updated | Lists the most recently changed content within Confluence |
{recently-updated: author=username| spaces=spacekey| labels=label| width=75%| types=page,comment| max=20| theme=concise| showProfilePic=true| sort=title| reverse=true} |
50. | Recently Updated Dashboard | Lists the most recently changed Confluence content in a dashboard view style |
{recently-updated-dashboard: spaces=spacekey| types=page,comment| labels=label| width=75%| showProfilePic=true} |
51. | Recently Used Labels | Lists the most recently used labels in a predefined scope of spaces |
{recently-used-labels: count=15| scope=space| style=table| title=tabletitle} |
52. | Related Labels | Lists all tagged labels from every page that has labels in common with the current page |
{related-labels: labels=label} |
53. | RSS Feed | Embeds an RSS feed on a page and displays the contents of external or internal Confluence feeds |
{rss:url=rssfeedurl| max=20| showTitlesOnly=true| titleBar=false} |
54. | Search Results | Searches your Confluence site based on specified terms and displays the results on the page |
{search: query=term| maxLimit=10| spacekey=spacekey| type=page| lastModified=24h| contributor=username} |
55. | Section | Defines a section on a page, which can contain one or more Column macros |
{section: border=true} This is a section {section} |
56. | Space Details | Displays a table containing information about the current space |
{space-details: width=75%} |
57. | Spacebookmarkslink | A macro that generates the links in the information panel in the .bookmarks page |
{spacebookmarkslink: spacebookmarkslink} body text {spacebookmarkslink} |
58. | Spaces List | Displays a list of spaces witin the page. |
{spaces:team| width=75%} |
59. | Table of Content Zone | Generates a table of contents based on the headings present within its body text zone |
{toc-zone: location=bottom| type=flat| style=circle| indent=10px| separator=braces| minLevel=2| maxLevel=6| include=.*\.[1//2]| exclude=.*\.[1//2]| printable=false| class=classname} h2. Heading 1 Body1 h2. Heading 2 Body2 {toc-zone} |
60. | Table of Contents | Generates a hyperlinked table of contents based on the headings present in the current page. |
{toc:type=flat| outline=true| style=circle| indent=10px| separator=braces| minLevel=2| maxLevel=6| include=.*\.[1//2]| exclude=.*\.[1//2]| printable=false| class=clas |
61. | Tasklist | Displays a modifiable and interactive task list. |
{tasklist: title} tasklist {tasklist} |
62. | Tip | Highlights content as a helpful tip with a green background |
{tip: title=title} Some tip {tip} |
63. | User List | Displays a list of Confluence users based on group membership |
{userlister: groups=*| online=false} |
64. | User Profile | Displays a user’s profile details |
{profile: user=username} |
65. | User Status List | Displays a list of statuses for a user |
{status-list: username=username} |
66. | View PDF | Embeds a PDF document (.pdf) into your Confluence page |
{viewpdf: page=pagename| name=document.pdf| date=mm/dd/yyyy| space=spacekey} |
67. | Warning | Highlights content as a warning note with a red background |
{warning: title=title} This is a warning {warning} |
68. | Widget Connector | Embed multi-media content from other web sites into your Confluence page |
{widget: url=http://widgeturl| width=200| height=400} |