Documentation for Confluence 5.8 Confluence 5.8 Documentation 2

Contents

Confluence User's Guide ...... 6 Getting Started with Confluence ...... 9 Dashboard ...... 9 Using Confluence on a Mobile Device ...... 11 Keyboard Shortcuts ...... 13 Spaces ...... 17 Create a Space ...... 18 Create a Personal Space ...... 20 Space Permissions Overview ...... 21 Assign Space Permissions ...... 22 Change the Look and Feel of a Space ...... 25 Change the Space Logo ...... 25 Applying a Theme to a Space ...... 26 Using the Documentation Theme ...... 28 Configuring the Documentation Theme ...... 31 Editing a Space's Colour Scheme ...... 42 Administering a Space ...... 45 Configure the Sidebar ...... 47 Edit Space Details ...... 48 Using Labels to Categorise Spaces ...... 49 Delete a Space ...... 50 Archive a Space ...... 51 View Space Activity ...... 52 View Recently Updated Content ...... 53 Customising Space Layouts ...... 53 Exporting Content to Word, PDF, HTML and XML ...... 55 Customising Exports to PDF ...... 56 Advanced PDF Export Customisations ...... 63 Creating PDF in Another Language ...... 67 Pages and Blogs ...... 68 Create and Edit Pages ...... 68 Blog Posts ...... 71 Using the Editor ...... 73 Using Symbols, Emoticons and Special Characters ...... 76 Move and Reorder Pages ...... 77 Copy a Page ...... 79 Delete or Restore a Page ...... 80 Add, Remove and Search for Labels ...... 81 Displaying Pages with Label Macros ...... 84 Working with Drafts ...... 85 Concurrent Editing and Merging Changes ...... 86 Page Restrictions ...... 87 Working with Links ...... 90 Working with Anchors ...... 95 Working with Tables ...... 97 Add, Assign, and View Tasks ...... 102 Using Autocomplete ...... 104 Working with Page Layouts and Columns and Sections ...... 109 Creating Beautiful and Dynamic Pages ...... 112 Working with Templates ...... 114 Creating a Template ...... 116 Creating a Page using a Template ...... 121 Working with Blueprints ...... 123 Decisions Blueprint ...... 127 File List Blueprint ...... 130 Meeting Notes Blueprint ...... 132

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 3

Product Requirements Blueprint ...... 134 Shared Links Blueprint ...... 136 JIRA Report Blueprint ...... 137 Retrospectives Blueprint ...... 140 Creating a Blueprint-Style Report ...... 142 Importing Content Into Confluence ...... 148 Importing Content from Another Wiki ...... 149 Importing Pages from Disk ...... 149 Importing a Word Document into Confluence ...... 150 Orphaned Pages ...... 152 Undefined Page Links ...... 153 View Page Information ...... 153 Page History and Page Comparison Views ...... 156 Working with Confluence Markup ...... 159 Confluence Storage Format ...... 159 Confluence Wiki Markup ...... 172 Files ...... 180 Uploading Files ...... 181 Displaying Files and Images ...... 182 Managing Files ...... 185 Collaborating on Files ...... 187 Editing Office Files ...... 189 Office Connector Prerequisites ...... 190 Installing the Firefox Add-On for the Office Connector ...... 192 Macros ...... 196 Activity Stream Macro ...... 198 Anchor Macro ...... 198 Attachments Macro ...... 199 Blog Posts Macro ...... 202 Change-History Macro ...... 205 Chart Macro ...... 206 Confluence Storage Format Examples for Chart Macro ...... 224 Wiki Markup Examples for Chart Macro ...... 242 Cheese Macro ...... 248 Children Display Macro ...... 249 Child Page 1 ...... 251 Grandchild ...... 251 Child Page 2 ...... 251 Code Block Macro ...... 251 Column Macro ...... 254 Content by Label Macro ...... 255 Content by User Macro ...... 258 Content Report Table Macro ...... 259 Contributors Macro ...... 261 Contributors Summary Macro ...... 264 Create from Template Macro ...... 268 Create Space Button Macro ...... 270 Excerpt Include Macro ...... 271 Excerpt Macro ...... 273 Expand Macro ...... 274 Favourite Pages Macro ...... 276 Gadget Macro ...... 276 Gallery Macro ...... 279 Global Reports Macro ...... 282 HTML Include Macro ...... 283 HTML Macro ...... 285 IM Presence Macro ...... 286 Include Page Macro ...... 287 Sample Include Page ...... 288 Info, Tip, Note, and Warning Macros ...... 289 JIRA Issues Macro ...... 291 JUnit Report Macro ...... 298

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 4

Labels List Macro ...... 300 Livesearch Macro ...... 301 Loremipsum Macro ...... 302 Multimedia Macro ...... 303 Navigation Map Macro ...... 305 Network Macro ...... 306 Noformat Macro ...... 308 Office Excel Macro ...... 309 Office PowerPoint Macro ...... 310 Office Word Macro ...... 311 Page Index Macro ...... 312 Page Properties Macro ...... 313 Page Properties Report Macro ...... 315 Page Tree Macro ...... 319 Sample Page Tree ...... 321 Another Sample Page Tree ...... 321 Sample Page Tree 2 ...... 322 Page Tree Search Macro ...... 322 Panel Macro ...... 323 PDF Macro ...... 324 Popular Labels Macro ...... 325 Profile Picture Macro ...... 326 Recently Updated Dashboard Macro ...... 327 Recently Updated Macro ...... 328 Recently Used Labels Macro ...... 331 Related Labels Macro ...... 333 Roadmap Planner Macro ...... 333 RSS Feed Macro ...... 335 Search Results Macro ...... 337 Section Macro ...... 339 Space Attachments Macro ...... 340 Space Details Macro ...... 342 Space Jump Macro ...... 343 Spaces List Macro ...... 345 Status Macro ...... 346 Table of Contents Macro ...... 347 Table of Content Zone Macro ...... 351 User List Macro ...... 355 User Profile Macro ...... 356 User Status List Macro ...... 357 View File Macro ...... 358 Widget Connector Macro ...... 360 Task Report Macro ...... 364 JIRA Chart Macro ...... 366 Collaboration ...... 368 Network Overview ...... 368 Likes and Popular Content ...... 370 User Status Updates ...... 371 Using Mentions ...... 372 Share a Page or Blog Post ...... 373 Commenting on pages and blog posts ...... 374 Watch Pages, Spaces and Blogs ...... 375 Managing Watchers ...... 378 Email Notifications ...... 378 Subscribing to RSS Feeds within Confluence ...... 381 Using pre-specified RSS feeds ...... 382 Using the RSS Feed Builder ...... 383 Subscribing to a Network RSS Feed ...... 385 Workbox Notifications ...... 386 Your Confluence ...... 388 Your User Profile ...... 389 Change Your Password ...... 391

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 5

Edit Your User Settings ...... 391 Set Your Profile Picture ...... 395 Choose Your Home Page ...... 396 Favourite Spaces and Pages ...... 397 View and Revoke OAuth Access Tokens ...... 398 Search ...... 400 Confluence Search Syntax ...... 404 Confluence Search Fields ...... 408 Searching the People Directory ...... 411 Recently Viewed Pages and Blog Posts ...... 413 Permissions and Restrictions ...... 415 Confluence Groups ...... 416 Add-ons and Integrations ...... 417 Use JIRA and Confluence together ...... 417 Use JIRA Agile and Confluence together ...... 420 Using HipChat and Confluence together ...... 421 Request Add-ons ...... 422 Using a WebDAV Client to Work with Pages ...... 423 Working with Mail Archives ...... 424 Adding a Mail Account ...... 426 Delete and Restore Mail ...... 428 Import Mail from an mbox ...... 429 Working with Confluence Gadgets ...... 430 Adding a Confluence Gadget to a JIRA Dashboard ...... 431 Configuring Confluence Gadgets for Use in Other Applications ...... 435 Confluence Gadgets ...... 439 Activity Stream Gadget ...... 441 Confluence News Gadget ...... 442 Confluence Page Gadget ...... 442 Confluence Quicknav Gadget ...... 445 Adding JIRA Gadgets to a Confluence Page ...... 446 Advanced and Special Uses of Confluence ...... 446 Develop Technical Documentation in Confluence ...... 446 Using Confluence as a Knowledge Base ...... 452 Use Confluence as your Intranet ...... 454

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 6

Confluence User's Guide About the Confluence User's Guide

This guide covers features and functions that are available to Confluence users and space administrators. For information on administering your Confluence site, including customising your site, refer to the Confluenc e Administrator's Guide. This guide assumes that you are using the Confluence default theme. If your Confluence site has been customised the header may look different, and menu items appear in different locations to the examples given in this guide. Getting Started with Confluence Dashboard Using Confluence on a Mobile Device Downloads Keyboard Shortcuts Spaces Create a Space Download the Confluence documentation Create a Personal Space in PDF format. Space Permissions Overview Change the Look and Feel of a Space Administering a Space Other Resources Configure the Sidebar Edit Space Details Confluence Administrator's Guide Using Labels to Categorise Spaces Delete a Space Confluence Knowledge Base Archive a Space Atlassian Answers View Space Activity View Recently Updated Content Customising Space Layouts Exporting Content to Word, PDF, HTML and XML Pages and Blogs Create and Edit Pages Blog Posts Using the Editor Move and Reorder Pages Copy a Page Delete or Restore a Page Add, Remove and Search for Labels Working with Drafts Page Restrictions Working with Links Working with Anchors Working with Tables Add, Assign, and View Tasks Using Autocomplete Working with Page Layouts and Columns and Sections Creating Beautiful and Dynamic Pages Working with Templates Working with Blueprints Importing Content Into Confluence Orphaned Pages Undefined Page Links View Page Information Page History and Page Comparison Views Working with Confluence Markup Files Uploading Files

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 7

Displaying Files and Images Managing Files Collaborating on Files Editing Office Files Macros Activity Stream Macro Anchor Macro Attachments Macro Blog Posts Macro Change-History Macro Chart Macro Cheese Macro Children Display Macro Code Block Macro Column Macro Content by Label Macro Content by User Macro Content Report Table Macro Contributors Macro Contributors Summary Macro Create from Template Macro Create Space Button Macro Excerpt Include Macro Excerpt Macro Expand Macro Favourite Pages Macro Gadget Macro Gallery Macro Global Reports Macro HTML Include Macro HTML Macro IM Presence Macro Include Page Macro Info, Tip, Note, and Warning Macros JIRA Issues Macro JUnit Report Macro Labels List Macro Livesearch Macro Loremipsum Macro Multimedia Macro Navigation Map Macro Network Macro Noformat Macro Office Excel Macro Office PowerPoint Macro Office Word Macro Page Index Macro Page Properties Macro Page Properties Report Macro Page Tree Macro Page Tree Search Macro Panel Macro PDF Macro Popular Labels Macro Profile Picture Macro Recently Updated Dashboard Macro Recently Updated Macro Recently Used Labels Macro Related Labels Macro Roadmap Planner Macro RSS Feed Macro Search Results Macro

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 8

Section Macro Space Attachments Macro Space Details Macro Space Jump Macro Spaces List Macro Status Macro Table of Contents Macro Table of Content Zone Macro User List Macro User Profile Macro User Status List Macro View File Macro Widget Connector Macro Task Report Macro JIRA Chart Macro Collaboration Network Overview Likes and Popular Content User Status Updates Using Mentions Share a Page or Blog Post Commenting on pages and blog posts Watch Pages, Spaces and Blogs Managing Watchers Email Notifications Subscribing to RSS Feeds within Confluence Workbox Notifications Your Confluence Your User Profile Change Your Password Edit Your User Settings Set Your Profile Picture Choose Your Home Page Favourite Spaces and Pages View and Revoke OAuth Access Tokens Search Confluence Search Syntax Confluence Search Fields Searching the People Directory Recently Viewed Pages and Blog Posts Permissions and Restrictions Confluence Groups Add-ons and Integrations Use JIRA and Confluence together Use JIRA Agile and Confluence together Using HipChat and Confluence together Request Add-ons Using a WebDAV Client to Work with Pages Working with Mail Archives Working with Confluence Gadgets Advanced and Special Uses of Confluence Develop Technical Documentation in Confluence Using Confluence as a Knowledge Base Use Confluence as your Intranet

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 9

Getting Started with Confluence Confluence allows you to create, store, collaborate on, and share work with your team and other groups, like customers or the general public, if and when you need to. It's a centralised place where you can work together on projects that matter to you and your teammates. Below are a few areas you may be interested in, or you can choose a topic from the sidebar on the left of the page.

Getting to know Things to do Personalising Confluence Create and Edit Pages Confluence The Dashboard Create a Space Change Your Password Spaces Create a Personal Space Your User Profile Pages and Blogs Choose Your Home Keyboard shortcuts Page Files Favourite Spaces and Pages Watch Pages, Spaces and Blogs

Dashboard The dashboard is the front page of your Confluence site, and provides you with an overview of the site, access to the spaces you have permission to On this page: view, and provides lists of recently updated content. Overview of the You can go to the dashboard from anywhere in Confluence by choosing the dashboard site logo at the top left of the page. This may be the Confluence logo, or a More customised logo set by your Confluence Administrator. about popular content Overview of the dashboard Notes The dashboard is divided into these sections: Related pages: Editing the Site Welcome Message Choose Your Home Page

Welcome message: The information that appears in the top left section of the dashboard. Confluence Administrators can customise this message. Get started: A quick-start guide for administrators. This section of the dashboard is visible to Confluence administrators and system administrators only. It is not configurable via the web interface, but you can update or remove it by editing the site layout . Spaces, Pages, Network: These tabs display your favourite content and people, displayed in the lower left section of the dashboard. Spaces – displays the spaces you have marked as favourites, followed by all the spaces that you have permission to view. Pages – displays the pages you have marked as favourites. Network – displays the users that you are following (or who are following you).

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 10

Recent activity: Tabs on the right-hand side of the dashboard, displaying recently-updated content:. Popular – displays content (that you have permission to view) that has been recently created, liked or commented on. See below for more details. All Updates – displays updates from all spaces that you have permission to view. Favourite Spaces – displays updates from your favourite spaces. Network – displays updates made by the users that you are following (or who are following you). Space Categories – allows you to select a space category, and view recent updates from spaces in that category.

Screenshot: The dashboard

elements will become

elements, and so on). A page at the second level will be demoted by 2, and so on. Atlassian support for PDF customisation is limited. We support the mechanism for customising the PDF layout with HTML and CSS, and we will help if the mechanism is broken or does not work as we say it should in our published examples. But, since custom HTML and CSS offer potentially limitless possibilities, Atlassian will not support issues that are caused by or related to PDF customisations.
Related Topics
Advanced PDF Export Customisations Advanced PDF Export Customisations
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 64
This page provides information about 'advanced' PDF export customisations. These expand upon the regular customisations described in Customising Exports to PDF. The information below is for advanced users. Customisations are not supported by Atlassian. Be aware that the advanced customisations described below require knowledge of certain parts of Confluence, and of CSS and HTML. This documentation is intended for advanced users. Some of the suggestions below are moderately complex, or irregular in nature. If you are having trouble understanding them we strongly suggest you ask an expert. We do not support any of the customisations described below. This means that the Atlassian support engineers will not be able to help you with these modifications. On this page: Header and Footer Adding Headers and Footers to Single Page Exports Adding Images to Headers and Footers Incorporating Other Fonts Adding a Dynamic Title to the Title Page Hiding Text from the PDF Output Indexing Notes Related pages: Customising Exports to PDF Creating PDF in Another Language
Header and Footer
Adding Headers and Footers to Single Page Exports
Single page exports don't support adding HTML headers and footers via the PDF Layout page, but you can use CSS rules in the PDF Stylesheet page (Space tools > Look and Feel > PDF Stylesheet) to produce headers and/or footers for a single page export. For custom headers, define any of the following rules within your @page rule: @top-left, @top-center, and @top-right. These rules allow you to define the content of the left-hand side, centre and right-hand side of your page's header area, respectively. For custom footers, define @bottom-left, @bottom-center and @bottom-right rules within your @page r ule. For example, the following rules add a document title at the centre of the header and a page number at the centre of the footer:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 65
CSS - PDF Stylesheet
@page { @top-center { content: "Document Title Goes Here"; /* This is the content that will appear in the header / font-family: ConfluenceInstalledFont, Helvetica, Arial, sans-serif; font-size: 8pt; } @bottom-center { content: "Page " counter(page); / This is the content that will appear in the footer / font-family: ConfluenceInstalledFont, Helvetica, Arial, sans-serif; font-size: 8pt; } / Any other page-specific rules / }
Notes: The font-family and font-size properties ensure that the header and footer text is rendered in the same default font style used for the body text, based on the default CSS rules. It is not possible to use this method to insert images (stored as attachments within your Confluence instance) into the headers and footers of single page exports.
Adding Images to Headers and Footers
To insert an image into the header or footer, add HTML to the Header or Footer section of the PDF Layout screen. The following example uses an HTML img element with src attribute to add an image to the left of the header. The src attribute refers to an image attached to a Confluence page. The image element is usually placed within a div element container.
HTML - PDF Layout: Header Section

In the example above, the header includes an image called 'header-image.png'. The "12346" in the src attribute is the ID number of the page to which the image is attached. Follow these instructions to include an image on your page: 1. Attach the image to a Confluence page. 2. View the list of attachments on that page, then right-click the image and copy its location. 3. Paste the link into the appropriate src="" attribute in your PDF Stylesheet, as shown above. 4. Edit the image URL so that it is relative, by removing the first part of the URL before /download/....
Notes: This example uses an inline CSS property margin-top in the style attribute to force the image away from the top of the page by 10mm. This comes in handy when your header image is large enough to
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 66
touch or spill over the top of the page. Likewise, for footers, you can use the margin-bottom:XXmm property to force an image away from the bottom of the page by 'XX' mm. Very large images can spill over into the body of a page or alter the position of text or other elements used within a header or footer. In such situations, it is recommended that you reduce the size of the image and then attach it to your Confluence page again. If you prefer to keep the image size and want to move the content lower instead, you can do so by configuring the margin-top properties in the @page C SS rule. By default, a header or footer image is aligned to the left-hand side of the page. However, you can align this image to the centre or right-hand side of a page by adding either the text-align:center or text -align:right properties to your style attribute. For example, to align the header image to the right-hand side of the page, your style attribute would look similar to this: style="margin-top:10mm ; text-align:right".
Incorporating Other Fonts
By default, Confluence provides Times New Roman, Helvetica or Courier fonts for use in PDF exports. You can use your own fonts for PDF exports by declaring them in a @font-face CSS rule in your PDF Stylesheet.
The following CSS rule example shows how to declare the Consolas font and apply it to some elements for your PDF export:
CSS - PDF Stylesheet
@font-face { src: url(file:///usr/share/fonts/Consolas.ttf); -fs-pdf-font-embed: embed; } .code pre, .preformatted pre, tt, kbd, code, samp { font-family: Consolas, monospace; font-size: 9pt; }
The font path specified in the CSS must be the path to the font on the Confluence server.
Adding a Dynamic Title to the Title Page
When you export an arbitrary set of pages from Confluence, you may like to have a corresponding title added to the cover (or title) page automatically. This can be done (in a somewhat irregular way) by using the top level item from the default table of contents as the title. This method relies on having the exported pages structured as sub-pages of the top-level page. In other words, the pages to be exported should consist of a page (at the top-level) and all of its child pages. The result is that the title that appears on the cover page changes depending on the top-level page that is used for the export. The CSS below moves, and styles, the top-level TOC item for use as the title on the cover page, and turns off the leader and page number normally associated with this item in the TOC.
CSS - PDF Stylesheet
.fsTitlePage { position:relative; left:0px; } / Turn off the default section numbering for this TOC item / .toclvl0:before { content: " "; counter-reset: chapter 0; } / Hide the default page numbering for this TOC item / .toclvl0 .tocnum { display: none; } / Move and style this TOC item / .toclvl0 { position:absolute; top:250px; font-size: 42px; font-weight: bold; margin: 72px 0 4px 0; text-align:center; }
Hiding Text from the PDF Output
This section describes a way to hide text from your PDF export. In other words, you can have text on the Confluence page that will not appear in the PDF export. There are three steps:
1.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 67
1. Follow the instructions to define the NoPrint user macro. 2. Use the NoPrint macro to mark some text on a Confluence page. 3. Add the following CSS to your PDF stylesheet to make the PDF export recognise the NoPrint macro:
CSS - PDF Stylesheet
.noprint { display: none ; }
Indexing
To obtain an index at the end of the exported PDF file, consider using the Scroll Wiki PDF Exporter plugin that is produced by K15t Software GmbH.
Notes
If styling is not working as expected, it is useful to look at the intermediary HTML source to which the CSS is applied. This intermediary HTML is created whenever you create an HTML export that contains multipl e pages, and is stored in the temp directory in Confluence's home directory. For example:
/temp/htmlexport-20110308-154047-1/export-intermediate-154047-2.htm l
Creating PDF in Another Language To export a Confluence page written in a language other than English, you will need the necessary font Related pages: for that language. Exporting Content to Word, PDF, HTML and XML
Uploading a Font File to Confluence
1. Find the appropriate font file: Windows users:All font files in Windows are stored in a directory called:
C:\WINDOWS\Fonts
Unix users:All font files in Unix are stored in:
/usr/share/fonts
Microsoft True Type core fonts such as Verdana can be downloaded from this page: http://coref onts.sourceforge.net/ 2. Copy the font file into a temporary folder, for example a folder on your desktop. 3. Choose the cog icon , then choose General Configuration under Confluence Administration then choose PDF Export Language Support. 4. Upload the file you copied in step 2. 5. Choose Install.
Notes
The only font files supported are true type fonts and true type collections. The accepted file extensions are .ttf and .ttc. Confluence can only store one font file at any one time. Please create a collection to install more than
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 68
one .ttf files. We recommend that you use Unicode font Verdana for correct character encoding and exporting to PDF. If the font file size is bigger than your current attachment size limit, you will not be able to upload it. Please increase the attachment size limit temporarily and re-upload again. An improvement of the error messaging is tracked at CONF-24706 RESOLVED To make use of an installed font in your PDF Export style sheet (CSS) refer to it by the font-family ConfluenceInstalledFont.
Pages and Blogs When you create any content in Confluence – whether it's taking down some Related pages: quick notes from a meeting, writing a requirements page, or letting your teammates know about the company's latest marketing push – you'll either Create and be creating it as a page or a blog post. You may be shocked to know that Edit Pages this page you're reading now, is, in fact, a Confluence page! Blog Posts Using the Pages and blog posts are the two things that allow you to capture and share Editor information in Confluence, and which one you use depends on what you Working want to do with your content. If you want the information to last, and possibly with evolve over time, then you likely want to create a page; if the information is Templates specific mainly to the current time-frame, and isn't going to change over Delete or time, then you'll most likely want to create it as a blog post. These aren't Restore a hard-and-fast rules; they're just pointers to give you a place to start. Page Spaces
Each Confluence space, including your personal space, allows you to create pages in it, and has its own blog where you can create posts. If you're not sure what a space is, or what you can do with spaces, check out our page on Spaces. Take a look at the below pages to learn more about pages and blog posts in Confluence. Create and Edit Pages Blog Posts Using the Editor Move and Reorder Pages Copy a Page Delete or Restore a Page Add, Remove and Search for Labels Working with Drafts Page Restrictions Working with Links Working with Anchors Working with Tables Add, Assign, and View Tasks Using Autocomplete Working with Page Layouts and Columns and Sections Creating Beautiful and Dynamic Pages Working with Templates Working with Blueprints Importing Content Into Confluence Orphaned Pages Undefined Page Links View Page Information Page History and Page Comparison Views Working with Confluence Markup Create and Edit Pages Create a page
You can create a page from anywhere in Confluence; just choose Create in
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 69
the header and you're ready to go. Pages are the place to capture all your On this page: important (and unimportant) information; start with a blank page and use it like a word processor to add rich text, tasks, images, macros and links, or Create a use one of the useful blueprints to capture meeting notes, decisions, and page more. Collaborat e or restrict Organise and move Other page actions
Screenshot: The template and blueprint selector
Once you choose Create and decide on a blank page or blueprint, you'll be taken straight into the Confluence editor. The editor is where you'll name or rename your page, add the content, and format it to look great. When you've added some content, choose Preview to take a peek at what your finished page will look like, and choose Save when you've finished your edits. After you save you'll see the page in 'view' mode. You can re-enter the editor any time by choosing Edit or pressing E on your keyboard.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 70
Another useful way to create a page is to use the Create from Template Macro. This macro allows you to choose a page template, and adds a button to the page allowing one-click page creation. If you want others
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 71
to create pages using this template, this is a great option.
Collaborate or restrict
Once you've created a page, you can decide if you want to keep it private, using restrictions, or collaborate on it with others using @mentions, sharing, and comments.
Organise and move
You can also organise pages in a hierarchy, with child and/or parent pages for closely related content. When you navigate to a Confluence page and choose the Create button in the header, the page you're creating will by default be a child of the page you're viewing. Have as many child pages and levels in the hierarchy as you need to, and move pages if you want to change their location.
If you want to view all pages in a Confluence space, choose Pages in the sidebar, or choose Browse > Pag es at the top of the screen if you're using the Documentation theme. If the space is using the Default theme, you'll see recent updates to pages and a page tree displaying all pages in the space; if it's using the Documentation theme, you can choose either Recently Updated, Alphabetical, or Tree view of the pages in the space. Each time you create a page, you're creating it in a space. Spaces are containers used to contain pages with related content, so you can set them up for each team in your organisation, for projects, a combination of both, or for any reason you want to group pages together. See Spaces for more information.
Other page actions
Copy a page Delete a page or remove a specific version of a page Monitor page updates and other activity through page notifications View page history, and manage and compare versions of a page Search page content, including attachments Export pages to Word, PDF, HTML or XML Like a page We recommend you don't use special characters in page or attachment names, as the page or attachment may not be found by Confluence search, and may cause some Confluence functions to behave unexpectedly.
Note: If you rename a page, Confluence will automatically update all relative links to the page, except in some macros. Links from external sites will be broken, unless they use the permanent URL. See Workin g with Links for more information.
Blog Posts Blog posts are an easy way to share announcements, journal entries, status reports, or any other timely information. Others can join in by commenting on and/or liking your blog post and, if you get enough of either, your post might make it to the popular feed on the dashboard! Each space in Confluence, including your personal space, has it's own blog. To view a space's blog, go to a space and choose Blog in the sidebar; if you're using the Documentation theme, choose Browse > Blog at the top of the screen. You'll see a list of the latest blog posts, and you can click through to earlier posts via the navigation area in the sidebar.
Create a blog post
You can follow the same process to create a blog post as when you create a Confluence page.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 72
1. Navigate to the space where you want to create your blog post On this page: 2. Choose Create in the Confluence header and select Blog post Create a 3. Add your content and choose Publish blog post Move a You can create blog posts from the Dashboard, but you'll need to make sure blog post you choose the space it's going to appear in in the create dialog. Restrict a blog post Delete a blog post Export a blog post Related pages: Subscribin g to RSS Feeds within Confluenc e Blog Posts Macro Collaborati on Exporting Content to Word, PDF, HTML and XML
Blog posts can be attractive and engaging in the same way a page can be, so go ahead and add images, YouTube clips (preferably of cats), and tables to your post to really grab your audience. To create a blog post, you need the 'Add Blog' permission. See Space Permissions.
Move a blog post
If you create a blog post in the wrong space, or want to reorganise your spaces, you can move an individual blog post to another space.
To move a blog post, go to the post and choose > Move and select the new destination space. You'll need the 'Delete blog' permission in the current space, and 'Add blog' permission in the new (destination) space to do this.
Restrict a blog post
You can restrict a blog post so that it is only available to specific users or groups. Blog post restrictions work in the same way as page restrictions. To restrict a blog post prior to publishing it, choose the Unrestricted button in the footer and apply your restrictions. To restrict a blog post after publishing, choose > Restrictions and apply your restrictions. Notes: Notifications are sent at the point a blog post is created - removing restrictions does not trigger a new notification. As a blog post has no parent, restrictions aren't inherited.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 73
Delete a blog post
To delete a blog post, choose > Delete. Deleting a blog post follows the same rules as deleting a page.
Export a blog post
You can export individual blog posts to PDF. This is useful, for example, if you want to email an internal blog post to people outside your organisation. See Exporting Content to Word, PDF, HTML and XML for more information on exporting blog pages to PDF. Using the Editor The Confluence editor is what you'll use to create and edit Confluence On this page: pages, blog posts, and comments. You can enter content as you would in a Word document, apply formatting, and embed other content and files on the Edit a page. page or blog post Note: To edit a page, you need the 'Add Pages' permission for the space. The editor See space permissions. Someone may also apply page restrictions that Editor prevent you from editing the page. toolbar Restriction s, labels, Edit a page or blog post and notification You'll be taken to the editor whenever you create a new page or blog post, s or add a comment. To edit an existing page or blog post, choose Edit at the Things to top of a page or press E on your keyboard. help you Confluence automatically saves drafts of your page as you work. If another work faster user begins editing the same page as you, Confluence will display a Find and message and will try to merge the changes when you save your page. To replace see changes between different versions of the page, look at the history of text the page. Record change comments The editor and notify watchers The editor allows you to enter or change the title of your page; insert content including text, images, and links; and format your content using the toolbar. Related pages: If you're renaming your page, there are some things you should take into Working account. with Tables Working with Page Layouts and Columns and Sections Displaying Files and Images Working with Links Using Symbols, Emoticons and Special Characters
Screenshot: The Confluence editor
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 74
Editor toolbar
The editor toolbar is where you format your page layout and text, and add links, tables, images, attachments and macros. You can also perform a find and replace, or get help using the editor by choosing the help icon
. Screenshot: The editor toolbar
The Insert menu
The Insert menu is particularly useful. Use the Insert menu to include any of the following content types on your page: An image A link to another Confluence page or external URL, or a link to an attachment or image An emoticon or symbol, or a horizontal line A macro (choose a specific macro, or Other Macros, from the Insert menu) You can also use keyboard shortcuts to insert links, images, and macros. Try out the shortcuts listed below: Type [ (square bracket) to insert a link. Type ! (exclamation mark) to insert an image or other media. Type { (curly bracket) to insert a macro. Typing any of the above shortcuts will trigger the autocomplete functionality, prompting you with a list of
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 75
suggestions to finish off the entry. For more shortcuts, click the help icon on the editor toolbar.
Restrictions, labels, and notifications
When editing a page, you may want to set restrictions on who can view or edit the page, or add labels to the page to make it easily searchable. Once you're ready to save, you can enter change comments to let others know what you've changed, and, if you like, send an email notification to anyone watching the page.
Things to help you work faster
Auto-formatting
You can type Confluence wiki markup directly into the editor to have Confluence auto-format your text as you
type. To learn more, choose help icon in the toolbar, then choose Editor Autoformatting.
Autoconvert for pasted links
When you paste certain URLs into Confluence, the editor will analyse what you're pasting and automatically convert it into something that will display well in Confluence. Examples include: YouTube videos JIRA issue queries Google Maps Confluence pages, blog posts, comments, user statuses, user profiles. Shared screenshot links from Skitch And more.
Drag-and-drop for external images and files
You can drag files, like images, multimedia, Office files and PDFs, from your computer and drop them directly into the editor. The contents of the file will be embedded into the page or blog post.
Drag-and-drop within the editor
In the editor panel, you can drag an image or a macro from one location to another on the page. Hover your
cursor over the image or the macro placeholder and your cursor changes to a drag-and-drop icon . Click the image or macro and drag it to a new location. Note: For the drag-and-drop of images and macros in the editor, Confluence supports the following browsers: Chrome, Firefox, and Internet Explorer 10 (desktop mode).
Keyboard shortcuts
To view the available keyboard shortcuts, choose the help icon in the editor toolbar.
Find and replace text
Click the icon on the toolbar, or use the keyboard shortcut Ctrl+F (Windows) or Cmd+F (Mac OS). Search matches are highlighted in yellow. You can step through the results one by one, replace the matching text strings one by one, or replace all matching strings at once. Find and replace works only within the current page.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 76
Record change comments and notify watchers
When you finish editing a page, you can add a comment to let others know what you changed. Type a short message in the change comments field in the footer. The comment will be visible in the page history. If you want to send a notification to people watching the page, select Notify watchers. The change comment will be included in the notification email. The Notify watchers checkbox remembers your last selection, so if you choose not to notify people, the checkbox will be deselected for you next time.
Using Symbols, Emoticons and Special Characters You can add various symbols and special characters to Confluence pages. You can also use them in other places that display content, such as blog posts, comments, the dashboard welcome message and the configuration panels offered by the Documentation theme.
Inserting symbols and special characters
To add a symbol to your page: 1. Edit the page. 2. Choose Insert > Symbol. This will display the 'Insert Custom Character' window. 3. Choose a symbol to insert it. On this page: Inserting symbols and special characters Inserting emoticons Preventing emoticons from appearing Related pages: Confluence Wiki Markup Using the Editor
Screenshot : Available symbols
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 77
Inserting emoticons
There are two ways to add an emoticon, or smiley, to your page. By choosing an emoticon from those available: 1. Choose Insert > Emoticon. 2. Choose an emoticon to insert it. By typing a character combination: You can insert emoticons by typing commonly-used character combinations. For example, the following code appears as an emoticon when the page is rendered.
;)
The above example creates this emoticon: This table shows the emoticons (and other icons) available in Confluence, and the character combinations that create them:
Image
Notation :) :( :P :D ;) (y) (n) (i) (/) (x) (!) (+) (-) (?) (on) (off) () (r) (g) (b) (*y)
Preventing emoticons from appearing
To undo the conversion of a character combination into an emoticon, press Ctrl+Z (Windows) or Cmd+Z (Mac). To prevent Confluence from converting text to emoticons automatically, disable 'Autoformatting' in your user profile. See Edit Your User Settings. The Confluence knowledge base has an article on disabling emoticons for the Confluence site as a whole. Move and Reorder Pages The easiest way to set a page's location in Confluence is to navigate to the On this page: space where you want the page to live and, if necessary, find its parent page and choose Create. Sometimes though, you'll want to change a page's Set page location either while you're creating it, or after it's been created. location or move a You can also move and reorder pages in the page tree (hierarchy). page Reorder pages Set page location or move a page within a space 1. Do either of the following: Notes about While creating a page – choose the location icon at the permission top of the page s Once a page is created – choose > Move 2. Use the tabs on the left of the 'Set Page Location' dialog to help you Related pages: find the new space and/or parent page for your page (the Current Create and location and New location breadcrumbs at the bottom of the dialog Edit Pages indicate the current parent page and new parent page) Copy a 3. Select Reorder if you want to move the page to a different position Page amongst the child pages (when you choose Move in the next step, Delete or you'll be able to reorder the page) Restore a 4. Choose Move (If you're reordering the child pages, choose the new Page position for the page and choose Reorder) Orphaned Pages
The page – along with any attachments, comments, and child pages – is moved to your chosen location. Confluence will automatically adjust all links to the moved pages, to point to the page(s) in its new location.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 78
When completing the New parent page field, you need to select the page suggested by Confluence's autocomplete. Typing or pasting the page name (or using your browser's autocomplete) won't work.
Screenshot: Setting the location or moving a page
Reorder pages within a space
You can change the location of a page within its space, and reorder pages in the hierarchy. This allows you to: Move a single page, or a family of pages, to a different parent within the space. Reorder pages that are children of the same parent. All links to the page are maintained. When you move a parent page, the entire hierarchy of child pages will move too. To move or reorder a page: 1. Go to the space and choose Space tools > Reorder pages from the bottom of the sidebar 2. Expand the branches to locate the page you want to move 3. Drag the page to a new position in the tree
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 79
If you're using the Documentation theme go to Browse > Pages > Tree and then drag the pages to a new position as above.
Alternatively, you can choose to order a group of child pages alphabetically by choosing the So rt Alphabetically (A-Z) icon. The Sort Alphabetically (A-Z) icon only appears next to the parent page if the page family is currently sorted manually. If you change your mind, you can use the Undo Sorting icon to revert back to the previous manual page order. This option is only available immediately after sorting the page, while you're still on the Reorder Pages tab, and haven't performed any other action.
Notes about permissions
To move a page, you need the following permissions: 'Add' permission on the page you're moving, and 'View' permission on the page's parent page. If you're moving the page to a different parent, you need 'View' permission on the new parent. To move a page into a different space, you also need: 'Delete' permission on the space you're moving from, and 'Add' permission on the space you're moving to. If the page has restrictions, and you want to keep the page restrictions in the new location, you'll also need 'Restrict' permission on the space you're moving to. Alternatively, remove the page restrictions before performing the move. Copy a Page If you need to duplicate the content of a page, the easiest way is to copy the Related pages: page. Create and When you copy the page it'll need to be renamed if you intend to keep it in Edit Pages the same space – and Confluence will rename the page 'Copy of Move and [originalPageName]' by default – as pages in a space must have unique Reorder names. If you plan on moving it to another space, you can keep the same Pages name as long as you set the location while you're creating the copy. See Mo ve and Reorder Pages for more information. You need the 'Create Pages' permission in a space to copy pages within that space. See space permissions for more information. To copy a page:
1. Go to a page in the space and choose > Copy Confluence will open a copy of the page in the editor. By default, Confluence will name the page 'Copy of [originalPageName]'. 2. Rename the page and make any other changes required in the body of the page If you need to move the new page to a different space or a different parent, choose Location at the bottom-left of the page. Refer to the instructions on moving a page. 3. Choose Save
Notes
Copying a page will duplicate all of the original page's attachments and labels, but won't copy comments from the original page. This method of copying a page doesn't copy the child pages. Please add your vote to issue CONF-281
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 80
4 if you'd like to see this improvement. You can copy an entire space, including all pages in the space (parents and children) — refer to these instructions on copying a space.
Delete or Restore a Page When you delete a Confluence page, it moves to the space's trash much like On this page: an email moves to your email trash or a file moves to the trash on your Delete a computer. It's not permanently deleted, and is still retrievable, until you purg page e the page from the trash. Delete a page with children Delete a page Restore a deleted When you delete a page in Confluence, you're deleting all versions of the page page. If you only want to delete a specific version of a page, take a look at Purge the instructions below for deleting a specific version. deleted To delete a page and all its versions: pages
Go to the page and choose > Delete (confirm you want to delete the Related pages: page when prompted) Pages and Note: The Delete option will only appear if you have permission to delete Blogs this page. See Space permissions. Editing or Deleting a Page That Won't Render Copy a Page
If someone has applied page restrictions to the page, the restrictions may also prevent you from deleting the page.
To delete a specific version of a page: If you want to delete a specific version of a page, you need to be a space administrator. Deleting a page version is permanent. It won't be moved to the trash, so you can't restore a deleted version.
1. Go to the page and choose > Page History 2. Choose Delete next to the version you want to delete (confirm the action when prompted) Once you've deleted a version, the other versions are re-numbered where necessary. For example, if you delete version 2, version 3 will become the new version 2.
Delete a page with children
If you delete a page that has any child pages, the child pages will move to the root of the space. The child pages won't be deleted, but they will lose the parent-child relationship with the deleted page. If you want to keep the child pages under another parent, it's a good idea to move them first, then delete their former parent. Hint: If you do want to remove a parent page and a large number of child pages: 1. Create a temporary new space 2. Move the parent page to the new space (the child pages will move too) 3. Delete the space
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 81
Restore a deleted page
When you restore a Confluence page, you're moving it from the trash to the root of the space. You may want to move the page to another location after you've restored it, as it won't be easy to find at the root of the space. You need to be a space administrator to restore a deleted page. To restore a deleted page: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Content Tools > Trash A list of deleted pages and blog posts for the space displays. 3. Choose Restore for the page you wish to restore Is your space using the Documentation theme? If your space is using the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Trash from the space administration options A list of deleted pages and blog posts for the space displays. 3. Choose Restore for the page you wish to restore
To find the page after you've restored it, choose Pages to go to the root of the space (the page isn't restored to its original position in the page hierarchy). See Move and Reorder Pages for more information. If a new page has already been created in that space with the same name as the page you're restoring, you'll be given an option to rename the page before it's restored.
Purge deleted pages
If you want to permanently get rid of a page, you need to purge it from the trash. That'll mean the page, and all its versions and attachments, are gone for good. Attachments of deleted pages will remain in the database (allowing potential retrieval) until the trash is purged. Once the trash is purged, all attachments on the page(s) are permanently removed. You need to be a space administrator to purge deleted pages. To purge deleted pages: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Trash A list of deleted pages and blog posts for the space displays. 3. Choose Purge for a specific page or Purge All to permanently clear all deleted pages and news items Is your space using the Documentation theme? If your space is using the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Trash from the space administration options A list of deleted pages and blog posts for the space displays. 3. Choose Purge for a specific page or Purge All to permanently clear all deleted pages and news items
Add, Remove and Search for Labels Labels are key words or tags that you can add to pages, blog posts and attachments. You can define your own labels and use them to categorise,
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 82
identify or bookmark content in Confluence. On this page: For example, you could assign the label 'accounting' to all accounts-related Label a pages on your site. You can then browse all pages with that label in a single page or space or across the site, display a list of pages with that label, or search blog post based on the label. Label an attachment Because labels are user-defined, you can add any word that helps you The identify the content in your site. Labelled You can also apply labels (known as categories) to spaces, to help organise content your Confluence spaces. See Using Labels to Categorise Spaces. page Search by label Label a page or blog post Search for labelled Any user with permission to edit a page can add labels to it. Any existing pages labels appear at the bottom-right of the page, below the page content. using a To add a label to a page or blog post: URL Remove labels Related pages: Using Labels to Categorise Spaces Displaying Pages with Label Macros
1. Go to the page choose the edit icon b eside the list of labels or press L on your keyboard 2. Type in a new label (existing labels are suggested as you type) 3. Choose Add
If you're editing or creating a page, and you want to add labels, choose the label icon at the top of the page.
Label an attachment
1. Do either of the following: Go to the page that contains the attachment and choose Go to > Attachments Go to the space and choose Space tools > Content Tools from the bottom of the sidebar, then choose Attachments
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 1.
Confluence 5.8 Documentation 83
You'll see a list of attachments, with any existing labels listed in the Labels column. 2. Choose the edit icon beside the list of labels and type in a new label (existing labels are suggested as you type) 3. Choose Add You can also add labels in a list of attachments displayed by the Attachments macro, by choosing the edit icon beside each label. If you add one or more labels to a template, that label will be copied to the page when someone adds a page based on that template. See Creating a Template.
The Labelled content page
If you're viewing a page or post that has labels or displays the Attachments macro, you can choose any label to go to the Labelled content page for the space. Choose Popular Labels or All Labels from the cog at the top-right – to view the most-used labels or all labels in the space – or choose See content from all spaces fr om the cog to view labelled content from all spaces in your Confluence site. Screenshot: The Labelled content page
The Popular Labels option displays a word cloud, where the bigger a label is displayed, the more popular it is. Choose any label to view content tagged with that label. You can also navigate to the labels view for a space by entering the following URL (replace SPACEKEY with the space's key):
/labels/listlabels-alphaview.action?key=SPACEKE Y
Is the space using the Documentation theme? If the space is using the Documentation theme, access the Labelled content page by choosing Browse > Labels
Search by label
You can use the 'labelText:' prefix to search specifically for content that has a specific label. For example, if you're looking for pages with the label 'chocolate', type labelText:chocolate into the search field in the Confluence header. For more examples of searching by label, see Confluence Search Syntax.
Search for labelled pages using a URL
Entering a URL with an appended label or labels is another way to search for pages with particular labels. In your browser's address bar, enter the following URL and press enter: http:///label/foo+bar
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 84
The Labelled content page will load, showing search results for pages with the both labels, 'foo' and 'bar'. Replace 'foo' and 'bar' with the label(s) you want to search for, and separate multiple labels with a + symbol.
Adding a label to your results: Once you're on the Labelled content page, you can add more labels to your search by choosing them from the Related Labels list at the top-right of the page. Each label is listed with a plus (+) sign. If you want to remove labels from your search, locate the included labels at the top of the page and choose the label(s) you want to remove. Each included label will be listed with a minus (–) sign.
Remove labels
When viewing page, blog post, or attachment labels, an x appears alongside each label. Choose the x to remove the label.
If you have deleted pages that contain a label, you may need to purge the deleted pages from the space's trash to ensure that the label disappears too.
Displaying Pages with Label Macros Using labels and macros, you can categorise pages and then display them Related pages: in Confluence in a number of ways. Add, As an example, you could label all pages relevant to the marketing team Remove with 'marketing', and then add more specific labels like 'online', 'mobile', and and 'physical' to different pages where required. Search for Labels You could then use the Content by Label Macro to display different Macros combinations of pages with the marketing label. Some combinations you Using could use would be: Labels to All pages with the label 'marketing'. Categorise Pages with all of the following labels: 'marketing', 'mobile', and Spaces 'online'. Pages with either the 'mobile' or 'online' labels, in the Marketing space. There are a lot of ways you can filter the content, making it easier for you to find content that's relevant to you.
Other label macros
Here are some other macros that use labels, and can help you categorise and display your content.
Navigation Map macro
The Navigation Map macro renders the list of pages associated with a specified label as a navigation map.
Related Labels macro
The Related Labels macro lists labels commonly associated with the current page's labels.
Content by Label macro
The Content by Label macro displays a list of content marked with specified labels.
Content Report Table macro
The Content Report Table macro displays a set of pages and blog posts in tabular format, based on the specified labels.
Labels List macro
The Labels List macro lists all labels of a space, grouped alphabetically.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 85
Recently Used Labels macro
The Recently Used Labels macro lists labels most recently used in a specified scope - global (site), space, or personal.
Popular Labels macro
The Popular Labels macro displays popular labels in a list or in a heatmap (also called a cloud). Working with Drafts A draft is a 'snapshot' of unsaved page content, which Confluence creates On this page: automatically at regular intervals while you're creating or editing a page or blog post. Drafts can minimise the loss of work if your Confluence site Viewing experiences a problem, as you can retrieve the page content from the last drafts saved draft. Resume editing a By default, Confluence saves a draft of your page once every thirty seconds, draft however, a Confluence administrator can configure how often drafts are Viewing saved. In addition, whenever you edit a page and then move to another your screen, Confluence will automatically save a draft. Each new draft replaces unsaved the previously saved draft. changes Each time Confluence saves a draft, it displays a message and the time of Related pages: the last save, to the right of the undo and redo buttons in the editor toolbar. When you edit a page that wasn't successfully saved, Confluence Configurin will let you know that a version of the page you're editing wasn't saved, and g the Time will give you the option to resume editing it from the draft. Interval at which Screenshot: Message displaying the time when the draft was last saved Drafts are Saved Concurrent Editing and Merging Changes Your Confluenc e
More about drafts: You only have access to drafts of pages you've been working on, and whose content hasn't yet been saved. You can't create a draft explicitly. Your drafts are listed in the 'Drafts' tab of your profile. Once you've resumed editing a draft, or chosen to discard it, the draft is removed from your drafts tab.
Viewing drafts
Your drafts are listed on the Drafts tab of your user profile. To see your drafts, choose your profile picture a t top right of the screen, then choose Drafts.
Resume editing a draft
There are two ways to resume editing an unsaved page or blog post: 1. Using your drafts view. To resume editing a draft from this view: a. Choose your profile picture at top right of the screen, then choose Drafts. b. Choose Resume Editing next to the appropriate draft to resume editing that draft. If you hadn't entered a page title, the draft will be named 'Untitled'. 2.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 86
2. If you create a new page or blog post and didn't save it, but a draft is saved, when you next add a page or blog post in that space, Confluence will ask you if you want to resume editing the page. If you choose resume editing, the draft and its unsaved content will be restored, allowing you to continue editing it. What happens if I'm editing the draft of a page that has since been updated? Confluence will display a message informing you that you're editing an outdated page. If there are no conflicts between the two versions, Confluence will give you the option to Merge and Resume editing.
If there are conflicts, Confluence will give you the option to View the Conflict or to Discard your changes.
Viewing your unsaved changes
When you edit a page or blog post, you can view any 'unsaved' changes you've made since the last automatically saved draft, by clicking the Draft autosaved at message in the toolbar. Screenshot: Segment of the unpublished changes window
Concurrent Editing and Merging Changes Sometimes, another user may edit the same page as you're editing, at the Related pages: same time you do. When this happens, Confluence will do its best to ensure nobody's changes are lost. Page History How will I know if someone else is editing the same page as I am? and Page Compariso If another user is editing the same page as you, Confluence will display a n Views message above your edit screen letting you know who the other user is and Working when the last edit was made. with Drafts
Screenshot: Notification of Simultaneous Page Editing
What happens if two of us are editing the same page and the other user saves before I do? If someone else has saved the page before you, when you click Save, Confluence will check if there are any conflicts between your changes and theirs. If there are no conflicting changes, Confluence will merge the changes. If there are conflicts, Confluence will display them for you and give you the option to:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 87
Continue editing - Continue to edit the page; useful if you want to manually merge the changes. Overwrite - Replace the other person's edits with yours (their edits will be lost). Cancel - Discard your changes and exit the editor, keeping the other person's edits.
Example Scenario
For example, Alice and Bob both edit the same page at the same time. If Alice clicks save before Bob, Bob is now effectively editing an out-of-date version of the page. When Bob clicks save, Confluence will examine his changes to see if any overlap with Alice's. If the changes don't overlap (i.e. Alice and Bob edited different parts of the page), Bob's changes will be merged with Alice's automatically. If Bob's changes overlap with Alice's, Confluence will display an error message to Bob showing where Alice has changed the page, and giving Bob the options to overwrite Alice's changes with his own, to re-edit the document to incorporate Alice's work, or to cancel his own changes entirely, maintaining Alice's changes. Page Restrictions Page restrictions allow you to control who can view and/or edit individual pages in a space. So, if you're working on a page that shouldn't be viewed On this page: by just anybody, it's easy to lock it down to the people who need to know. Restrict a You can add restrictions for individuals or for Confluence groups. page How To add or remove page restrictions, you'll need to have permissions to edit restrictions the page and 'Restrict' or 'Admin' permission in the space. are inherited View Restrict a page current page To restrict who can view or edit a page: restrictions 1. Go to the page and choose > Restrictions Remove 2. Choose Restrict viewing of this page or Restrict editing of this restrictions page from a 3. Enter part of user or group name and choose the appropriate user or page group from the autocomplete drop down Request and grant Add as many users and/or groups as you need to. access to view a restricted page View all restricted pages in a space Notes
To add restrictions when you're creating or editing a page, choose the restrictions icon at the top of the page.
Once you add restrictions, only those people and groups listed in the restrictions dialog will be allowed to view or edit the page. You don't need to add someone as an editor and viewer in the restrictions dialog. We'll check if the person is allowed to edit , and if they are, we'll let them see the page.
How restrictions are inherited
View restrictions are inherited, which means a restriction applied to one page will cascade down to any child pages. Edit restrictions are not inherited, which means pages need to be restricted individually.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 88
Here's the basics: If you restrict viewing to a person or group, only they will be able to see that page and all its child pages (unless there are further restrictions on the child pages) If you restrict editing to a person or group, they'll be able to see and edit that page, plus see its child pages. Parent pages (higher up in the page hierarchy) can have their own view restrictions that may prevent people from viewing your page. If the person you've listed as a viewer or editor can't see the page, check to make sure: they have View space permission for that space, or there's no view restriction on a page higher up the page hierarchy that prevents them seeing any children of that page.
View current page restrictions
Confluence displays a padlock icon in the byline when a page has view or edit restrictions.
To view the page's restrictions, go to the page and do any of the following:
choose > Restricti ons choose the padlock icon in the byline choose the Restricted icon at the top of the page if you're in the editor You'll see the page restrictions dialog listing the users and groups that have permission to view or edit the page. Screenshot: Page Restrictions dialog showing viewing restricted to the 'developers' group and editing restricted to two users.
Remove restrictions from a page
If you need to remove existing restrictions, choose Remove restriction next to the user or group.
Request and grant access to view a restricted page
If you navigate to a page that
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 89
you're not able to view because it has page restrictions applied (for example from a link or page URL) you may be able to request access to the page. To request access to a restricted page: 1. On the restricted page choose Request access 2. Wait for an email confirming that access has been granted If the request access message doesn't appear, you're not able to request access for that particular page. This usually is because the page has inherited view restrictions from a parent page, or you may not have adequate space permissions. To grant access to a restricted page:
1. In the request access email, choose Grant access You'll be taken to the restricted page, and a dialog will appear with the access request 2. Choose Grant access
The user will receive an email confirming that access has been granted.
This process is the same as navigating to > Restrictions and adding a 'View' restriction for the user.
Who can grant access? To grant access to a restricted page you will need to have permission to edit that page, and have the 'Restrict' or 'Admin' permission for the space. Confluence will send an email to a user who can grant permissions. The sequence that Confluence will use to search for the appropriate user is: 1. The last person to edit the page 2. All non-admin users that can set permissions on the page (given that an admin user can always set permissions) 3. The page creator 4. All the space administrators Confluence will try each of these roles in turn, emailing the first user that has appropriate permissions.
View all restricted pages in a space
You need space admin permissions to view the list of restricted pages in a space. To view restricted pages: 1. Go to the space and choose Space tools > Permissions from the bottom of the sidebar 2. Choose Restricted Pages If your space uses the Documentation theme: 1. Choose Browse > Space Admin from the header
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 1. 90
Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Restricted Pages in the space administration options Screenshot: Restricted pages in a space
Notes
You can't exclude yourself As creator or editor of a page, you can't use page restrictions to deny yourself access to the page. Confluence will automatically add your username into the list of users/groups allowed to view/edit the page. If you remove your username, Confluence will put it back again. Space Admin and System Administrator access to restricted pages Users with 'Admin' permissions in a space, or users with the System Administrator global permission can remove restrictions from pages, even if the page restriction prevents them from viewing the page. Go to Space Administration > Restricted Pages. Working with Links You can create links to pages, blog posts, anchors, attachments, external websites, JIRA issues and more. Links can be text or images, and can be added in many different ways. Links to pages within your Confluence site are relative, which means that you can move pages and rename pages without breaking links. This page explains the most common ways to create links.
Insert a text link
To insert a link on a page: 1. Select some text or position your cursor where you want to insert the link 2. Choose Link on the toolbar or use the keyboard shortcut Ctrl+K 3. Select a page, blog post or attachment, or enter an external URL (see below for how to link to particular types of content)
4.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 91
4. Enter or modify the link text (this is the text that will appear on the On this page: page. If this field is left blank, the page name or URL will be used as Insert a the link text.) text link 5. Choose Insert Insert an image link Alternatively you can type [ followed by the page or attachment name. Autoc Modify a omplete will suggest matching items for you. link Remove a link Link to specific types of content Link to Confluenc e pages from other websites Link to a comment Using shortcut Links Trackback Related pages: Working with Anchors Inserting JIRA Issues Using the Editor
You can also paste a URL directly onto your page. Confluence will automatically create the link, and if the URL is for a page in the current site, the page name will be set as the link text.
Insert an image link
1. Select an image on your page 2. Choose Link on the Image Properties toolbar 3. Select a page, blog post or attachment, or enter an external URL (see below for how to link to particular types of content) 4. Choose Insert
Modify a link
1. Select the link text or image 2. Choose Edit from the link properties toolbar 3. Modify the link and choose Save
Remove a link
1. Select the link text or image 2.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 92
2. Choose Unlink from the properties toolbar
Link to specific types of content
Confluence supports many methods for creating links. Some of the common ones are listed here.
Type of link Ways to do this
Link to a page Choose Link > Search then enter part of the page name. Choose Link > Recently viewed and select a page from the list. Type [ and enter part of the page name then select the page from the list. Paste the URL of the page onto your page (Confluence will automatically create the link).
Link to a page in Choose Link > Search enter part of the page name and select All Spaces from the another space drop down. Choose Link > Advanced then enter the space key followed by the page name spa cekey:mypage.
Type [ and enter part of the page name then select the page from the list. (you can hover over each suggestion to see which space the page is from).
Link to a blog post Choose Link > Search and enter part of the blog post name. Type [ and enter part of the blog post name then select the blog post from the list.
Link to an Choose Link > Attachment then upload or select an attachment from the list. attachment or image on this page Type [ and enter part of the attachment file name then select the attachment from the list.
Link to an Choose Link > Search and enter part of the attachment name. attachment on another page Type [ and enter part of the attachment file name then select the attachment from the list (you can hover over each suggestion to see which space the page is from).
Link to a website Choose Link > Web Link then enter the website URL. Type or paste the URL onto the page (Confluence will automatically create the link).
Link to an email Choose Link > Web Link then enter the email address. address Type or paste the email address onto the page (Confluence will automatically create a 'mailto:' link).
Link to an anchor Choose Link > Advanced then enter the anchor name in one of the formats below. on a page For an anchor on this page: #anchor name.
For an anchor on another page in this space: page name#anchor name.
For an Anchor on another page in another space: spacekey:page name#anchor name.
See Working with Anchors for more information on using anchors.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 93
Link to a heading Choose Link > Advanced then enter the heading in one of the formats below. on a page Heading text is case sensitive and must be entered without spaces. For a heading on this page: #MyHeading.
For a heading on another page in this space: Page Name#MyHeading.
For a heading on another page in another space: spacekey:Page Name#MyHeading.
Be aware that these links will break if you edit the heading text. Consider using the Table of Contents macro or an Anchor instead.
Link to a comment Go to the comment, right click the Date at the bottom of the comment and copy the on a page link. Paste the link directly onto your page or choose Link > Web Link and paste in the URL. Type [$ then enter the Comment ID ('12345' in this example): [$12345]
Link to an Choose Link > Advanced then enter the new page name (a page will be created on undefined page click). (a page that does not exist yet) Type [ then enter the new page name then choose Insert link to create page . See Undefined Page Links for more information on undefined pages.
Link to a personal Choose Link > Search then enter the user's name and select their personal space space or user homepage or their profile from the list. profile Type [ then enter the user's name and select their personal space homepage or their profile from the list.
Link to a JIRA issue Paste the JIRA issue URL - Confluence will automatically create a JIRA Issue (where Confluence macro. is connected to JIRA)
Link to Confluence pages from other websites
The best way to link to a Confluence page from outside Confluence, for example on a website or in an email message, is to use the tiny link which is a permanent URL. This ensures that the link to the page is not broken if the page name changes. To access the permanent URL for a page: 1. View the page you wish to link to. 2. Choose Tools > Link to this page. 3. Copy the Tiny Link. 4. Use the tiny link in your website or email message. You do not need to use the tiny link to link to pages within your Confluence site. Confluence automatically updates links when you rename or move a page to another space. If you want to link to specific content such as anchors, headings or comments you need to use the following link syntax. Note that there are no spaces in the page name, anchor name or heading text. In the examples below, the anchor name is 'InsertLinkAnchor' and the heading text is 'Insert a link'.
Purpose Link syntax
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 94
Link to http://myconfluence.com/display/spacekey/pagename#pagename-anchorname an anchor Example from this page: (from an https://confluence.atlassian.com/display/DOC/Working+with+Links#WorkingwithLinks-InsertLinkAnchor external website)
Link to a http://myconfluence.com/display/spacekey/pagename#pagename-headingtext heading (from an Example from this page: external https://confluence.atlassian.com/display/DOC/Working+with+Links#WorkingwithLinks-Insertalink website)
Link to a http://myconfluence.com/display/spacekey/pagename?focusedCommentId=commentid#comment-commentid comment (from an Example from this page: https://confluence.atlassian.com/display/DOC/Working+with+Links?focusedCommentId=368640803#comment-368640803 external website)
Some things to note when linking to anchors from a website or email message: The page name is repeated in the URL, after the # sign. The second occurrence of the page name is concatenated into a single word, with all spaces removed. There is a single dash (hyphen) between the concatenated page name and the anchor name. The anchor name in the full URL is concatenated into a single word, with all spaces removed. The anchor name is case sensitive. You must use the same pattern of upper and lower case letters as you used when creating the Anchor.
Link to a comment
You can add a link to a comment by using the comment URL (a permanent link), or by using wiki markup to link to the Comment ID. To find out the comment URL and comment ID: 1. Go to the comment you wish to link to 2. Choose the Date at the bottom of the comment and examine the URL The number after 'comment-' is the Comment ID. An example is shown here.
https://confluence.atlassian.com/display/DOC/Working+with+Links?focus edCommentId=368640803#comment-368640803
You can use wiki markup directly in the editor to link to a comment. Enter [$ followed by the Comment ID, for example [$12345] where '12345' is the Comment ID.
Using shortcut Links
If you have configured shortcut links on your Confluence site, then you can link to an external site using a shortcut link that looks like this:CONF-17025@jira.
Our Confluence site (where this documentation is housed) is configured to allow shortcut links to our JIRA site, using the shortcut @jira. So the shortcut link CONF-17025@jira produces this link.
To add a shortcut link using the 'Insert Link' dialog: 1. Choose Link > Advanced and enter or paste the shortcut link into the Link field (shortcut links are case-insensitive) 2. Modify or enter link text (this is the text that will appear on the page) 3. Choose Insert
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 95
You can also type '[' and choose Insert Web Link > Advanced to enter a shortcut link. See Configuring Shortcut Links for more details.
Trackback
Trackback enables two sites can stay informed each time one site refers to the other using trackback 'pings'. In Confluence, Trackback can be enabled by a site administrator in the Administration Console. When Trackback is enabled, any time you link to an external webpage that supports Trackback Autodiscovery, Confluence will send a Trackback ping to that page to inform it that it has been linked to. Confluence pages also support Trackback Autodiscovery, and when Trackback is enabled, can receive trackback pings sent by other sites. To see who has sent a Trackback ping to a Confluence page: 1. Go to the page 2. Choose Tools > Page Information Any Trackback pings the page has received will be listed under the page's Incoming Links. Confluence incoming trackback pings only work with referenced pages that are public (anonymously viewable). Working with Anchors On this page: You can use anchors to enable linking to specific locations on a page, and they can be especially useful for allowing your readers to navigate to Step 1: specific parts of a long document. Anchors are invisible to the reader when Create the the page is displayed. anchor Step 2: There are two steps to using an anchor: Create a Step 1: Create the anchor link to the anchor Step 2: Create a link to the anchor Notes Related pages: Step 1: Create the anchor Working Add the Anchor Macro to mark the location you want to link to: with Links 1. Do either of the following in the Confluence editor: Choose Insert > Other Macros, then find and select the Anchor macro Type { and the beginning of the macro name, then select the Anchor macro 2. Enter the Anchor Name (For example, 'bottom' or 'important information') 3. Choose Insert
Macro options (parameters)
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
Parameter Default Description
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 96
Anchor None This is the anchor name that you will use when creating the link. Name The anchor name can include spaces. Confluence will remove the spaces automatically when building a URL that points to this anchor. The anchor name is case sensitive. You must use the same pattern of upper and lower case letters when creating the link as you used when creating the Anchor macro.
Step 2: Create a link to the anchor You can link to an anchor from: A page on the same Confluence site. The link may be on the same page as the anchor, another page in the same space, or a page in another space on the same Confluence site. Another web page or another Confluence site, using a specifically formatted URL. Link to an anchor on the same Confluence site: 1. Select some text or position your cursor where you want to insert the link 2. Choose Link in the toolbar or press Ctrl+K 3. Choose Advanced and enter the anchor name in the Link field, following the format below.
Anchor location Link syntax for anchor Examples
Same page #anchor name #bottom #important information
Page in same space page name#anchor name My page#bottom My page#important information
Page in different spacekey:page name#anchor DOC:My page#bottom space name DOC:My page#important information
The anchor name is case sensitive, so you need to use the same pattern of upper and lower case letters as you used when creating the Anchor macro. You need to enter page and anchor names with spaces when you link to them in the same Confluence site. 4. Enter or modify the Link Text (this is the text that will appear on the page. If this field is left blank, the page name or URL will be used as the link text) 5. Choose Save Screenshot: The 'Advanced' option in the link dialog
Link to an anchor from another web page or another Confluence site: Use a full URL in the following format:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 97
Link syntax Examples
http://myconfluence.com/display/spacekey/pagename#pagename-anchorname http://myconfluence.com/display/DOCS/My+page#Mypage-bottom http://myconfluence.com/display/DOCS/My+page#Mypage-importantinformation
Notes about the full URL: The page name is repeated in the URL, after the # sign. The second occurrence of the page name is concatenated into a single word, with all spaces removed. There is a single dash (hyphen) between the concatenated page name and the anchor name. The anchor name in the full URL is concatenated into a single word, with all spaces removed. The anchor name is case sensitive.
Notes
Table of contents on a page: Consider using the Table of Contents Macro to generate a list of links pointing to the headings on the page. The list of links will appear on the page, and will be automatically updated each time someone changes the wording of a heading. Linking to headings: You can link directly to the headings of a page. See Working with Links. However, if someone changes the wording of a heading, those direct links will be broken. Use the Anchor macro to ensure a lasting link within the body of a page. Site welcome message: If you are adding an anchor to a page that you are using in the site welcome message, you can only link to that anchor from another page. Internal links within that page will not work. Templates: When you are previewing a template, a link to an anchor is displayed as a 'broken' link. However, when you create a page using the template the resulting page will have the correct link. Working with Tables Confluence pages can include multi-row and On this page: multi-column tables. You can highlight cells, rows Inserting a table and columns in different colours. When viewing the What you can do with your table in page, people can sort the table by clicking the the editor column headers. Shortcut keys Sorting the table in view mode Sticky table headings in view Inserting a table mode To create a table: Related pages: 1. While editing the page, place your cursor at Working with Page Layouts and the point where you want to insert the table. Columns and Sections 2. Choose Table on the toolbar. Using the Editor 3. A dropdown menu will appear, showing a table with a variable number of rows and columns. Click in a cell to set the number of columns and rows for your table. 4. Add content and more rows and columns as needed. See below for guidelines on what you can do with your table in the editor. Screenshot: Inserting a table with 3 rows and 3 columns
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 98
What you can do with your table in the editor
While editing a page, place your cursor inside a table to see the table toolbar. Here's a summary of the tools:
Rows Insert rows before or after the current row Delete the current row Cut, copy and paste the current row Mark a row as a header row (shaded with bold text)
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 99
Columns Insert columns before or after the current column Delete the current column Cut, copy and paste the current column Mark a column as a header column (shaded with bold text)
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 100
Cells Merge selected cells Split selected cells Change cell colour
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 101
Table Delete table Add a numbering column to automatically number each row
Shortcut keys
Windows Action Mac OS X
Ctrl+Shift+c Copy the current table row, or the selected rows. Cmd+Shift+c
Ctrl+Shift+i Insert a table. (Opens the Insert Table dialog.) Cmd+Shift+i
Ctrl+Shift+v Paste the table rows from your clipboard, placing them above the Cmd+Shift+v current row.
Ctrl+Shift+x Cut the current table row, or the selected rows. Cmd+Shift+x
Alt+Up Arrow Add a row above the current row. Alt+Up Arrow
Alt+Down Add a row below the current row. Alt+Down Arrow Arrow
For more editor keyboard shortcuts, see Keyboard Shortcuts.
Sorting the table in view mode
When readers view a table on a page, they can sort the table by clicking the sort icons in the header row. Screenshot: A colourful, sortable table
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 102
Sticky table headings in view mode
In some instances table header rows will stick to the top when you're viewing a page, making those really lon g tables easier to read. There are a few exceptions though. Table headers aren't sticky when: the space is using the documentation theme. your table is inside a page layout, or inside another table. your table has no header row or there are cells in the top row that aren't marked as headers. your table has a header column, instead of a header row, and scrolls horizontally. your table contains another table, that has its own header row. Add, Assign, and View Tasks Keep track of the things that need to get done with tasks. With the ability to On this page: give each task an assignee and due date, and plenty of ways to see your Add a task tasks, you can make sure nothing slips through the cracks. View tasks Notes Add a task
You can add tasks on any page in Confluence. For example, you might add tasks under action items on a meeting notes page, or in a project planning p age – anywhere you need a lightweight task management solution. To create a task:
1. In the editor, choose the Task list button or use the keyboard shortcut [ ] 2. Start typing your task – @mention someone to assign the task to them, and type // and choose a due date The first person you mention in a task is the assignee; you can even assign tasks to yourself. Note: If you assign a task to someone who doesn't have permission to view the page or space, they won't see the task.
View tasks
There are a number of ways to keep track of tasks assigned to you, or tasks you've created for others.
On a page
The simplest way to see a task is on the page it was originally created on. It's easy to see if a task is complete, who it's assigned to, and when it's due. If a task is nearing or passed its due date, the colour of the date will change (red for overdue, orange for due in the next 7 days).
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 103
In your profile
The tasks page in your profile gives you a place to see all the tasks relevant to you. Easily keep track of the status of tasks assigned to you, and tasks you've created and assigned to others. To view the tasks page, go to Profile > Tasks. Use the filters to show tasks that were assigned to you or created by you, and toggle between complete or incomplete tasks.
In a Task Report
If you're looking for a more custom view of tasks, the Task Report blueprint is a great way to track tasks assigned to a specific team or project. To create a task report: 1. Choose Create > Task Report 2. Select the type of report: Assigned to my team – for tasks assigned to particular people. In my project – for tasks that appear in a specific space or page. Custom – for a wide range of filtering options, including by date or page label. 3. Follow the prompts to create the report This blueprint uses the Task Report Macro. You can also choose to use this macro on an existing page, for example, on a project or team space homepage.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 104
Notes
The date picker can be triggered by typing // or by typing a date in the format dd/mm/yyyy or dd-mm-yyyy. Typing other date formats in the editor won't trigger the date picker. Personal Tasks (created in the Workbox in older versions of Confluence) don't appear in the Tasks view or Task Report. To migrate any incomplete personal tasks, go to Workbox > Personal Tasks an d follow the prompts. The existing wiki markup based Tasklist Macro has been removed from the macro browser. If you have a Tasklist macro on a page it will continue to work, but you will be unable to add new Tasklists using this macro. Using Autocomplete When using the Confluence editor, you can type a trigger character or press a keyboard shortcut to see a list of suggested links, files or macros to add to your page, or to mention another user (and automatically notify them of this).
Summary of autocomplete
What you want Trigger Keyboard Description to do character shortcut
Add a link on [ Ctrl+Shift+K See a list of your page suggested pages or other locations to link to from your page. More...
Display an ! Ctrl+Shift+M See a list of image, video, suggested audio file or images, document on multimedia files your page and documents to embed in your page. More...
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 105
Add a macro on { None See a list of On this page: your page suggestions as Summary you begin typing of a macro name. autocompl More... ete Using Notify another @ None See a list of autocompl user by email suggested users ete for that you have to mention. Mor links mentioned them e... Using on your page autocompl ete for images, videos, audio files and documents Using autocompl ete for macros Using autocompl ete for mentions Cancelling autocompl ete Enabling and disabling autocompl ete Ignoring autocompl ete Related pages: Working with Links Using Images Macros Keyboard Shortcuts Your Confluenc e
Using autocomplete for links
Type '[', or press Ctrl+Shift+K, to see a list of suggested pages or other locations to link to from your page. You can link to pages, user profiles, images, documents and other file attachments. To autocomplete a link: 1. Edit the page. 2. Click where you want to insert a link and do one of the following: Type '[' and then the first few characters of the page title, user's name, image name or file name.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 2. Confluence 5.8 Documentation 106
Type the first few characters of the page title, user's name, image name or file name (or select relevant text) and then press Ctrl+Shift+K. 3. Click the relevant link from the list of suggestions. If the item you need is not in the list, either: Choose Search for 'xxx' to continue looking for the page within Confluence, or Choose Insert Web Link to insert a link to an external web page using the link browser. Screenshot: Autocomplete for a link
Using autocomplete for images, videos, audio files and documents
You can use the autocomplete as a fast way of embedding images, videos, audio files and documents into your page. Type an exclamation mark or press Ctrl+Shift+M to see a list of suggested images, multimedia files and documents to display on your page. You can use autocomplete to embed the following file types: Images – any format that Confluence supports. Videos, audio files and all multimedia formats that Confluence supports. Office documents supported by the Confluence Office Connector: Word, Excel and PowerPoint. PDF files. Autocomplete works most efficiently for files that are already attached to the Confluence page. To embed an image, video, audio file or document: 1. Edit the page. 2. Click where you want to insert the image, video, audio file or document and do one of the following: Type '!' and then the first few characters of the image, file or document name. Type the first few characters of the name of the image, file or document (or select relevant text) and then press Ctrl+Shift+M. 3. Choose the relevant file from the list of suggestions. If the item you need is not in the list, either: Choose Open Image Browser to find images and documents using the image browser, or Choose Insert Other Media to embed videos, audio and other multimedia files using the macro browser. Insert the 'Multimedia' macro to display your multimedia file. Screenshot: Autocomplete for an image or document
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 107
Using autocomplete for macros
Type '{' to see a list of suggested macros to add to your page. Autocomplete provides access to all available macros in your Confluence site, including any user macros that your administrator has added and made visible to all. You need to know the name of macro. Autocomplete for macros will only match the name of the macro, not the description. To autocomplete a macro using '{': 1. Edit the page. 2. Click where you want to insert the macro. 3. Type '{' and then the first few characters of the macro name. 4. Choose the relevant macro from the list of suggestions. 5. Configure the macro by completing the form fields as prompted. If the macro you need is not in the list, choose Open Macro Browser in the list of suggestions to continue looking for the macro in the macro browser. See Macros. Screenshot: Autocomplete for a macro
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 108
Using autocomplete for mentions
You can use autocomplete to automatically notify another Confluence user that you have mentioned them in a page, blog post, or comment. Type '@' and part of the person's name, to see a list of suggested users. Note: Use the person's full name. Autocomplete will recognise users' full names only, not their usernames.
Cancelling autocomplete
The autocomplete starts automatically when you press the trigger characters. You may want to close the autocomplete menu or escape from autocomplete once it has started. There are a few different ways to stop the autocomplete once it has started: Press the escape key, 'Esc', on your keyboard. Click somewhere else in the editor panel. Press an arrow key to move out of the autocomplete area. For the link autocomplete only: enter a right-hand square bracket, like this: ]
Enabling and disabling autocomplete
You can turn off the triggering of autocomplete by the '[' and '!' characters. This will prevent the autocomplete from starting automatically when you press one of the trigger characters. You can also turn it back on again. Notes: This setting does not affect the keyboard shortcuts for autocomplete (Ctrl+Shift+K and Ctrl+Shift+M). Even if the trigger characters are disabled, you can still use the keyboard shortcuts for autocomplete. This setting affects only you. Other people using Confluence can enable or disable the setting on their user profiles independently. Note that autocomplete is enabled by default. To enable or disable the autocomplete trigger characters: 1. Choose your profile picture at top right of the screen, then choose Settings 2. Choose Editor under 'Your Settings' in the left-hand panel. 3. Choose Edit. 4. Either: Disable autocompletion by selecting Disable Autocomplete. Enable autocompletion by clearing Disable Autocomplete. 5. Choose Submit. Screenshot: User settings for the editor
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 109
Ignoring autocomplete
You can add macros, links and images by wiki markup alone. Type the macro, including its parameters and the closing curly bracket. Add a link, such as an anchor link, and end it with a square bracket. Insert an image or other embedded object, enclosed between exclamation marks. As soon as you close the macro, link, or embedded image, Confluence will convert it to rich text format and add it to the page.
For more information about mouse-free macros, links and images, choose Help > Keyboard Shortcuts from the Confluence header. Working with Page Layouts and Columns and Sections The layout of your pages can have a big impact on how they're read, and On this page: layouts, used well, allow you to position text, images, macros, charts, and much more, to have the best visual impact. Using the Section There are two ways to modify the layout of a Confluence page: and Column Use page layouts to add sections and columns macros Use macros to add sections and columns. Page layouts provide a simple, visual representation of your page layout in the editor, while the macros are more flexible and allow for greater complexity in your layout. Using page layouts
The page layouts tool allows you to structure your page using horizontal sections and vertical columns. By adding multiple sections with different column configurations you can build quite complex layouts very easily.
Screenshot: Editor view of a page showing three sections with different column configurations.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 110
Start by adding a horizontal section to your page. To add a section:
1. Choose the Page Layout button in the toolbar The Page Layout toolbar appears. 2. Choose Add Section The new section appears below your current content, with the boundaries of the section(s) indicated by dotted lines (the dotted lines aren't visible when you view the page). To change the column layout in a section: 1. Place your cursor in the section you wish to change 2. Choose a layout from the page layout toolbar (for example, two columns or three columns) Any text, images or macros in your section are not lost when you change the column layout. When you decrease the number of columns, Confluence will move your content to the left. When you increase the number of columns, Confluence will add blank columns to the right of your existing content. To move a section to another part of the page: 1. Place your cursor in the section you wish to move 2. Choose the Move up or Move down buttons The section and all of its content will be moved above or below other sections on the page. To delete a section: 1. Place your cursor in the section you wish to remove 2. Choose Remove section The section and all of its content will be removed.
Notes about Page Layouts
Column width – The width of the columns are fixed. If you need more than three columns, or columns of a specific width, you should use the Section and Column macros described below. Very wide tables – The width of each column is set to a percentage of the page width. The icons in the drop-down menu indicate the relative widths for each layout. In most cases, Confluence will adapt
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 111
the width of the columns to fit the width of the page. If a column includes an item that's too wide for it, you'll see a horizontal scroll bar when viewing the page.
Using the Section and Column macros
You can use the Section and Column macros to add a set of columns to the page. The Section macro defines an area that will contain the columns. You can have as many sections as you like. Within each section, you can have as many columns as you like. The Section and Column macros are useful if you want to define a specific percentage or pixel width for each column. To add a section and some columns to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find the Section macro, select it and insert it onto the page 3. Choose Insert > Other Macros again 4. Find and insert the Column macro 5. Add your content to the column Insert as many columns as you like within the section. Screenshot: A section and two columns in the editor
When you see the page in view mode, the above layout is displayed like this: Content for column 1 goes here Content for column 2 goes here
Macro parameters
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
Parameters of the Section macro
Parameter Default Description
Show Border false Select this option to draw a border around the section and columns. Note: Without a Column macro, the border will not be displayed correctly.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 112
Parameters of the Column macro
Parameter Default Description
Column 100% of the page width, divided Specify the width of the column, in pixels (for example, Width equally by the number of columns 400px) or as a percentage of the available width (for in the section. example, 50%).
Notes about sections and columns
All content within your section must be enclosed within a Column macro, otherwise the section layout will not work as expected. You can put tables inside columns.
Creating Beautiful and Dynamic Pages Confluence has a number of features that help you On this page: build attractive pages to engage your readers and Adding visual appeal give them the opportunity to interact with up-to-date Bring numbers to life information. This page summarises those features Display presentations and and provides links to detailed instructions. documents Pull in content from your issue tracker Adding visual appeal Tell a story in pictures Vary the structure of your pages Pictures, photographs and Integrate your content with social screenshots. Confluence pages media can display images from your Show activity streams Confluence site and from other websites. To put an image into Related pages: Confluence, you can upload it and attach it to a page or blog Macros post, then display it on any page, Using the Editor blog post or comment. Create and Edit Pages Alternatively, display a remote image using its web Displaying Imagesaddress (URL). See . Galleries. Use the Gallery Macro to display a set of images. When viewing the page, people can click any of the pictures to zoom in and view the images as a slide show. People. Add a Profile Picture Macro to show a picture of a Confluence user, or a User Profile Macro to show a summary of the person's profile as well as their avatar. Multimedia. You can display movies, animations and videos, and embed audio files on your Confluence page. For example, Confluence supports Adobe Flash, MP3, MP4, and various other movie formats. See Em bedding Multimedia Content. Social video and image sharing. The Widget macro displays live content from social sites such as YouTub e and other video sharing sites, and Flickr for shared photographs. See the guide to the . Widget Connector Macro Bring numbers to life
The Chart Macro offers a variety of graphs and charts that you can use to illustrate statistics and other numerical data. Illustration: A 3-dimensional bar chart produced by the Chart macro
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 113
Display presentations and documents
Display your Office documents and other Illustration: A PowerPoint slide deck presentations directly in Confluence. Attach your Office documents to a Confluence page then display them on the page, using the View File Macro. This works for Excel spreadsheets, PowerPoint presentations and Word documents. Display PDF files in Confluence too, also with the View File Macro. Use the Widget Connector Macro to show slide decks hosted on SlideShare and other online presentation sites.
Pull in content from your issue tracker
Many project teams and customers have useful information on a JIRA issue tracker. Rather than copying and pasting it onto your Confluence page, you can display it directly from the source, thus ensuring that the information shown in Confluence is always up to date. Link to a feature request in your issue tracker, or display a list of fixed issues – useful for release notes and project planning. See the JIRA Issues Macro.
Tell a story in pictures Illustration: A Gliffy diagram
A number of Confluence add-ons provide sophisticated tools for creating diagrams and mockups. For example: Balsamiq Mockups for Confluence Creately for Confluence Gliffy Confluence Plugin Graphviz Plugin for Confluence Lucidchart for Confluence Search the Atlassian Marketplace for more add-ons. Before installing an add-on (also called a plugin) into
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 114
your Confluence site, please check the add-on's information page to see whether it is supported by Atlassian, by another vendor, or not at all. See our guidelines on add-on support.
Vary the structure of your pages
You can build up a custom layout by using the page layout tool to add sections and columns to your page. See the detailed guidelines to Working with Page Layouts and Columns and Sections. Do you need to display tabular data, which your readers can sort when viewing the page? See Worki ng with Tables. Use other macros to highlight and format sections of your page: Panel Info, Tip, Note, and Warning Code block Noformat
Illustration: A Panel macro Use a macro or add a smiley to brighten your page.
Integrate your content with social media
People share information on various social sites. You can make Confluence Illustration: Twitter stream a focal point where people collect their shared information and see what is via the Widget macro happening in the areas that matter to them. Use the Widget Connector macro: Loading Show a live stream of tweets from a Twitter user, or tweets matching Twitter a Twitter search. Widget Display a video from YouTube or other online movie sites. Share photographs from Flickr. Widget Display slide decks hosted on SlideShare and other online #35438180 presentation sites. See what else the Widget Connector macro can do. 926347264 0 Show activity streams
Make your Confluence pages dynamic and interactive with: An activity stream showing updates and comments on Confluence and other linked applications. See Working with Confluence Gadgets. An RSS feed from within Confluence or an external site. See Subscri bing to RSS Feeds within Confluence. A list of recent blog posts from within Confluence. See Blog Posts Macro. Working with Templates When you add a new page, you do not have to write the content from
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 115
scratch. Instead, you can base your new page on a template. A template is a Confluence page with predefined content. Some templates are provided On this page: by blueprints or add-ons, others are defined by Confluence users. Global templates Some examples of where templates are useful: and space templates A software development project may have a template for use cases. Creating a A systems administration space may have a template for defining template what information is kept about each server. Using a template Global templates and space templates Templates provided In Confluence, there are two categories of page templates: by Space templates: These page templates are available in a specific blueprints space only. If you have space administrator permission, you can Promoting define templates via the space administration screen. templates Global templates: These page templates are available in every in the space on your site. If you have Confluence Administrator permission, Create you can define global templates via the Confluence Administration dialog Console. System templates System administrators can also download predefined templates. Related pages: Creating a Template Administeri ng Site Templates Importing Templates Creating a Page using a Template
Creating a template
You can write your template using the Confluence editor. You can also add special variables to the page, if you want to include fields that the author will complete when adding the page. See Creating a Template for more information.
Using a template
Page templates are used only when adding a page. It is not possible to apply a template to an already-existing page. Once a page has been added using a template, the template is no longer linked to the page. All further editing is performed as if the template was never used. Some plugins provide enhanced template functionality. You can search the Atlassian Marketplace for template add-ons.See Creating a Page using a Template for more information.
Templates provided by blueprints
A blueprint is a page template with added functionality to help you create, manage and organise content in Confluence. Confluence ships with some predefined blueprints. You can also download additional blueprints from the Atla ssian Marketplace. You can customise the blueprint templates to suit your individual needs, disable particular blueprints or even develop your own blueprints.See Working with Blueprints.
Promoting templates in the Create dialog
If you're a space administrator, you can choose to promote specific templates and blueprints in the Create
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 116
dialog. Promoting items can help ensure consistency in a space by encouraging users to create particular types of content, instead of blank pages. The promoted templates or blueprints will appear at the top, with all other content types, including Blank Page and Blog Post collapsed under them. To view the other types of content available choose the Show more link.
To promote a template or blueprint: 1. Go to Space Tools > Content Tools If your space is using the Documentation theme choose Browse > Space Admin > Templates 2. Choose Promote next to the templates or blueprints you want to appear in the Create dialog Remember, by promoting a blueprint or template you'll be hiding all other items, including blank page and blog post, under the Show more link. If you use the Show more link in the create dialog more than three times in a single space, the dialog will show you all templates by default from then on.
System templates
Confluence also provides 'system templates' containing content like the site welcome message and default space content. See Administering Site Templates.
Creating a Template In Confluence, there are two categories of page templates: Space templates: These page templates are available in a specific space only. If you have space administrator permission, you can define templates via the space administration screen. Global templates: These page templates are available in every space on your site. If you have Confluence Administrator permission, you can define global templates via the Confluence Administration Console.
Add a space template
1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Templates > Create new template. If your space uses the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence1. 5.8 Documentation 117
admin permissions, or if you're part of the 'confluence-administrators' On this page: group. Add a 2. Choose Templates from the space administration options. space 3. Choose Create new template. template Add a global Add a global template template The 1. Choose the cog icon , then choose General Configuration u template nder Confluence Administration editor 2. Choose Global Templates and Blueprints in the left-hand panel Tem 3. Choose Add New Global Template plat e vari able s Lab els Ima ges and othe r atta chm ents Instr ucti onal text Add a description to your template Edit or delete a template Notes Related pages: Creating a Page using a Template Working with Templates Add, Remove and Search for Labels Macros Using the Editor
The template editor
When you create or edit a template, you'll be using the editor in much the same way as when you edit a page or blog post. In addition you can add variables, which will produce a form for data collection when
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 118
anyone adds a page based on the template. Screenshot: The template editor with an image, table, text, and variables
Screenshot: The form displayed when you create a page based on the template
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 119
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 120
Template variables
When you add variables to your template, they will act as form fields. When you create a page based on a template, you'll see a text entry box for each field. Enter data into each field, and it'll be added to the page. You can add the same variable more than once in the same template, which is useful if you need the same information in more than one place on the page. To insert a variable into a template: 1. Choose Template > New Variable from the editor toolbar (or choose an existing variable to add it to the page) 2. Enter a name for the variable 3. Press Enter (by default this will create a single-line text input field) To change the variable type, click the variable placeholder and the variable's property panel will appear. Choose one of the variable types: Text, Multi-line Text, or List. You can change the number of lines and width in characters of a Multi-line Text field. If you choose List, enter each of the items in your list, separated by commas.
Hint: Type $ and the variable name, then press Enter to add a new variable or to select an existing variable from a list of suggestions. The suggestions dialogue shows variables already defined in this template.
Labels
If you'd like all pages created using this template to have one or more labels, choose the labels icon nex t to the breadcrumbs at the top of the page to add them.
Images and other attachments
You can't attach an image or other file to a template. Instead, attach the file to another page, and insert it into the body of the template. For example: You can attach an image to a page and then choose Insert > Files and Images to embed the image into the template. You can attach a PDF to a page and then choose Insert > Other Macros > PDF to embed the PDF
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 121
into the template.
Instructional text
Instructional text is placeholder content in a template, and is only visible while you're editing the page. Use it to give guidance to whoever is creating a page from the template. To insert instructional text: 1. Choose Template > Instructional Text in the toolbar 2. Type in your instructional text (for example, Insert an image of the interface here.) Instructional text appears in italics with a shaded background, to distinguish it from normal paragraph text. You can also change the placeholder type from Text to either: User mention – Opens the user mention dialogue. JIRA Macro – Opens a dialogue that allows you to create a new JIRA issue, or search for one or more JIRA issues to include on the page.
Add a description to your template
The template description displays in the 'Create' dialog, and is useful for explaining the purpose of your template to other users. To add a description to a template: Go to the space or global templates page (as described above) Choose the Edit icon in the 'Description' column Enter your description and choose Save
Edit or delete a template
If you need to change anything about your template, or want to delete it, navigate to either your space or global template (as described above) and choose either Edit or Delete.
Notes
Page templates are used only when adding a page. It is not possible to apply a template to an already-existing page. Once a page has been added using a template, the template is no longer linked to the page. All further editing is performed as if the template was never used. Some plugins provide enhanced template functionality. You can search the Atlassian Marketplace for template add-ons. When you use a Table of Contents macro in a template, you'll see an error when you preview the template, but the Table of Contents macro works on the pages that people create from the template. The editor for templates is available only in Confluence 4.3 and later. Please refer to the earlier documentation for a description of the wiki markup editor templates. Confluence also provides 'system templates' containing content like the site welcome message and default space content. See Administering Site Templates.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 122
Creating a Page using a Template You can create a page based on a global template (available to all spaces) or a space template (available only to that space). Before reading this page, make sure that someone has already created a template on your Confluence site.
Information copied from the template to the page
When you create a page based on a template, Confluence will copy the following content and information from the template to the new page: Labels Text and styles Layouts and formatting Macros Embedded images and other files. Note that you cannot attach an image or other file to a template. But if the template displays an image or file from another page, the new page will display that image or file too.
Form fields displayed by the template
If the template author included variables in the template, Confluence will display a form prompting you to supply values for the variables when you add the page. On this page: Information copied from the template to the page Form fields displayed by the template Using a template to create a page Notes Related pages: Creating a Template Using the Editor Add, Remove and Search for Labels
Using a template to create a page
To create a page based on a template: 1. Choose Create on the header 2. Select a space and the template you want to use and choose Next 3. If the template contains variables, you will now see a form. Type the relevant information into the form fields, and choose Next. 4. Now you will see a new page based on the template. If you added information in the form fields, the page content will include that information. 5. Type a name for the page where you see 'New Page'. 6. Add more content or make any other changes required. 7. Choose Save. Screenshot: Form showing template variables when creating a page from a template
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 123
Notes
Page templates are used only when adding a page. It is not possible to apply a template to an already-existing page. Once a page has been added using a template, the template is no longer linked to the page. All further editing is performed as if the template was never used. Some plugins provide enhanced template functionality. You can search the Atlassian Marketplace for template add-ons. Working with Blueprints
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 124
What is a blueprint? On this page: What is a A blueprint is a set of page templates with added functionality to help you blueprint? create, manage and organise content in Confluence more easily. Creating Create meeting notes, shared file lists and requirements documentation out content of the box, and Customise the blueprint templates to suit your individual using a needs.You can even develop your own blueprints. blueprint Customisin g blueprint Creating content using a blueprint templates Promoting You create a page from a blueprint in the same way as other pages in blueprints Confluence. All blueprints are different and most contain instructions to in the guide you. Create To create a page from a blueprint in the current space: dialog Adding 1. Choose Create in the Confluence header more 2. Choose a blueprint from the 'Create' dialog blueprints 3. Choose Create Disabling a blueprint The editor will open, and, depending on the blueprint selected, a prompt to Full list of enter information or the page will appear. You can now follow the blueprints instructions built in to the blueprint to add content. Related pages: Working with Templates Request Add-ons
The first time a blueprint is used in a space, Confluence creates an index page and adds a shortcut to your sidebar (if you're using the default theme). The index displays a list of pages made with the blueprint, and information selected information from your blueprint pages. For example, the meeting notes index displays a list of all meeting notes pages in the space, who created them, and when they were last modified. Screenshot: Index page for the Meeting Notes blueprint
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 125
If you're using the Documentation theme, your blueprint index page(s) will appear in the sidebar as children of the homepage.
Customising blueprint templates
Blueprints are made up of templates that can be customised for an individual space or the whole site. This means you can adapt the content of the blueprint pages to suit your specific needs. For example, you might update the Meeting Notes blueprint templates to include a heading for apologies. If you have space administrator permissions, you can customise blueprint templates for the spaces you are
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 126
an administrator of. You must be a Confluence Administrator to customise blueprint templates for a whole site. See Administering Site Templates for more information. To customise a blueprint template for a space: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Edit beside the blueprint template you wish to edit 3. Make your changes to the template and choose Save Editing a blueprint template is very similar to editing a page template, except: Be careful not to remove any macros that the blueprint page or index page may use to store and display information. You can't remove a blueprint template or change the template name. To reset a blueprint template back to the default: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Reset to default beside the blueprint template you wish to reset See Working With Templates and Administering Site Templates for more information on templates. As with user created space and site templates, editing a blueprint template will not change existing pages, but any new blueprint pages will be based on the updated template.
Promoting blueprints in the Create dialog
If you're a space administrator, you can choose to promote specific templates and blueprints in the Create dialog. Promoting items can help ensure consistency in a space by encouraging users to create particular types of content, instead of blank pages. The promoted templates or blueprints will appear at the top, with all other content types, including Blank Page and Blog Post collapsed under them. To view the other types of content available choose the Show more link.
To promote a template or blueprint: 1. Go to Space Tools > Content Tools If your space is using the Documentation theme choose Browse > Space Admin > Templates 2. Choose Promote next to the templates or blueprints you want to appear in the Create dialog Remember, by promoting a blueprint or template you'll be hiding all other items, including blank page and blog post, under the Show more link. If you use the Show more link in the create dialog more than three times in a single space, the dialog will show you all templates by default from then on.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 127
Adding more blueprints
You can find more blueprints for Confluence in the Atlassian Marketplace. Blueprints are managed using add-ons (also known as plugins). See Request Add-ons for information on how you can search for new blueprint add-ons and send a request to your System Administrator. If you are a System Administrator, see Managing Add-ons or Plugins for information on how to install new blueprint add-ons. You can also develop your own blueprints. See our developer documentation on Writing a Blueprint .
Disabling a blueprint
You may want to disable particular blueprints. For example, you may not want to see the Product Requirements blueprint in the Create dialog in a HR or Social space. If you are a Confluence Administrator you can also disable particular page and space blueprints for the whole site. To disable a blueprint in a space: Go to the space and choose Space tools > Content Tools from the bottom of the sidebar Choose Disable next to the blueprint you wish to disable in that space You can re-enable the blueprint at any time. To disable a blueprint across a whole site:
Choose the cog icon , then choose General Configuration under Confluence Administration (You need Confluence Administrator permissions to do this) Choose Global Templates and Blueprints Choose Disable next to the page or space blueprint you wish to disable The blueprint will not appear in the 'Create' or 'Create Space' dialogs.
Full list of blueprints
Here's the full list of blueprints bundled with Confluence.
Page blueprints Space blueprints
Meeting notes Documentation space File list Team space Decision Knowledge base space How-to article Troubleshooting article JIRA report Product requirements Retrospective Share a link Task report
Decisions Blueprint The Decisions blueprint helps you make decisions and record the outcomes with your team. The first time you use the Decisions blueprint in a space, Confluence will create an index page and add a shortcut on your space sidebar (if you're using the default theme). The index acts as your Decision Register and lists all the decisions in that space. To use the Decisions blueprint:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 128
Create a Decisions blueprint page (choose Create > Decision) Related pages: Enter information about the decision and relevant stakeholders – the blueprint will prompt you. Working with Screenshot: Decision Register showing a series of Decision pages Blueprints File List Blueprint Meeting Notes Blueprint Product Requireme nts Blueprint
Screenshot: Editing a Decision page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 129
The Decisions blueprint uses these Confluence features: Page Properties and Page Properties Report macro - content that you enter within the page properties macro can appear on the index page.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 130
Mentions - add a user as a stakeholder, owner or @mention them on the page and they will be notified in their workbox.
Customising this blueprint
You can customise the templates that are used by the Decisions blueprint - see Customising the blueprint templates. For example, you might choose to edit the decisions index page in a space to change the columns displayed by the Page Properties Report macro. You can also edit the page template to add headings or instructional text to the background section, or even add rows to the Page Properties macro. For example, a row for the date the decision was made. See Instructional text to find out more about using instructional text in templates.
File List Blueprint The File List blueprint helps you to create lists of files to share with your Related pages: team. Great for organising documents, images and presentations. Working The first time you use the File List blueprint in a space, Confluence will with create an index page and add a shortcut to your space sidebar (if you're Blueprints using the default theme). The index page lists the latest File List pages in Meeting that space. You can have as many File List pages as you need. Notes Blueprint Product Requireme nts Blueprint
To use this blueprint: 1. Choose Create > File List to create a File List page 2. Drag files from your desktop or choose Browse to attach files to the page Attachments appear on the page. Expand each attachment to preview the file and/or view its details. In this example, three file list pages have been created to store project related presentations, images and customer feedback. Confluence looks after the versioning of the files, so there's no need to use the document file name to mark version numbers. Screenshot: Index page showing File List pages
Screenshot: A File List page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 131
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 132
Customising this blueprint
You can customise the templates that are used by the File List blueprint - see Customising blueprint templates. The File List blueprint template uses the attachments macro. You can customise the macro to change the sort order or hide features such as version history and the upload attachment fields. You can also edit the Content Report Table macro used on the Index page to specify the number of pages you want to display.
Meeting Notes Blueprint The Meeting Notes blueprint helps you to plan your meetings and share Related pages: notes and actions with your team. Working The first time you use the Meeting Notes blueprint in a space, Confluence with will create an index page and add a shortcut on your space sidebar (if you Blueprints are using the default theme). The index page lists the latest Meeting Notes File List pages in that space. Blueprint Product Requireme nts Blueprint
To use the Meeting Notes blueprint: 1. Choose Create > Meeting Notes 2. Enter goals, agenda items, and @mention attendees (the instructional text will prompt you) 3. Save your page and get ready to attend your meeting 4. Edit the page during or after your meeting, and enter your notes, action items and @mention users to assign tasks to them. Screenshot: A Meeting Notes index page
Screenshot: A blank Meeting Notes page showing instructional text
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 133
The Meeting Notes blueprint uses some cool Confluence features: Instructional text - this handy text prompts you to enter information and disappears when you start typing or view the page. Mentions - @mention a user on the page and they will be notified in their workbox. Task lists - @mention a user in a task to assign it to them – the task will appear as a personal task in their workbox. You can also add a due date by typing //, then choosing a date from the calendar.
Customising this blueprint
You can customise the templates that are used by the Meeting Notes blueprint – see Customising the blueprint templates. You might choose to edit the headings or add additional headings, or change the instructional text that prompts users to enter information to suit your context. To find out more about using instructional text in a
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 134
template, see Instructional text. You can also edit the Content Report Table macro used on the Index page to specify the number of pages you want to display.
Product Requirements Blueprint The Product Requirements blueprint helps you to define, scope and track Related pages: requirements for your product or feature. Working The first time you use the Product Requirements blueprint in a space, with Confluence will create an index page and add a shortcut on your space Blueprints sidebar (shortcut only available in the default theme). The index lists all the File List Product Requirements pages in that space, and displays a summary of the Blueprint information on each page (such as status and owner). You can have as Meeting many Product Requirements pages as you need. Notes Blueprint
To use the Product Requirements blueprint: 1. Choose Create > Product Requirements to create a Product Requirements blueprint page 2. Enter information about your product or feature – the instructional text will prompt you. You can @mention team members to bring them into the conversation about the page. Screenshot: Index showing a series of Product Requirements pages and summary information
Screenshot: Editing a Product Requirements page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 135
The Product Requirements blueprint uses these Confluence features: Page Properties and Page Properties Report macro - content that you enter within the page properties macro can appear on the index page. Instructional text - this handy text prompts you to enter information or create a JIRA issue and disappears when you start typing or view the page. Mentions - @mention a user on the page and they will be notified in their workbox.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 136
Customising this blueprint
As no two products or projects are alike, you can customise the templates that are used by the Product Requirements blueprint - see Customising the blueprint templates. You might choose to edit the index page in a space to change the columns to be displayed by the Page Properties Report macro. You might choose to edit the page template to: edit the headings or add additional headings change the instructional text that prompts users to enter information to suit your context add or remove rows within the Page Properties macro. See Instructional text to find out more about using instructional text in templates.
Shared Links Blueprint The Shared Links blueprint helps you take content from the web and share it Related pages: with your team. You can use Shared Links to share and collaborate on web content, or to create a centralised repository of useful links. Working with The first time you use the Shared Links blueprint in a space, Confluence will Blueprints create an index page and add a shortcut on your space sidebar (if you're Decisions using the default theme). The index lists all the shared links in that space. Blueprint File List To use the Shared Links blueprint: Blueprint Choose Create > Share a link Meeting Enter the URL of the web content you want to share Notes Choose Create Blueprint Product Requireme nts Blueprint
You can also: Include topics to help categorise your links – these are added as labels to your page. Share the link immediately with another user or group – users will receive a notification. add a comment to start the discussion. To make sharing links even faster, you can add a Share on Confluence button to your browser's toolbar. Click this button and the webpage you're currently viewing will be added as a shared link! To add the Share on Confluence button to your browser: Choose Create > Share a link Drag the Share on Confluence button to your browser toolbar Now, when you want to share a link on Confluence, you can choose the Share on Confluence button in your browser and follow the prompts. Screenshot: Share a link from the Create dialog.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 137
JIRA Report Blueprint The JIRA Report blueprint helps you create easy to read reports to communicate the progress of your JIRA projects and releases. You can On this page: choose from a Change Log report that generates a list of JIRA issues or a Creating a Status Report that includes charts to visually communicate your progress. Change Log The first time you use the JIRA Reports blueprint in a space, Confluence will Creating a create an index page and add a shortcut on your space sidebar (if you're Status using the default theme). Report Customisin To use the JIRA Report Blueprint your Confluence and JIRA sites must be g this connected via Application Links . blueprint
Creating a Change Log
The Change Log report displays a list of issues from JIRA. This list can be static or dynamic, automatically updating as the status of your issues change in JIRA. To create a static Change Log: Choose Create > JIRA Reports
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 138
Select a Report Type Select your JIRA server Choose a Project and Fix Version to report on Choose Create A report page will be created with sample text and a list of all issues for the project and fix versions selected, organised by issue type. This list of issues is static; it won't be updated when the issues in JIRA are updated, and is visible to users who don't have JIRA access or permissions to view that project. Screenshot: Creating a Change Log in simple mode.
Screenshot: Static list of JIRA Issues displaying in the Change Log.
To create a dynamic change log: Choose Create > JIRA Reports Select a Report Type Choose Advanced Enter a JQL query or paste in the URL of a JIRA search (find out about using JQL in the JIRA Documentation) Choose Create A report page will be created with sample text and a JIRA issues macro that's configured to show your issues. The macro is dynamic and will update when the issues in JIRA are updated. For more information on changing the information displayed, refer to the JIRA Issues macro. Screenshot: Dynamic list of JIRA Issues displaying in the Change Log.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 139
Creating a Status Report
The Status Report displays the progress of a JIRA project and fix version in pie charts by status, priority, component and issue type. The Status Report uses the JIRA Chart macro, and is dynamic. To create a status report: Choose Create > JIRA Reports Select Status Report Select your JIRA server Choose a Project and Fix Version to report on or enter a JQL query or JIRA URL Choose Create A report page will be created with sample text and a series of pie charts, using the JIRA Chart macro. The macro is dynamic and will update when the issues in JIRA are updated. For more information refer to the JIR A Chart macro. As with the Change Log, you can switch to Advanced mode and use JQL or paste in a JIRA URL to search for issues to display in the report. Screenshot: Excerpt from the Status Report.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 140
Customising this blueprint
You can customise the templates used by this blueprint. The Change Log uses the Snapshot JIRA Report Template (for static list of issues) and the Dynamic JIRA Report Template, and the Status Report uses the Status Report Template. See Customising the blueprint templates. Variables represent the JIRA Issues and JIRA Chart Macros. While these can't be edited, they can be moved around the page or deleted if you don't want every chart to be included. You can also choose to edit the page template to modify the format of the page, change some headings, or modify the instructional text. To See Instructional text to find out more about using instructional text in templates.
Retrospectives Blueprint Retrospective blueprints help you track team successes and opportunities after projects or at the end of a sprint. Use this blueprint to document what went well, what needed improvement, and assign actions for the future. Using Retrospective blueprints Here's how to use this blueprint for your next retrospective:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 141
Related pages: Working with Blueprints File List Blueprint Meeting Notes Blueprint
1. Choose Create in the Confluence header The Run a Retrospective dialog appears with today's date populated in the title. 2. Add participants
3. Click Create Your new Retrospective blueprint loads.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 3.
Confluence 5.8 Documentation 142
The Retrospective blueprint uses the following Confluence features: Page Properties and the Page Properties Report macro make content listed within the macro visible on the index page. Instructional text prompts you to enter information and disappears when you start typing or view the page. Mention a user on the page to notify them in their workbox.
Customising this blueprint
Every team conducts retrospective meetings differently. You can customise the Retrospectives blueprint template to match your team's culture and practices. You can: Edit headings and pre-populated text. Add instructional text to capture specific information. Add additional sections and content. See Customising blueprint templates for instructions.
Creating a Blueprint-Style Report
Using a combination of templates and macros you can make a wide range of reports for managing anything from customer interviews, product requirements to IT service catalogues and more. In this tutorial we'll guide you through the process of creating a blueprint-style report. In this example, we'll create a multi-team status report. Here's the scenario we'll use for this tutorial.
The Design, Development and QA teams working on the Blue Sky Project need to produce a short status update page each week, containing the focus area for the week, contact person, risks and overall status for each team. They like the way the Product Requirements blueprint works and want to be able to manage their status updates in a similar way. What do each of the players want out of this report? Project Lead – Wants an at-a-glance report that shows only the status for each team. Team Leads – Want a summary report, including the focus areas and risk, just for their team. All team members – Want it to be easy to create the new page each week. Management Team – Want to see all the details for a week on one page, and don't want to have to look at a different page for each team.
With this scenario in mind, this tutorial will guide you through how to: 1. Create a status update template containing a separate page properties macro for each team's section of the report. 2. Create a high level status report, showing just the status of all teams. 3. Create a summary report for each team. 4. Create your first status update page.
You'll need Space Administrator permissions to complete some of the steps in this tutorial.
Part 1: Create a status update template
First we'll create a page template and add the Page Properties macros. 1. Go to Space Admin > Content Tools > Templates 2. Choose Create Template 3. Give the template a name (in this example the template will be called 'Status Update') 4. Add the skeleton of your status report to the page 5. Choose the label icon at the top of the page to add a label to the template (in this example, we'll add the label: 'status-update')
Screenshot: Adding teams to our status update template
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 5.
Confluence 5.8 Documentation 143
Now we'll add a Page Properties macro to record the status of the Design team. 6. Choose Insert > Other Macros > Page Properties to add the Page Properties macro to the page 7. In the macro body create a two column table and remove the heading row 8. In the left column enter the column headings for your report (these are known as metadata 'keys') In this example we'll add 'Design Focus', 'Design Status', 'Design Contact' and 'Design Risks'). 9. In the right column, leave the cells blank, or enter some instructional text to prompt your users (Choose T emplate > Instructional Text) We've also added a status macro. 10. Edit the Page Properties macro and enter a Page Properties ID for this macro (in this example we'll use 'status-update-design'. This will allow us to report on the status of just the Design team later on) Repeat this process for the Development and QA teams, remembering to specify a different ID for each macro (we used 'status-update-dev' and 'status-update-qa'). 11. Finally, add any other headings, instructional text or content to your template and Save. You can enter a Description for your template - this appears in the Create dialog.
Screenshot: Our status update template
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 11.
Confluence 5.8 Documentation 144
Part 2: Create a report showing the high level status of each team
Next we'll create an index page, just like you see in many blueprints. 1. In your space create a new blank page (this will be our 'Status Report - all teams' page, showing just the status of each team) 2. Choose Insert > Other Macros > Page Properties Report to add the Page Properties Report macro to the page 3. Enter the Label to report on (in this example, it'll be the 'status-update' label we added to the template page) 4. Leave the Page Properties ID field blank (we want to report on all the macros on the page) 5. In the Columns to Show field, list the 'keys' from each macro that you want to include in the report (in this example, we only want to show the values of 'Design Status', 'Dev Status', 'QA Status') 6. Choose Save to add the macro to the page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 145 6.
Screenshot: The page properties report macro on the 'Status Report - all teams' page
Now we'll add a button to the page to allow team leads to easily create new status update pages from the template we created earlier. 7. Choose Insert > Other Macros > Create from Template to add the Create from Template macro to the page 8. Enter the text for the button (in this example we'll call the button 'New Status Update Page') 9. Select the template from the Template Name drop down (in this example our template was called 'Status Update') 10. Specify the title of any pages to be created (This is a great way to keep your titles consistent. In this example we'll call the page 'Status update week ending @currentDate', which will append the current date when the page is created, as in the meeting notes blueprint) 11. Choose Insert 12. Add any other content, links or images to the page and Save 13. Choose Space Tools > Configure Sidebar > Add Link to add a shortcut to the page on the sidebar
Part 3: Create a separate report for each team
Now we'll create some index pages that show a more detailed summary for each team, starting with the Design team. 1. Create a new blank page – this will be the 'Design Status Report' index page, showing just information for that team. 2. Choose Insert > Other Macros > Page Properties Report to add the Page Properties Report macro to the page 3. Enter the Label (the page label is once again 'status-update', the label we added to the template) 4. Enter the Page Properties ID that was specified in the Page Properties macro in the template (in this example it was 'status-update-design') – this allows us to report on just information in that macro. 5. Leave all of the other fields blank (we want to show all columns from this Page Properties macro) 6. Choose Save to add the macro to the page
Screenshot: The page properties report macro on the 'Design Status Report' index page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 6.
Confluence 5.8 Documentation 146
7. Add any other content, links or images to the page and Save 8. Choose Space Tools > Configure Sidebar > Add Link to add a shortcut to the page on the sidebar 9. Create a new page and repeat this process for each team Remember to specify a different Page Properties ID each time (in this example 'status-report-dev' and 'status-report-qa'). If your Design, Dev and QA teams have their own team spaces, this summary report could even be created in their team spaces. Just be sure to specify the space where the Status Updates pages are created in the Restric t to spaces field, to make sure the macro can find the pages to report on.
Part 4: Create your first status update page
That's it! Choose Create > Status Update or use the Create a new status update button to make your first status update page. Just like a blueprint, but 100% made by you. Here's how our finished pages look. Screenshot: Team Leads and the management team still have a single page for the weekly status update
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 147
Screenshot: The Project Lead can see the status of each team, each week, at a glance in the All Teams status report.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 148
Screenshot: Each team can see their focus, risks and status at a glance in their status report.
Remember, these concepts don't just apply to status updates – you can use them for any purpose at all.
Importing Content Into Confluence There are a number of ways you can get existing content, such as text, images and other content into On this page: Confluence. Importing content from other Confluence sites Importing content from a Microsoft Importing content from other Confluence Word document sites Importing web content Importing other content
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 149
To import content from another Confluence site you can: Import a backup of the entire Confluence site Import an XML export of an individual space. Page history, attachments, and page content will be preserved. See Restoring a Site and Restoring a Space for more information.
Importing content from a Microsoft Word document
The Office Connector allows you to create pages by importing Word documents. The document content is copied onto one or more Confluence pages. See Importing a Word Document into Confluence.
Importing web content
To displaying web content on a page: Use the Widget Connector Macro to display videos, slide shows, twitter chats, documents and more, sourced from other web sites and displayed on your Confluence page. Embed an external web page into Confluence with the HTML Include macro. Use HTML code in a page with the HTML macro.
Importing other content
Importing non-wiki markup into Confluence requires a conversion process: Text with basic formatting can be pasted directly into the editor. This includes simple Word documents or web pages. Confluence pages saved to disk can be imported from disk. Files can be uploaded in bulk using the Confluence WebDav Plugin Full featured customisation is available using the Confluence APIs.
Importing Content from Another Wiki
Please note, the Universal Wiki Converter (UWC) does not support Confluence versions after 4.3.7.
Importing Pages from Disk Confluence allows you to import text files from a directory on the Confluence Related pages: server, and convert them into Confluence pages. Each file will be imported as a separate Confluence page with the same name as the file. Importing Content Notes: Into Confluenc The text file may contain plain text, HTML or Confluence Storage e Format. Confluenc You need to be logged in as a System Administrator to import text e User's files. Guide You can import pages from disk into site spaces, but not into personal spaces. Please see Spaces for information about differences between site spaces and personal spaces. To import text files:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 150
1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Import. 3. Type the your directory path into the Import directory box. 4. Select Trim file extensions to remove file extensions from the page titles when converting the files to Confluence pages. Note that the Confluence pages will take their titles from the files' names (including their extensions). To avoid having page titles with a suffix like '.txt' check this box. 5. Select Overwrite existing pages if you want to replace existing Confluence pages that have the same page title as one you are importing. 6. Choose Import. If your space uses the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Import from the space administration options. 3. Follow the steps above. Confluence will place the new pages at the root of the space. Screenshot: Importing text files
Importing a Word Document into Confluence The Office Connector allows you to import Word documents and create one or more Confluence On this page: pages from the content. Importing a Word document Import options You can create a single page, or divide the contents up into multiple pages, based on the headings in Related pages: your document. Exporting Content to Word, PDF, This is useful if you have a lot of content stored in HTML and XML existing documents, or if you are migrating from another system or platform that allows you to export to Word format. The Office Connector is only available for some browsers, operating systems and applications, so you'll need to check the Office Connector Prerequisites before you start.
Importing a Word document
To import a Word document:
1.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 151
1. Create a page in Confluence or go to an existing page (you want to view the page, not edit it). 2. Choose > Import Word Document 3. Choose Browse and locate the Word document you want to import then choose Next. The import document options appear. 4. Enter a title for the new page (useful if you do not want to use the file name as your page title). 5. Choose where you want to import the file (as a brand new page, or overwriting an existing page with the same title). 6. Choose how to handle title conflicts (rename the new pages or replace existing pages). 7. Choose whether to create a single page or multiple pages based on the heading styles in the file (this option is only available if the file contains heading styles). 8. Click Import. When the upload has finished, pages will be created with the content of the Word documents. You can then view and edit this page as normal. There's no connection between the original Word document and this page.
Import options
There are a number of options when importing a Word document that control how pages are created, whether the import should overwrite existing pages in the space, and how it should handle page name conflicts.
Option Description
Root This is the title of the page that will be created or updated by the import. page title
Where Controls whether the document is imported into the current page (the page you were viewing to when you selected Tools > Import) or created as a new page. Choose from import Import as a new page in the current space - a new page will be created as a child of the current page. Replace - content will be imported into the current page. The title of this page will change to the title you specified in the Root page title field. Delete existing children of - any existing children of the current page will be removed when the content of the page is replaced.
Title Controls how page name conflicts (a page with the same title already exists in the space) are conflicts handled. Rename imported pages if page name already exists - new pages get a new name (a number added to the end of the page title). Existing pages will be unchanged. Replace existing pages with imported pages of the same title - overwrite the content of existing pages. The change will be shown in the Page History for the page. Remove existing pages with the same title as imported pages - remove original pages and then create new pages. The change is not shown in the Page History for the page.
Split by If the document contains Word heading styles you can choose to create multiple pages based heading on the heading. Options are: Don't split - creates a single page. Level Headings - creates multiple pages in a hierarchy based on the heading levels in the document. A preview of the pages that will be created appears under Document Outline.
Screenshot: Import Word options for a document that contains multiple heading levels.
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 152
Orphaned Pages An orphaned page is a page without any incoming links and is located at Related pages: what's called the 'root of the space', meaning it sits alongside the space's home page. This means that, unless you know the page exists, you're not Undefined likely to come across it during the natural course of navigation. Page Links Create and There may be a legitimate reason you want to have a page at the root of a Edit Pages space. For example, you may be effectively hiding it in the navigation. If you don't want orphaned pages though, you can easily view all orphaned pages in a space so you can tidy delete the pages or reorganise them so they're no longer orphaned. To view the orphaned pages in a space: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Orphaned Pages If your space uses the Documentation theme: 1. Choose Browse > Space Operations at the top of the screen 2. Choose Orphaned Pages in the space operations options While in the orphaned pages view, you can do any of the following: Delete an orphaned page by choosing the 'trash can' icon next to the page name. Edit a page by choosing the 'pencil' icon next to the page name. Give an orphaned page a parent — see Move and Reorder Pages. Screenshot: Managing orphaned pages
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 153
Undefined Page Links You can add links to pages that don't yet exist in Confluence, but you intend Related pages: to create later. Known as links to 'undefined pages', they allow you to create a link which, when clicked, will create a page with the name you specify in Orphaned the link. Pages Create and Edit Pages Create an undefined page link Working with Links 1. Choose Insert > Link or press Ctrl+K on your keyboard 2. Choose Advanced 3. Enter the name of the page to be created in the Link field A link to an undefined page is shown in dark red while in the editor. When anyone clicks the link, Confluence will create a new page with the name you typed in the Link field.
View undefined pages in a space
The Undefined Pages view shows you all undefined pages in your space. The undefined page links are badged with a icon to remind you that those pages are yet to be created. To view a list of the undefined links in a space: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Undefined Pages If your space uses the Documentation theme: 1. Choose Browse > Space Operations at the top of the screen 2. Choose Undefined Pages in the space operations options You can choose the link for an undefined page to create the page and add content to it. View Page Information
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 154
The Page Information view for a page shows you useful information about the page. To see the information about the page: 1. View the page. 2. Choose > Page Information You will see the following information: Page details: Title, author, date of creation, date of last modification and the tiny link (permalink) of the page. Page hierarchy: Parent-child relationships of the page. Incoming links: Lists other pages in your Confluence Site that have links to this page, or reference this page in an Include Page or Excerpt Include macro. Labels: Any labels (tags) that have been applied to this page. See Add, Remove and Search for Labels. Page Permissions: Displays page-level security restrictions that apply to the page (if present). See Page Restrictions. Hot Referrers: The external website pages which send the most viewers to the page. See Managing External Referrers. Recent Changes: Links to the five most recent versions of the page along with the name of the editor and the date of modification. See Page History and Page Comparison Views. Choose View page history to see the page history view, all the versions of the page in reverse chronological order and allows you to compare versions or to restore a previous version. Outgoing links: A summary of the links contained on this page, pointing to other pages on the Confluence site or to external websites. Note: if there is no information to report (for example the page has no restrictions or no incoming links), that section of the Page Information won't appear. Screenshot: Page information for this page
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 155
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 156
Page History and Page Comparison Views Confluence tracks the history of changes to each page by creating a new On this page: version of the page each time it's modified. You can view the changes between different versions, and roll back to a previous version if you need Access the to. page history View an older Access the page history version Restore a To view the history of a page: previous 1. Go to the page and choose > Page History version 2. C hoose a version number to view the content of that version Delete a specific Screenshot: Page history version View the changes made Compare two versions More about the compariso n view Related pages: View Page Information Create and Edit Pages Watch Pages, Spaces and Blogs
View an older version
When you select a previous version of the page, you'll see a header like this at the top of the page:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 157
If you want to send this page version to someone, copy and paste the URL from your browser. The link will look something like this: http://confluence.atlassian.com/pages/viewpage.action?pageI d=12345.
When you're viewing a specific version of the page, the following functions are available:
Function Description
current version View the latest version of the page.
Compare with Compare the differences between the version of the page you are viewing and the Current current version.
Restore this Roll back the content of the page to the previous version that you are viewing. Version
View Page History Return to the list of page versions.
<< Previous and Ne View the previous or next version of the page. xt >>
Restore a previous version
1. Go to the page and choose > Page History 2. Choose Restore this version beside the version you want to restore (or at the top of the page if you've opened the version) 3. Change the default change comment if necessary, and choose OK
All page history is retained; restoring an older version creates a copy of that version. For example, if you restore version 39, Confluence will create a copy of version 39 and the copy will become the new, current version.
Delete a specific version
Choose Delete next to a version in the page history, to remove that version.
View the changes made
Using the page history view or the page information view, you can see the recent changes made to a page. To view recent changes made to a page:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 158
1. Choose > Page Information In the section titled 'Recent Changes' you'll see the most recent versions of the page, along with the date of their modification and the name of the modifying author. 2. Choose View Changes beside the required version The page comparison view is displayed, showing the differences between the selected and previous versions.
Compare two versions
1. Go to the page and choose > Page History 2. Choose the versions you want to compare by selecting the check boxes beside them 3. Choose Compare selected versions You'll see the page comparison view showing the differences between the selected versions. Changes are highlighted as follows:
Highlighted colour Meaning
Green Added content
Red Deleted content
Blue Changed formatting
Screenshot: Comparing changes
More about the comparison view
When you view a page comparison, all large sections of unchanged text are hidden and reduced to an ellipsis (. . .). You can view page changes between versions which are adjacent to your current page comparison view. Click the link containing: << to view the page comparison with the earlier adjacent version >> to view the page comparison with the more recent adjacent version For example, if your page comparison view is between v. 30 and v. 34 of a page, you can view changes between:
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 159
v. 29 and v. 30 by clicking << Changes from 29 to 30 v. 34 and v. 35 by clicking Changes from 34 to 35 >> Working with Confluence Markup This section describes two types of markup found in Confluence: Related pages: Confluence storage format. Confluence stores the content of pages and blog posts in an XHTML-based format. Advanced users can view Macros the storage format of a page and even edit it, provided their Using the Confluence site is configured to allow that. See Confluence Storage Editor Format for a description of the core elements of the storage format. Wiki markup. Confluence allows data entry via a shorthand code called wiki markup. Some parts of the Confluence administration interface also accept wiki markup for defining content. For a description of the wiki markup syntax, see Confluence Wiki Markup. Storage format and wikimarkup code examples for macros can be found in the documentation for each macro.
Confluence Storage Format This page describes the XHTML-based format that Confluence uses to store On this page: the content of pages, page templates, blueprints, blog posts and comments. Macros This information is intended for advanced users who need to interpret and Headings edit the underlying markup of a Confluence page. Text effects We refer to the Confluence storage format as 'XHTML-based'. To be correct, Text we should call it XML, because the Confluence storage format does not breaks comply with the XHTML definition. In particular, Confluence includes custom Lists elements for macros and more. We're using the term 'XHTML-based' to Links indicate that there is a large proportion of HTML in the storage format. Images You can view the Confluence storage format for a given page by choosing Tables > View Storage Format. This option is only available if one of the Page following is true: layouts Resource You are a Confluence administrator. identifiers Your Confluence site has the Confluence Source Editor plugin Template installed and you have permission to use the source editor. variables Instruction If you would like to edit the storage format for a page, your al Text Confluence system administrator will need to install the Confluence Source Editor plugin. Clarification of terminology: If you choose > View Source, you'll see the format used within the editor panel, not the storage format of the page.
Macros
Storage format and wiki markup examples have been included in the documentation for each macro.
Headings
Format type In In Confluence 4.0 and What you will get Confluence later 3.5 and earlier
Heading 1 h1. Underlined in Heading 1

Heading the 1

Documentation Theme

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 160

Heading 2 h2. Underlined in Heading 2

Heading the 2

Documentation Theme

Heading 3 h3. Heading 3

Heading 3

Headings 4 to 6 are also available and follow the same pattern

Text effects

Format In Confluence 3.5 and In Confluence 4.0 and later What you will get type earlier

strong/bold *strong* strong strong text

emphasis _emphasis_ emphasis Italics Text

strikethrough -strikethrough- strikethrough strikethrough

underline +underline+ underline underline

superscript ^superscript^ superscript ^superscript

subscript ~subscript~ _subscript subscript

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 161

monospace {{monospaced}} monospaced monospaced

preformatted n/a preformatted

preformatted text

text

block quotes bq. block quote block

quote or
block quote

{quote}

block

quote

{quote}

text colour {color:red}red red text text{color} red text

small n/a small text small text

big n/a big text big text

center-align n/a centered text

centered text

right-align n/a right aligned text

right aligned text

Text breaks

Format In Confluence 3.5 and earlier In Confluence 4.0 and later What you type will get

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 162

New Paragraph 1 Paragraph 1 paragraph

Paragraph 1

(empty Paragraph 2 line)

Paragraph 2

Line break Line 1 \\ Line 2 Line 1 Line 1
Line 2 Line 2

Note: Created in the editor using Shift + Return/Enter

Horizontal ---- rule

— symbol --- — —

– symbol -- – –

Lists

Format In In Confluence 4.0 and later What you type Confluence will get 3.5 and earler

Unordered * Round Round list – bullet

round bullet list item

Ordered # Ordered 1. Ordered list list item

numbered list item

Task Lists [] Task task list item list incomplete item task list item

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 163

Links

Format In Confluence 3.5 and earlier In Confluence 4.0 and later type

Link to [Link to another Confluence another page|Page Title] Confluence page

Link to an [Link to an attachment attachment^atlassian_logo.gif]

Link to an [Atlassian|http://www.atlassian.com/] external Atlassian site

Anchor link [Anchor Link|#anchor] (same page)

Anchor link [Anchor Link|pagetitle#anchor] (another page)

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 164

Link with [!google.png!|pagetitle#anchor] an embedded image for

For rich content like images, you need to use ac:link-body to wrap the contents.

A note about link bodies

All links received from the editor will be stored as plain text by default, unless they are detected to contain the limited set of mark up that we allow in link bodies. Here are some examples of markup we support in link bodies.

An example of different link bodies

Some Rich Text link body]]>

The markup tags permitted within the are , , , , , , _{, ^{, and .}}

Images

Format In Confluence 3.5 and earlier In Confluence 4.0 and later type

Attached !atlassian_logo.gif! image

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 165

External !http://confluence.atlassian.com/images/logo/confluence_48_trans.png! image

Supported image attributes (some of these attributes mirror the equivalent HTML 4 IMG element):

Name Description

ac:align image alignment

ac:border Set to "true" to set a border

ac:class css class attribute.

ac:title image tool tip.

ac:style css style

ac:thumbnail Set to "true" to designate this image as a thumbnail.

ac:alt alt text

ac:height image height

ac:width image width

ac:vspace the white space on the top and bottom of an image

ac:hspace the white space on the left and right of an image

Tables

Format In Confluence 3.5 and In Confluence 4.0 and later What you will get type earlier

Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 166

Two ||Table Heading Cell column, 1||Table Heading Cell

Table Table two row 2|| Heading Heading (top Cell 1 Cell 2 header |Normal row) Cell 1|Normal Cell 2| Normal Normal Cell 1 Cell 2

Table Heading Cell 1	Table Heading Cell 2
Normal Cell 1	Normal Cell 2

Table Heading Cell cells in 1	Table Heading Cell 2
Merged Cell	Normal Cell 1
Normal Cell 2

Fish Type	2004	2005
Herring	9,500	8,300
Salmon	2,900	4,200
Tuna	1,500	1,500

Fish Type	2004	2005
Herring	9,500	8,300
Salmon	2,900	4,200
Tuna	1,500	1,500

Fish Type	2004	2005
Herring	9,500	8,300
Salmon	2,900	4,200
Tuna	1,500	1,500

Month	Revenue
1/2005	31.8
2/2005	41.8
Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 229 3/2005	51.3
4/2005	33.8
5/2005	27.6
6/2005	49.8
7/2005	51.8
8/2005	77.3
9/2005	73.8
10/2005	97.6
11/2005	101.2
12/2005	113.7

Month	Expenses
1/2005	41.1
2/2005	43.8
3/2005	45.3
4/2005	45.0
5/2005	44.6
6/2005	43.8
7/2005	51.8
8/2005	52.3
9/2005	53.8
10/2005	55.6
11/2005	61.2
12/2005	63.7

	12	14	23
Revenue	41.1	31.8	12.4
Expense	31.1	41.8	43.6

	2005	2006	2007
Revenue	41.1	31.8	12.4
Expense	31.1	41.8	43.6

	12	14	23
Revenue	41.1	31.8	12.4
Expense	31.1	41.8	43.6

Satisfaction	2002	2003	2004
Very satisfied	20	23	34 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 239
Satisfied	40	34	23
Disatisfied	25	26	25
Very disatisfied	15	17	18

Satisfaction	2002	2003	2004
Very satisfied	12	23	31
Satisfied	1	34	36
Disatisfied	4	6	22
Very disatisfied	2	7	12

Two N/A column, Table Table three Heading Heading rows, 2nd Cell 1 Cell 2 and third with Merged Normal merged Cell Cell 1 first row Normal Cell 2 Table Heading Cell cells in 1 Table Heading Cell 2 Merged Cell Normal Cell 1 Normal Cell 2 Page layouts Confluence supports page layouts directly, as an alternative to macro-based layouts (using, for example, the section and column macros). This section documents the storage format XML created when these layouts are used in a page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 167 Notes: Page layouts were originally introduced in Confluence 4.2, and are not available in earlier versions of Confluence. If you are using Confluence 4.2 - 5.1 you should refer to the documentation for your version of Confluence: Confluence Storage Format (Confluence 4.2) Confluence Storage Format (Confluence 4.3) Confluence Storage Format (Confluence 5.0) Confluence Storage Format (Confluence 5.1) Pages with a layout created in the old format will be converted to 5.2 format. Confluence 5.2 provides more flexible layouts with a more concise storage format. Element name In Confluence 5.2 and later Attributes ac:layout Indicates that the page has a layout. It should be the top level None element in the page. ac:layout-section Represents a row in the layout. It must be directly within the ac:la ac:type yout tag. The type of the section indicates the appropriate number of cells and their relative widths. ac:layout-cell Represents a column in a layout. It must be directly within the ac:l None ayout-section tag. There should be an appropriate number of cells within the layout-section to match the ac:type. The recognised values of ac:type for ac:layout-section are: ac:type Expected number of Description cells single 1 One cell occupies the entire section. two_equal 2 Two cells of equal width. two_left_sidebar 2 A narrow (~30%) cell followed by a wide cell. two_right_sidebar 2 A wide cell followed by a narrow (~30%) cell. three_equal 3 Three cells of equal width. three_with_sidebars 3 A narrow (~20%) cell at each end with a wide cell in the middle. The following example shows one of the more complicated layouts from the old format built in the new. The word {content} indicates where further XHTML or Confluence storage format block content would be entered, such as or tags. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 168 {content} {content} {content} {content} {content} Emoticons Format In Confluence 3.5 and In Confluence 4.0 and later What you will type earlier get Emoticons :) :( :P :D ;) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 169 (y) (n) (i) (/) (x) (!) Resource identifiers Resource identifiers are used to describe "links" or "references" to resources in the storage format. Examples of resources include pages, blog posts, comments, shortcuts, images and so forth. Resource Resource identifier format Page Notes: ri:space-key: (optional) denotes the space key. This can be omitted to create a relative reference. ri:content-title: (required) denotes the title of the page. Blog Post Notes: ri:space-key: (optional) denotes the space key. This can be omitted to create a relative reference. ri:content-title: (required) denotes the title of the page. ri:posting-day: (required) denotes the posting day. The format is YYYY/MM/DD. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 170 Attachment ... resource identifier for the container of the attachment ... Notes: ri:filename: (required) denotes the name of the attachment. the body of the ri:attachment element should be a resource identifier denoting the container of the attachment. This can be omitted to create a relative attachment reference (similar to [foo.png] in wiki markup). Examples: Relative Attachment Reference Absolute Attachment Reference URL Notes: ri:value: (required) denotes the actual URL value. Shortcut Notes: ri:key: (required) represents the key of the Confluence shortcut. ri:parameter: (required) represents the parameter to pass into the Confluence shortcut. The example above is equivalent to [ABC-123@jira] in wiki markup. User Notes: ri:userkey: (required) denotes the unique identifier of the user. Space Notes: ri:space-key: (required) denotes the key of the space. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 171 Content Entity Notes: ri:content-id: (required) denotes the id of the content. Template variables This screenshot shows a simple template: The template contains the following variables: Variable name Type Values $MyText Single-line text $MyMulti Multi-line text Size: 5 x 100 $MyList List List items: Apples,Pears,Peaches The XML export produces the following code for the template: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 172 This is Sarah's template A single-line text variable: A multi-line text variable: A selection list: End of page. Instructional Text Instructional text allows you to include information on how to fill out a template for an end-user (the person using creating a page from the template). Instructional text will: automatically clear all instructional text as the user types in a specific text block, and automatically trigger a @mention prompt for user selection (for 'mention' type instructional text). Screenshot: Example of instructional text. This is an example of instruction text that will get replaced when a user selects the text and begins typing. incomplete @mention example. This placeholder will automatically search for a user to mention in the page when the user begins typing. Confluence Wiki Markup This page describes the wiki markup used on some administration screens in Confluence. Wiki markup is useful when you want to do one of the following: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 173 Configure the Documentation theme. Type wiki markup directly into the editor. Confluence will convert it to the rich text editor format as you type. Create links using the Advanced tab of the Links Browser. Insert a block of wiki markup (or markdown) into the Confluence editor. (Choose Insert > Markup.) Note: You cannot edit content in wiki markup. Confluence does not store page content in wiki markup. Although you can enter wiki markup into the editor, Confluence will convert it to the rich text editor format immediately. You will not be able to edit the wiki markup after initial entry. Can I type wiki markup into the editor? Yes. You can type wiki markup directly into the editor, and Confluence will convert it as you type. (You cannot edit the wiki markup after conversion.) See it in action in this video: Read this blog post for more examples: 12 Things You Didn’t Know About the Confluence Editor. Can I insert markdown? Confluence supports inserting content in markdown. This is often used in ReadMe files. See Markdown syntax guide for some examples of markdown syntax. To insert markdown in the editor: 1. Choose Insert > Markup 2. Select Markdown 3. Type or paste your text - the preview will show you how it will appear on your page 4. Choose Insert. As with wiki markup, Confluence will convert your markdown to the rich text editor format. You will not be able to edit your content using markdown. On this page: Can I type wiki markup into the editor? Can I insert markdown? Headings Lists Tables Text Effects Text Breaks Links Images Page Layouts Macros Headings To format a line as a heading, type "hn." at the start of your line, where n can be a number from 1 to 6. What you need to type What you will get h1. Biggest Biggest heading heading h3. Big heading Big heading Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 174 h5. Small heading Small heading Lists Wiki markup allows you to create bulleted or numbered lists, and is flexible enough to allow a combination of the two list types. If you need to separate the text within lists using line breaks, make sure you do so using a double slash (//). Empty lines may disrupt the list. Simple lists Use the hyphen (-) to create simple lists. Make sure there is a space between the hyphen and your text. What you need to type What you will get some - some bullet - bullet points - points Bulleted lists Use the asterisk (*) to create bullets. For each subsequent level, add an extra asterisk. Make sure there is a space between the asterisk and your text. What you need to type What you will get some * some bullet * bullet indented ** indented bullets ** bullets points * points Numbered lists Use the hash (#) to create numbered lists. Make sure there is a space between the hash and your text. What you need to type What you will get 1. a # a 2. numbered # numbered 3. list # list A second level of hashes will produce a sub-list, such as the alphabetical sub-list shown below. What you need to type What you will get Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 175 1. Here's a sentence. # Here's a sentence. a. This is a sub-list point. ## This is a sub-list point. b. And a second sub-list point. ## And a second sub-list point. 2. Here's another sentence. # Here's another sentence. You can use a third level of hashes to produce a sub-sub-list. What you need to type What you will get 1. Here's a sentence. # Here's a sentence. a. This is a sub-list point. ## This is a sub-list point. i. Third list level. ### Third list level. ii. Another point at the third level. ### Another point at the third level. b. And a second sub-list point. ## And a second sub-list point. 2. Here's another sentence. # Here's another sentence. Note: In numbered lists as described above, the format of the 'number' displayed at each list level may be different, depending upon your browser and the style sheets installed on your Confluence instance. So in some cases, you may see letters (A, B, C, etc; or a, b, c, etc) or Roman numerals (i, ii, iii, etc) at different list levels. Mixed lists What you need to type What you will get 1. Here # Here is #* is an #* an 2. example # example of #* of a #* a 3. mixed # mixed 4. list # list Tables You can create two types of tables. Table Type 1 Allows you to create a simple table with an optional header row. You cannot set the width of the columns in this table. Use double bars for a table heading row. What you need to type: ||heading 1||heading 2||heading 3|| |cell A1|cell A2|cell A3| |cell B1|cell B2|cell B3| What you will get: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 176 heading 1 heading 2 heading 3 cell A1 cell A2 cell A3 cell B1 cell B2 cell B3 You can also use a vertical header. What you need to type: ||heading 1|col A1|col A2|col A3| ||heading 2|col B1|col B2|col B3| What you will get: heading 1 col A1 col A2 col A3 heading 2 col B1 col B2 col B3 Table Type 2 This method allows you to specify the width of the columns in the table. What you need to type {section:border=true} {column:width=30%} Text for this column goes here. This is the smaller column with a width of only 30%. {column} {column:width=70%} Text for this column goes here. This is the larger column with a width of 70%. {column} {section} What you will get Text for this column goes here. This is the smaller column with a width of only 30%. Text for this column goes here. This is the larger column with a width of 70%. For more details please see the Column Macro and the Section Macro. Advanced Formatting Colour and Other Formatting To add colour and other formatting to your tables, you can use the Panel Macro within columns. More table-formatting options may be available if your Confluence administrator has installed additional macros. Lists Here's an example of how to embed lists in a table: What you need to type Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 177 ||Heading 1||Heading 2|| |* Item 1 * Item 2 * Item 3|# Item 1 # Item 2 # Item 3| What you will get Heading 1 Heading 2 Item 1 1. Item 1 Item 2 2. Item 2 Item 3 3. Item 3 Text Effects Use the markup shown in the examples below to format text. What you need to type What you will get *strong* strong *bold text* bold text _emphasis_ emphasis _italics_ italics Hint: To italicise parts of a word, add braces (curly brackets) around the underscore. For example, Thing{_}x_ gives you this: Thingx ??citation?? —citation -deleted- deleted +inserted+ inserted Text with^superscript^ Text withsuperscript Hint: There are two ways to make superscripts work, when used directly after another word or character: Add a space before the superscript. For example, kg/ m ^3^ gives you this: kg/m 3 Add braces (curly brackets) around the superscript markup. For example, kg/m{^3^} gives you this: kg/m3 Text with~subscript~ Text withsubscript Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 178 {{monospaced}} monospaced bq. Here's how you make a paragraph Here's how you make a paragraph appear as appear as a block quotation. a block quotation. {color:red}look ma, red text!{color} look ma, red text! Text Breaks Paragraph Break In wiki markup, a paragraph is a continuous line of text ending in two carriage returns. This is equivalent to a continuous line of text followed by a blank line. When rendered into HTML, the result is a line of text wrapped in a set of tags. Line Break Confluence provides two options for forcing a line break within a paragraph of text: Implicitly, by entering a single carriage return at its end. Explicitly, by entering two consecutive backslashes: \\ When rendered into HTML, the result is a paragraph of text that is split into separate lines by tags, wherever a forced line break appears. For most purposes, explicit line breaks are not required because a single carriage return is enough. The examples below show how to use explicit line breaks. What you need to type What you will get here is some text here is some text divided \\ using line divided \\ breaks using line \\ \\ breaks\\ This is a short list: This is a short list: * Point 1 Text to go with point 1 Point 1 * Point 2 Text to go with point 1 Point 2 \\ \\ Text to go with point 2 with a break Text to go with point 2 with a break If you wish to use multiple consecutive line breaks, each should be separated by a space character. For example, use this for two consecutive line breaks: \\ \\ Horizontal Rule To create a horizontal line across the width of your page or content block, type four dashes (like this: ----) at the beginning of a line, then press Enter or space. Make sure that the dashes are on a separate line from the rest of the text. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 179 What you need to type What you will get here is some text here is some text ---- divided by a horizontal rule divided by a horizontal rule Links You can use wiki markup to add hyperlinks to your text. What you need to type What you will get [#anchor] A link to an anchor on the same page. [Confluence Wiki Markupâttachment.ext] A link to a file attached to the page. [pagetitle] A link to a page. [pagetitle#anchor] A link to an anchor on another page. [pagetitleâttachment.ext] A link to a file attached to another page. [spacekey:pagetitle] A link to a page in another space. [spacekey:pagetitle#anchor] A link to an anchor on a page in another space. [spacekey:pagetitleâttachment.ext] A link to a file attached to a page in another space. [/2004/01/12/blogposttitle] A link to a blog post. [spacekey:/2004/01/12/blogposttitle] A link to a blog post in another space. [/2004/01/12] A link to a whole day's blog posts. [spacekey:/2004/01/12] A link to a whole day's blog posts in another space. [spacekey:] A link to the space homepage (or the space summary page of the space. [~username] A link to the user profile page of a particular user. [phrase@shortcut] A shortcut link to the specified shortcut site. Shortcuts are configured by the site administrator. [http://confluence.atlassian.com] A link to an external resource. [mailto:[email protected]] A link to an email address. [file://z:/file/on/network/share.txt] A link to a file on your computer or on a network share that you have mapped to a drive. This only works on Internet Explorer. [!http://external/image.png!|http://external/link.ht Displays an external image and links to an external URL. ml] Note that Confluence treats headings as anchors, so you can link to headings using this pattern: [spacekey:pagename#headingname], where headingname is case-sensitive and must be entered without spaces. For each of these link forms: You can prepend a link alias, so that alternate text is displayed on the page. Example: [link Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 180 alias|pagetitle#anchor] You can append a link tip, which appears as a tooltip. Example: [pagetitle#anchor|link tip] Images You can display images from attached files or remote sources. What you need to type What you will get !http://www.host.com/image.gif! An image from a remote source is displayed on the page. Uses a fully qualified URL. !attached-image.gif! An image file attached to the page is displayed. !pageTitleîmage.gif! An image file attached to a different page is displayed. !spaceKey:pageTitleîmage.gif! An image file attached to a page in a different space is displayed. !/2010/05/23/My Blog An image file attached to a blog post is displayed. Postîmage.gif! !image.jpg|thumbnail! The image is displayed as a thumbnail on the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image. Thumbnails must be enabled by the site administrator for this to work. !image.gif|align=right, For any image, you can specify attributes of the HTML image tag as a vspace=4! comma separated list of name=value pairs. Available HTML image tags include: Image tag Details align Available values are 'left', 'right', 'bottom', 'center', 'top'. border Specifies the width of the border (in pixels). bordercolor Use with the 'border' tag. Specify colours by name or hex value. hspace Specifies the amount of whitespace to be inserted to the left and right of the image (in pixels). vspace Specifies the amount of whitespace to be inserted above and below the image (in pixels). width Specifies the width of the image (in pixels). This will override the natural width of the image. height Specifies the height of the image (in pixels). This will override the natural height of the image. title Specifies alternate text for the image, which is displayed when the pointer hovers over the image. alt Specifies alternate text for the image. This text is retrievable via search, and contributes to accessibility of the page for text-only viewing. Page Layouts There is no wiki markup representation for page layouts. Macros Storage format and wiki markup examples have been included in the documentation for each macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 181 Files Share your team's PDFs, Office documents, images, and more in one place by uploading your files to Confluence. Automatic versioning, instant On this page: previews, permissions, and full-text search, means shared network drives Using Files can be a thing of the past for your team. Permission When you upload a file it is attached to the current page or blog post. This is s why files are often referred to as attachments in Confluence. Related pages: You can attach anything from project plans and design mockups to video Configurin and audio files. You and your colleagues can also collaborate by commentin g g on files displayed on Confluence pages. Attachmen t Size Using Files Configurin g your Uploading Files Attachmen Displaying Files and Images t Storage Managing Files Collaborating on Files Editing Office Files Permissions The 'Add Attachment' and 'Delete Attachment' permissions are used to control who can upload and delete attachments in a space. Users with 'Add Page' or 'Add Blog' permissions can insert existing attachments to their pages, but not upload new attachments unless they also have the 'Add Attachment' permission. There is no permission that controls downloading attachments. See our knowledge base article about disabli ng the download of attachments if you need to do this. Uploading Files When you upload a file, such as an image or On this page: document, it will be attached to the current page. Uploading a file You can then choose to display the file on the page Accepted file types and size as a link, an image or embed it in the page (using a File versions macro). Notes To upload a file you'll need the 'Add Attachments' Related pages: space permission. Files Configuring Attachment Size Uploading a file Displaying Files and Images Managing Files There are many ways to attach a file to a page. In the editor you can: Drag the file directly onto the page. Go to Insert > Files and images and upload a file. When viewing a page you can: Drag the file directly onto the page. Go to > Attachments and upload a file. You can attach multiple files at a time. Accepted file types and size Confluence allows you to attach most file types, but you cannot attach a folder of files (including folders Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 182 created by applications like Keynote - you'll need to export your presentation to zip or other format). Although just about any file type can be attached to a page, not all file types can be displayed on or embedded in a page. See Displaying Files and Images to find out more. The maximum file size you can upload to Confluence is set by your system administrator. By default it is 10mb, but your administrator may have increased or reduced this limit. File versions If you upload a file with the same name as an existing attachment on the same page, Confluence will overwrite the existing attachment. Version history is kept for all attachments. See Managing Files to find out more. Any changes you make to the source file will not affect the copy that was uploaded to Confluence. To update the Confluence copy, you need to upload the new version of the file. Notes We recommend you don't use special characters in page or attachment names, as the page or attachment may not be found by Confluence search, and may cause some Confluence functions to behave unexpectedly. Displaying Files and Images Files can be displayed on a page as a thumbnail, a link or embedded using a macro. There are a few On this page: different ways to Upload Files. Displaying images Inserting an image How files are displayed depends on the type of file Inserting an image attached you uploaded. to a different page Inserting an image from the web Displaying images Changing the image appearance Add interest to your pages by adding images. You Deleting images can display all common image types including .jpeg, Previewing images and PDFs .png, .gif and .bmp (depending on browser support). Displaying multimedia files Displaying Office files and PDFs Inserting an image Displaying a file as a thumbnail or a link There's a few ways you can insert an image into Embedding a file in the your page: page Displaying other file types Go to Insert > Files and Images on the Displaying a list of files on a page editor toolbar and then either upload some Notes files or select existing files, or Drag the image file directly into the editor, or Related pages: Type ! and choose an attached image from the autocomplete drop down. Working with Links Managing Files Inserting an image attached to a different page You can display an image that is attached to a different page of the same Confluence site, if you know the name of the image. To display an image attached to a different page: 1. Go to Insert > Files and Images and choose the Search on other pages. 2. Enter the name of the image. 3. Choose whether to search the current space or All Spaces and choose Search. 4. Select the required image from the search results and choose Insert. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 183 Alternatively, you can cut and paste the image from another page (the image will still be attached to the original page). Inserting an image from the web You can display an image from a remote web page on your Confluence page, without needing to attach it to your page. You need to know the URL for the image, not for the web page it appears on. To display an image located on a web page: 1. While editing the page, position the cursor where you want to place the image. 2. Choose Insert > Files and Images and choose Images from the web. 3. Enter a URL for the image. (example: http://atlassian.wpengine.netdna-cdn.com/wp-content/uploads/A tlassianBushRegeneration-12January2012-083-trunc.jpg 4. Choose Preview to check that the URL and image are correct. 5. Choose Insert. Alternatively, you can simply copy and paste the image from a web page. Changing the image appearance When editing the page, select the image to show the image properties panel. The panel allows you to set the display size, add a border and effects and link the image to other pages. From the image properties panel you can: Choose a preset size for the image Enter a width for the image (between 16px and 900px) Add a border around the image Link the image to a page or URL Align the image (you can use the left and right align buttons to make the text wrap around the image too) Add a title, which is shown when you hover over the image (go to Properties > Title) Add alt text, which is used by screen readers and when the image can't be shown (go to Properties > Title) Add effects to the image such as drop shadow or snapshot (go to Properties > Effects). To add a caption to an image using the Instant Camera effect: Choose Effects in the image properties panel and choose the Instant Camera image effect. Save the page. Go to > Attachments to go to the 'Attachments' view of the page. Choose Properties next to the image file. Add a comment to the attachment. The text in your comment will appear as the image caption. You will need to re-enter the comment each time you upload a new version of the image. Note: The Instant Camera effect only works with Latin character languages, due to a lack of handwriting style fonts in multi-byte languages. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 184 Deleting images If you delete an image on a page, the attached file will not be deleted from the page. Go to > Attachme nts to delete the attachment completely from the page. Seeing an 'unknown attachment' placeholder on your page? This means that the attached file has been deleted from the page (or another page). Previewing images and PDFs Click an image or PDF link when viewing a page to launch the preview. The preview includes images from the web that are displayed on the page, or images and PDFs that are attached to the page (even if they are not currently displayed on the page). In the preview you can: Download the image file. Upload a new version of the file. Comment on the file. Zoom in, out or fit the image to the width of your browser. Browse like a slideshow using the next and back buttons. See other files attached to the page and select a thumbnail to preview that file. Switch to a full screen presentation mode. Note: Internet Explorer 9 may preview PDF files in low quality. You can download the file to view the original version. Displaying multimedia files You can display multimedia files (such as video, audio and animation) that are attached to your page using the Multimedia Macro. Display online multimedia (such as YouTube or Vimeo videos) using the Widget Connector Macro. Displaying Office files and PDFs Inserting a file in a page is a great way to make useful documents, spreadsheets, presentations and other files available to your team. There are a several ways you can display an office or PDF file on a page: as a link - people can click the link and download the file. as a thumbnail - people can click the thumbnail to preview (Office and PDFs) or download the file (other file types). embedded in the page - people can view the content of the file without leaving the page. Displaying a file as a thumbnail or a link In the editor go to Insert > Files and select a file to insert. The file will appear on your page as a thumbnail. Click the thumbnail to resize it or to switch to showing the file as a link. Embedding a file in the page Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 185 You can embed PDFs, presentations, spreadsheets and other Office documents into your page using a View File macro. Drag a PDF or Office file into the editor to automatically upload it and embed it into the page. See View File Macro to find out more. Displaying other file types Other file types can be uploaded and displayed on the page as a link or with a placeholder thumbnail. Displaying a list of files on a page There are several ways you can display a list of files on a page. You can: Use the Attachments Macro to show files attached to the current page. Use the Space Attachments Macro to show all files in a space. Use the Gallery Macro to show thumbnails of images attached to a page. You can also use the File List blueprint for uploading, viewing and managing lists of files. Notes Image effects Displaying image effects can be resource intensive. Confluence limits the threads that are dedicated to displaying image effects so that it does not impact your whole instance. If a thread is not available, Confluence will display the image without the effect. The following knowledge base article provides information if you need to adjust the number of threads - Imag e effects are not displayed in Confluence 5.5 or later. Managing Files Files are attached to Confluence pages. See Uploadi On this page: ng Files to find out about attaching files to pages. Download attached files Once attached you can download, delete and edit Delete an attached file these files, for example if you need to upload a new Upload a new version of an version of the file, or change the page it is attached attached file to. Move a file to another page Edit properties of an attached file View all attached files in a space Download attached files Any user with permission to view a page can also Related pages: download any files attached to that page. Files To download an individual file: Displaying Files and Images Click the Download button in the file preview, or Go to > Attachments and then right click on the file name and save the link. To download all files attached to a page as a zip file: 1. Go to > Attachments 2. Click Download All. There's no option to download all attachments in a space. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 186 Delete an attached file You'll need the 'Delete Attachment' space permission to delete an attached file. To delete all versions of an attached file: 1. Go to the page that contains the attachment. 2. Go to > Attachments 3. Choose Delete next to the attachment you want to delete. 4. Choose Delete to confirm your action. Deleted files can be restored from the trash. You'll need to be a space admin to do this. Space Admins can also delete a specific versions of an attachment: 1. Go to > Attachments 2. Click the expand arrow next to the attachment name to see the list of attachment versions 3. Choose Delete next to the version you want to delete. Deleted file versions are not recoverable from the trash. Screenshot: Attachments and attachment versions Upload a new version of an attached file There are two ways up upload a new version of an attached file. You can: Upload a file with the same file name to the page. Use the Upload a new version button in the file preview to upload a file with a different name (for images and PDFs only). To view attachment versions: Go to > Attachments Click the expand arrow next to the attachment name. All earlier versions of the file will appear. You can't revert to an earlier version of the file, but you can choose to remove earlier versions if you have Space Administrator permissions. Move a file to another page You'll need the 'Add Page', 'Add Attachment' and 'Remove Attachment' space permissions to move an attached file to another page. To change the page that a file is attached to: Go to > Attachments Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 187 Choose Properties next to the attachment you want to move. Enter the name of the page you want to move the attachment to (for example My Destination Page). Choose Save. If you want to move the file to a page in another space, add the space key before the page name (for example DOC:My Destination Page). Edit properties of an attached file You'll need the 'Add Attachment' permission in the space to edit the file properties. To edit the properties of an attached file: Go to > Attachments Click Properties beside the attachment you want to edit. You can: change the file name add a comment (used in the version list and also by the Snapshot image effect) change the MIME type move move the attachment to another page add a label. Changing the MIME type may cause your file to display incorrectly. View all attached files in a space There are two ways you can view all files in a space. You can: Use the Space Attachments macro to display the list of files on a page. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar Then choose Attachments. If your space uses the Documentation theme go to Browse > Space Operations > Attachments. You can use the filters to only show files with a particular label or file extension. Screenshot: Space attachments macro Collaborating on Files Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 188 Collaboration doesn't just happen on pages. Often you'll need to collaborate On this page: with your team on documents, presentations, images and spreadsheets. Whether its mockups for a new marketing campaign or a full project plan, Share a you can simplify your team's feedback loop by working together on files in file Confluence. Comment on a file Edit a file Share a file Related pages: Do you have lots of files on a page and want to get a team member's input Files on just one of them? You can share the file with them directly. Displaying It works just like sharing a page: Files and Images 1. Click the thumbnail or link to preview the file Commenti 2. Choose the Share button ng on 3. Enter an email address, user name or group name, add your pages and message and send. blog posts Your team members will get an email with your message and a link to view the file. Notifications are only sent by email, they won't appear in the workbox . Comment on a file Whether it's an image – like a mockup of the new marketing campaign that needs feedback – a PDF, a presentation, or any other file you can preview in Confluence, you can drop a pin anywhere on the preview and add your comment to start a conversation. To comment on a file: 1. Click the thumbnail or link to preview the file. 2. Drag the pin icon from the bottom of the preview and drop it where you want to comment. 3. Add your comment and Save. Pinned comments work just like inline comments on pages. You can use @mentions, links, and macros, and drop as many pins as you need on any part of the file. Anyone with permission to add comments to the page can add and reply to comments on a file. When you preview a file, you'll see pins for any existing comments. Select a pin to view the comment. Once the conversation is finished, you can resolve the comment to hide it (and any replies) from view. If you need to see resolved comments again, you can reopen them. Go to > Resolved comments in the preview. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 189 You can't comment on files that are hosted on a web server and added to Confluence using their URL, or on files that can't be viewed in the preview (such as videos, zip files, and some other file types). Edit a file Need to go beyond commenting on files? You can even edit some files right from the Confluence page. See Editing Office Files to find out about supported file types and applications. Editing Office Files The Office Connector allows you to edit attached On this page: office files in their native application (such as Word, Editing an attached document Excel, PowerPoint or OpenOffice) and save the file Other ways to edit right back to the Confluence page. No need to Troubleshooting download and re-upload the file. Related pages: The Office Connector is only available for some browsers, operating systems and applications, check Office Connector Prerequisites the Office Connector Prerequisites before you Office Connector limitations and start for the combination that will work best for you. known issues Configuring the Office Connector Editing an attached document To edit an Office document attached to a Confluence page: 1. Go to > Attachments 2. Choose Edit in Office beside the attachment you want edit. Your browser will ask you to confirm that you want to open the file. 3. Choose OK. You may also see a security warning or be asked to log in to your Confluence server - enter your Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence3. 5.8 Documentation 190 Confluence username and password, then choose OK. 4. The file will open in your Office application - make your changes then save the document. It will be saved back to Confluence Screenshot: Edit in Office option on the attachments page Other ways to edit Edit options also appear when a page has: an Attachments macro (choose Edit in Office beside each attached office file) the Office Word macro or the Office Excel macro (choose Edit Document at the top of the embedded content) the Office PowerPoint macro (choose the edit icon at the bottom of the viewer). Screenshots: Edit links on embedded files Troubleshooting Check out the Office Connector Prerequisites for the combinations of browsers, operating systems and office applications that are supported. Here's some common issues: Using Chrome? You can't edit Office documents as Chrome does not support WebDAV clients. See CONF-23322 OPEN Using Firefox? You'll need to install the WebDAV add-on. See Installing the Firefox Add-On for the Office Connector. Using Internet Explorer? You can only edit documents in Microsoft Office. OpenOffice is not supported. Using Linux? You can only edit documents in OpenOffice. Microsoft Office is not supported. See CONF-17250 OPEN . Using Mac OS X? You can't currently edit documents. See CONF-25594 OPEN . Not seeing the Office Connector options? Your system administrator may have disabled all or part of the Office Connector. See Configuring the Office Connector. You can find more troubleshooting info in the Office Connector Limitations and Known Issues knowledge base article. Office Connector Prerequisites Share and collaborate on documents, spreadsheets and presentations with your team. On this page: Viewing Office and PDF files The Office Connector allows you to embed, import, Importing Word documents as and edit office documents (such as Word, Excel and pages PowerPoint) within Confluence. Editing Office files attached to a page The browser, operating system and applications Troubleshooting required depend on what you are trying to do with an office file. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 191 Viewing Office and PDF files Office and PDF files are embedded onto a page using the View File Macro. The macro can display files compatible with Microsoft Office 97-2013, and PDF files, of the following types: .doc and .docx .xls and .xlsx .ppt and .pptx .pdf You do not need to have an Office application installed on your computer in order to view Office files in Confluence. Importing Word documents as pages Confluence can import the content from Microsoft Word 97-2013 documents (.doc and .docx ). Editing Office files attached to a page The Office Connector allows you to edit Office files that are attached to pages. You'll need to use a browser, operating system and application (either Microsoft Office or OpenOffice) as described in the compatibility matrix below. Here's a few common issues: Using Chrome? You can't edit Office documents as Chrome does not support WebDAV clients. See CONF-23322 OPEN Using Firefox? You'll need to install the WebDAV add-on. See Installing the Firefox Add-On for the Office Connector. Using Internet Explorer? You can only edit documents in Microsoft Office. OpenOffice is not supported. Using Linux? You can only edit documents in OpenOffice. Microsoft Office is not supported. See CONF-17250 OPEN . Using Mac OS X? You can't currently edit documents. See CONF-25594 OPEN . Not seeing the Office Connector options? Your system administrator may have disabled all or part of the Office Connector. See Configuring the Office Connector. Configuration matrix You need one of the following software combinations to edit Office files from your Confluence page. Software Operating System Browser Microsoft Office 2013 Windows 7 Internet Explorer 11 Windows 8 Firefox – latest stable version Microsoft Office XP, 2003, 2007, Windows 7 Internet Explorer supported 2010 Windows Vista versions Windows XP (Service Pack 2 Firefox – latest stable version or 3) OpenOffice 2.x – 3.x Windows 7 Firefox – latest stable version Windows Vista Internet Explorer supported Windows XP (Service Pack 2 versions or 3) (Windows Platforms only) Linux Note: The only known supported Office editor for Linux is OpenOffice. But in theory it should work with any Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 192 WebDAV-aware application. If you experience problems editing documents using the Office Connector (using an application, operating system and browser combination above) please raise an issue and tell us as much as you can about your operating system, application version, document version (if its different to the version of Office / Open Office you're using to open the document) and browser. Troubleshooting Having problems with the Office Connector? The WebDAV plugin must be enabled, because the Office Connector uses WebDAV to transfer information to and from Office documents. The WebDAV plugin is bundled with Confluence, and can be enabled or disabled by the System Administrator. If necessary, refer to the instructions on enabling plugins and configuring the WebDAV options. Ensure that your Confluence server's base URL is set correctly (see Configuring the Server Base URL to find out how to check this). When a user edits a Confluence page in Word and then uploads the page back to the Confluence server, the base URL determines where the document will be saved. If the base URL is incorrect, the documents may be saved to a different Confluence server. Using Office 2013? Your administrator will need to enable 'Allow authentication tokens in the URL path' in the Office Connector configuration. See Configuring the Office Connector. See the Office Connector Limitations and Known Issues knowledge base article for more troubleshooting tips. Installing the Firefox Add-On for the Office Connector If you are using Firefox as your browser, you will On this page: need to install an add-on into Firefox (the Firefox WebDAV Launcher) in order to use some features of Installing the Firefox Add-On the Office Connector. You will be prompted to install Configuring the Add-On the add-on the first time you try to use a function Security Risks which requires it. Information about this Firefox add-on For more information on the browsers, operation systems and application combinations required to Related pages: use the Office Connector see Office Connector Editing Office Files Prerequisites. Installing the Firefox Add-On The first time you try to edit an attached Office document in Firefox you'll be prompted to install a WebDAV add-on for your browser. Without this add-on you can't edit Office documents from Firefox. 1. Choose Edit in Office or Edit Document next to the document you wish to edit. You'll see a prompt to download the add-on. 2. Choose OK. Your browser will ask you to confirm that you want to allow the add-on. 3. Choose Allow. An installation dialog like the one below will appear. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence3. 5.8 Documentation 193 4. Choose Install Now. Once the installation is complete you'll be prompted to restart Firefox. Make sure you've saved any open pages or other work in your browser before you restart. 5. Next you need to configure the add-on, and tell it which applications to use. Configuring the Add-On After installing the add-on you need to configure it, to tell the add-on which desktop applications to launch for each file type. Configuring the add-on is slightly different in each operating system. Configuring the add-on in Windows In most cases the add-on will automatically configure itself, based on information from the system registry. The first time The first time you edit a new file type, the add-on will look up the default editor for that file type and make that the permanent setting. If you want to override the registry settings, or the automatic configuration is not working, you can configure the Firefox add-on manually. 1. In Firefox locate the WebDAV Launcher add-on and choose Options. The WebDAV Launcher Options dialog, like the one below, will appear. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 1. Confluence 5.8 Documentation 194 2. Enter a file extension in the File Extension field. For example, to associate the 'doc' file extension with Microsoft Word 2003 you would type doc in the File Extension field. Using Office 2007 or later? You should configure the WebDAV launcher to open both Office 2003 file extensions (doc, ppt and xls) and Office 2007 and later file extensions (docx, xlsx and pptx). 3. Enter the Application Path - you can either: Choose Auto to load the associated application from the Windows registry, or Choose Browse to find the application on your computer, or Manually enter the path to the application's executable file. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 3. Confluence 5.8 Documentation 195 4. Choose Add to add the file extension association to the list. Repeat this process for all the file extensions you need. Configuring the Add-On in Mac OS X The configuration procedure is similar to Windows, as shown above. Note that there is no 'Auto' button in Mac OS X. You can't currently edit documents in Mac OS X. See CONF-25594 OPEN . Configuring the Add-On in Linux The only known supported Office editor for Linux is OpenOffice (see Office Connector Prerequisites). There is no automatic configuration on Linux. You will need to associate each file type with your Office editor in Firefox. Note that there is no 'Auto' button in Linux. The configuration procedure is similar to Windows. For both Ubuntu and OpenSUSE, the configuration will look something like this: File Extension Application Path doc and docx /usr/bin/oowriter ppt and pptx /usr/bin/ooimpress xls and xlsx /usr/bin/oocalc Security Risks Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 196 Please be aware that there are security risks in installing this add-on to Firefox. Internet Explorer is exposed to the same risks, because it can directly open Office documents. Summary of the risks: Office documents can contain macro viruses. Before opening an Office document, make sure that you trust the source of the document. There are known flaws in the Office file formats and Microsoft Office that an attacker can exploit to gain control of your machine. Microsoft has fixed the known exploits in the latest Service Packs for all Microsoft Office versions, but new exploits may arise at any time. Be sure that you trust the source of a document before opening it. The add-on reduces the risk by supporting: Same origin policy - the add-on can only open documents from the same host that initiated the action. Digital signature - the add-on is digitally signed. When you install the add-on please verify that it is signed by Atlassian. Prompt the user for confirmation - You will always be warned before a file is opened. Please read these warnings carefully before opening a file. The warning tells you the complete URL of the file as well as the complete application path of the application opening the file. Information about this Firefox add-on Add-on name: WebDAV Launcher Description: Adds the ability to launch a WebDAV URL directly in a WebDAV-aware client. Latest version: See the WebDAV Launcher add-on page at Mozilla Compatible with: All versions of Firefox, up to and including the latest stable version. Author: Atlassian Pty Ltd Macros Using macros helps you to expand the capabilities of your Confluence pages, allowing you to add extra functionality or include dynamic content. On this page: For example, use the Attachments macro to list files attached to a page, or Add a use the Widget Connector macro to include things like a YouTube video or Macro to Twitter feed. your Page Confluenc e macros Add a Macro to your Page Creating your own macros Including Macros with the Macro Browser Getting more macros from The Marketplac e To add a macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 197 Macro Parameters Many macros have optional parameters you can use to control the macro's output. With the Attachments Macro, for instance, you have two optional parameters allowing you to: Specify the file formats of the attachments displayed Choose whether or not you want old versions of the attachments displayed Macro Placeholders Macro placeholders are displayed in the editor where you have added a macro to the page. When editing a page, you can: Double-click a macro placeholder (or click the placeholder and choose Edit) to open the macro dialog window and edit the macro's parameters Select a macro placeholder to cut, copy and paste the macro Confluence macros Below is a list of the macros currently bundled with Confluence. Click a macro name for details of the usage, including optional parameters and examples. Activity Stream Macro Anchor Macro Attachments Macro Blog Posts Macro Change-History Macro Chart Macro Cheese Macro Children Display Macro Code Block Macro Column Macro Content by Label Macro Content by User Macro Content Report Table Macro Contributors Macro Contributors Summary Macro Create from Template Macro Create Space Button Macro Excerpt Include Macro Excerpt Macro Expand Macro Favourite Pages Macro Gadget Macro Gallery Macro Global Reports Macro HTML Include Macro HTML Macro IM Presence Macro Include Page Macro Info, Tip, Note, and Warning Macros JIRA Chart Macro JIRA Issues Macro JUnit Report Macro Labels List Macro Livesearch Macro Loremipsum Macro Multimedia Macro Navigation Map Macro Network Macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 198 Noformat Macro Office Excel Macro Office PowerPoint Macro Office Word Macro Page Index Macro Page Properties Macro Page Properties Report Macro Page Tree Macro Page Tree Search Macro Panel Macro PDF Macro Popular Labels Macro Profile Picture Macro Recently Updated Dashboard Macro Recently Updated Macro Recently Used Labels Macro Related Labels Macro Roadmap Planner Macro RSS Feed Macro Search Results Macro Section Macro Space Attachments Macro Space Details Macro Space Jump Macro Spaces List Macro Status Macro Table of Contents Macro Table of Content Zone Macro Task Report Macro User List Macro User Profile Macro User Status List Macro View File Macro Widget Connector Macro Creating your own macros Users with System Administrator permissions can create user macros - see Writing User Macros. If you want to create something more complex, you can develop your own plugin - see Writing Confluence Plugins. Getting more macros from The Marketplace You can find a wide range of Atlassian and third party macros at The Marketplace. These are distributed as add-ons and can be installed by a Confluence Administrator. Activity Stream Macro The Activity Stream macro is a specific instance of the Gadget macro. It inserts an Activity Stream gadget onto your page. For instructions, see Activity Stream Gadget. Related pages: Activity Stream Gadget Gadget Macro Anchor Macro Allows you to link to a specific part of a page. For more information on using anchors see Working with Anchors . Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 199 Code Examples The following examples are provided for advanced users who want to edit the underlying markup for a Confluence page. Macro name: anchor Macro body: None. Storage format example here Wiki markup example {anchor:here} Attachments Macro The Attachments macro displays a list of files attached to a page. It also allows users (with appropriate permissions) to: upload a file to the page, directly from the list edit attachment properties and labels delete an attached file (this deletes all versions of the file) preview image attachments edit attached Office and PDF documents using the Office Connector. download all files attached to the page. Note: you can use the macro parameters to turn off previews if you have very large attachments. Screenshot: The Attachments macro, showing details of an attachment Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 200 Using the Attachments Macro To add the Attachments macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 201 Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Filename all A comma-separated list of regular expressions, used to filter the attachments by Patterns file name. Note that the parameter values must be regular expressions. For (patterns) example: To match a file suffix of 'jpg', use .*jpg (not *.jpg). To match file names ending in 'jpg' or 'png', use .*jpg,.*png Attachment (none) A list of labels, used to filter the attachments to display. If you wish to enter more Labels than one label, separate the labels with commas. Confluence will show only (labels) attachments that have all the labels specified. (The match is an AND, not an OR.) For information on labelling the attachments, see Add, Remove and Search for Labels. Include Old false A value of true will include previous attachment versions in the list. Attachment Versions (old) Sort By date The sort order for attachments. Note that people viewing the page can change (sortBy) the sort order by clicking the column headings. Valid values are: date – sorts by updated date in reverse chronological order (newest first) size – sorts largest to smallest name – sorts alphabetically created date - sorts by creation date in reverse chronological order (newest first) Sort Order ascending Used in combination with the Sort By parameter, to sort the attachments in (sortOrder ascending or descending order. ) Allow true If selected, the list of attachments will include options allowing users to browse Upload for, and attach, new files. (upload) Page Title (none) Used to display attachments from another page. If you do not enter a page title, (page) the macro will display the files attached to the current page. Show true Used to display a preview of the attached file. If true, preview will be visible when Previews the list item is expanded. (preview) Code examples The following examples are provided for advanced users who want to edit the underlying markup for a Confluence page. Macro name: attachments Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 202 Macro body: None. Storage format example false .*png,.*jpg name descending chocolate,cookies false Wiki markup example {attachments:old=false|patterns=.*png,.*jpg|sortby=name|page=My page about chocolate|sortorder=descending|labels=chocolate,cookies|upload=false|preview=false} Blog Posts Macro The Blog Posts macro allows you to display blog posts on a Confluence page. Clicking on a title takes you to the blog post. Using the Blog Posts Macro To add the Blog Posts macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 203 Content No titles Available values: Type to Display titles — Display the title, creator, space, and created date stamp for each blog post. (content) excerpts — Display a short excerpt from each blog post. If the post contains an Excerpt macro, the Blog Posts macro will display the content defined in the Excerpt macro. If the post does not contain an Excerpt macro, the Blog Posts macro will display the first few sentences of the post. entire - Display the whole content of each blog post. Time No no limit Specify how far back in time Confluence should look for the blog posts Frame to be displayed. (time) Available values: m — Minutes h — Hours, so '12h' displays blog posts created in the last twelve hours. d — Days, so '7d' displays blog posts created in the last seven days. w — Weeks Restrict to No None Filter the results by label. The macro will display only the blog posts these which are tagged with the label(s) you specify here. Labels (label) You can specify one or more label values, separated by a comma or a space. To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'. To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'. Restrict to No None Filter the results by author. The macro will display only the blog posts these Aut which are written by the author(s) you specify here. hors (author) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 204 Restrict to No @self, i.e. This parameter allows you to filter content by space. The macro will these the space display only the pages which belong to the space(s) you specify here. Spaces which (spaces) contains You can specify one or more space keys, separated by a comma or a the page space. on which the macro To exclude content in a specific space, put a minus sign (-) is coded immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE. To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.) Special values: @self — The current space. @personal — All personal spaces. @global — All site spaces. @favorite — The spaces you have marked as favourite. @favourite — The same as @favorite above. @all — All spaces in your Confluence site. * — The same as @all above. When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or ~jbloggs@example. com. Maximum No 15 Specify the maximum number of results to be displayed. Note that the Number of results are sorted first, and then the maximum parameter is applied. Blog Posts (max) Sort By No creation Specify how the results should be sorted. If this parameter is not (sort) specified, the sort order defaults to descending order (newest first) based on the creation date. Values: title — Sort alphabetically by title. creation — Sort by the date on which the content was added. modified — Sort by the date on which the content was last updated. Reverse No false Select to change the sort from descending to ascending order (oldest Sort first). Use this parameter in conjunction with the Sort By parameter. (reverse This parameter is ignored if the Sort By parameter is not specified. ) In storage format and wikimarkup a value of true changes the sort order. Code examples The following examples are provided for advanced users who want to edit the underlying markup for a Confluence page. Macro name: blog-posts Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 205 Macro body: None. Storage format example titles 4w creation 10 chocolate,cookies Wiki markup example {blog-posts:content=titles|spaces=@self,ds|author=jsmith|time=4w|reverse=true|sort= creation|max=10|label=chocolate,cookies} Change-History Macro The Change-History macro shows the history of updates made to a page: version number, author, date and comment. It displays the information inline. Screenshot: The Change-History macro in Confluence To add the Change-History macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Note: There are no parameters for this macro. Code examples The following examples are provided for advanced users who want to edit the underlying markup for a Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 206 Confluence page. Macro name: change-history Macro body: None. Parameters: None. Storage format example Wikimarkup example {change-history} Chart Macro The Chart macro allows you to display a chart based on tabular data. When you add the macro to a page, you: supply the data to be charted by the macro as a table in the placeholder of the macro. edit the macro parameters in the Macro Browser to configure the format of the chart. Screenshot 1: A table of data in the Chart macro placeholder Screenshot 2: The resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 207 On this page: Using the Chart Macro Parameters Examples Pie Chart Bar Chart 3D Bar Chart Time Series Chart XY Line Chart XY Area Chart Area Charts Gantt Chart Code examples Chart type parameters Chart display parameters Chart title and label parameters Chart data parameters Chart colour parameters Chart axis parameters Pie chart Parameters Chart attachment parameters Wiki markup example Using the Chart Macro To add the Chart macro to a page: 1. Edit the page and use autocomplete to add the Chart macro. (Type '{chart}'.) 2. Enter your chart data as one or more tables in the body of the macro placeholder. (See the screenshot ab Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 208 2. ove.) 3. Click the macro placeholder and choose Edit. 4. Select a chart type using the Type parameter (see below). 5. Choose other parameter settings in the macro browser, as described below. 6. Click Refresh in the 'Preview' area, to check that the chart appears as you expect. 7. Click Save to add the chart to your page. 8. Click Save again when you are ready to save the page. Parameters Chart Type Parameters | Display Control Parameters | Title and Label Parameters | Data Specification Parameters | Colour Parameters | Axis Parameters | Pie Chart Parameters | Attachment Parameters Chart Type Parameters These parameters determine the type of chart to display and the way the chart looks. Parameter Default Description Type pie The type of chart to display. XY charts have numerical x- and y-axes. The x values may optionally be time-based (see the Time Series param eter). Standard — pie, bar, line, area XY Plots — xyArea, xyBar, xyLine, xyStep, xyStepArea, scatter, timeSeries Other — gantt Display vertical Applies to area, bar and line charts. Orientation vertical — y-axis is vertical horizontal — x-axis is vertical Show in false Applies to area, bar and line charts. 3D Stacked false Applies to area and bar charts. Values Show true Applies to line charts. Shapes are shown at each data point. shapes Opacity 75 percent for A percentage value between 0 (transparent) and 100 (opaque) that 3D charts determines how opaque the foreground areas and bars are. 50 percent for non-stacked area charts 100 percent for all other charts Display Control Parameters Parameter Default Description Width 300 The width of the chart in pixels. Height 300 The height of the chart in pixels. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 209 Display false Sets whether to display the rendered body of the macro (usually the data tables). rendered data By default, the chart data table isn't rendered. before — the data are displayed before the chart. after — the data are displayed after the chart. Image format png The image format to be used for the chart. png jpg Title and Label Parameters Parameter Default Description Chart Title none The title of the chart. Chart Subtitle none A subtitle for the chart, using a smaller font than for Title. Horizontal-axis Label none The label for the x-axis (domain). Vertical-axis Label none The label for the y-axis (range). Show Legend true Show a legend or key. Data Specification Parameters The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined in Confluence will be tried. Additional conversion options can be specified using the parameters below. Parameter Default Description Tables all first Comma separated list of table ids and/or table numbers (starting at 1) contained level tables within the body of the macro that will be used as the data for the chart. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros). Columns all columns Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row. Content horizontal vertical — data table columns will be interpreted as series. Orientation horizontal — data tables rows will be interpreted as series. Time false true — the x values in an XY plot will be treated as time series data and Series so will be converted according to date formats. Date Confluence For time series data, the date format allows for additional customization of the format language conversion of data to date values. If a Date format is specified, it will be the first defined format used to interpret date values. Specify a format that matches the time date series data. See simple date format. formats Time Day The time period for time series data. Defines the granularity of how the data is Period interpreted. Valid values are: Millisecond, Second, Minute, Hour, Day, Week, Month, Quarter, Year. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 210 Language none Use in combination with the Country parameter to form a locale. These additional number and date formats will be used for data conversion before the default languages. Valid values are 2 character ISO 639-1 alpha-2 codes. Country none Use in combination with the Language parameter to form a locale. Valid values are 2 character ISO 3166 codes. Forgive true true — the macro tries to convert numeric and date values that do not totally match any of the default or user-specified formats. false — enforce strict data format. Data format errors will cause the chart to not be produced. Colour Parameters Colours are specified using hexadecimal notation or HTML colour names. Parameter Default Description Background White Background of the chart. Colour Border Colour no Border around the chart. border Colours Comma-separated list of colours used to customise category, sections, and series colours. Axis Parameters Depending on the chart type, the range and domain axis may be customised. These values are automatically generated based on the data but can be overridden by specifying one or more more of these parameters. Parameter Default Description Range none Range axis lower bound. Minimum Value Range none Range axis upper bound. Maximum Value Range none Range axis units between axis tick marks. Axis Tick Unit Range none Angle for the range axis label in degrees. Axis Label Angle Domain none Only applies to XY plots. Domain axis lower bound. For a date axis, this value must be Axis expressed in the date format specified by the Date format parameter. Lower Bound Domain none Only applies to XY plots. Domain axis upper bound. For a date axis, this value must Axis be expressed in the date format specified by the Date format parameter. Upper Bound Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 211 Domain none Only applies to XY plots. Domain axis units between axis tick marks. For a date axis, Axis Tick this value represents a count of the units specified in the Time Period parameter. The Unit Time Period unit can be overridden by specifying a trailing character: y (years), M (months), d (days), h (hours), m (minutes), s (seconds), u (milliseconds). Domain none Only applies to XY plots. The angle for the domain axis label, in degrees. Axis Label Angle Category none Placement of the axis label text for categories. Label up45 Position — 45 degrees going upward up90 — 90 degrees going upward down45 — 45 degrees going downward down90 — 90 degrees going downward Date Tick start Placement of the date tick mark. Mark start Position — tick mark is at the start of the date period. middle — tick mark is in the middle of the date period. end — tick mark is at the end of the date period. Pie Chart Parameters Parameter Default Description Pie Section Show only the pie Format for how pie section labels are displayed. The format uses a Label section key value string with special replacement variables: %0% is replaced by the pie section key. %1% is replaced by the pie section numeric value. %2% is replaced by the pie section percent value. Example 1: "%0% = %1%" would display something like "Independent = 20" Example 2: "%0% (%2%)" would display something like "Independent (20%)" Pie Section No exploded Comma separated list of pie keys that are to be shown exploded. Note: Explode sections requires jFreeChart version 1.0.3 or higher. Attachment Parameters These are advanced options that can be used for chart versioning, to enable automation and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the Cache Pluginto improve performance. Depending on the options chosen, chart images can be versioned for historical purposes. Parameter Default Description Attachment none The name and location with which the chart image will be saved as an attachment. The user must be authorised to add attachments to the page specified. âttachmentName.png — the chart is saved as an attachment to the current page. pageâttachmentName.png — the chart is saved as an attachment to the page name provided. space:pageâttachmentName.png — the chart is saved as an attachment to the page name provided in the space indicated. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 212 Attachment new Defines the the versioning mechanism for saved charts. Version new — creates new version of the attachment. replace — replaces all previous versions of the chart. To replace an existing attachment, the user must be authorized to remove attachments for the page specified. keep — only saves a new attachment if an existing export of the same name does not exist. An existing attachment will not be changed or updated. Attachment none Comment used for a saved chart attachment. Comment Thumbnail false true — the chart image attachment will be shown as a thumbnail. Chart Type Parameters | Display Control Parameters | Title and Label Parameters | Data Specification Parameters | Colour Parameters | Axis Parameters | Pie Chart Parameters | Attachment Parameters Examples Pie Chart Parameters in Macro Data Table in Macro Rendered Chart Browser Placeholder Type pie Fish Type 2011 Chart Title Fish Sold 2011 Herring 9,500 Show Legend true Salmon 2,900 Content vertical Tuna 1,500 Orientation Bar Chart Parameters in Macro Data Table in Macro Rendered Chart Browser Placeholder Type bar Fish Type 2010 2011 Chart Title Fish Sold Herring 9,500 8,300 Show true Salmon 2,900 4,200 Legend Tuna 1,500 1,500 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 213 3D Bar Chart Parameters in Data Table in Macro Rendered Chart Macro Browser Placeholder Type bar 2009 2010 2011 Show in 3D true Revenue 12.4 31.8 41.1 Opacity 50 Expense 43.6 41.8 31.1 Show Legend true Time Series Chart Parameters in Data Tables in Macro Placeholder Rendered Chart Macro Browser Type Time Series Month Revenue Month Expenses Date MM/yyyy 1/2011 31.8 1/2011 41.1 Format 2/2011 41.8 2/2011 43.8 Time Month Period 3/2011 51.3 3/2011 45.3 4/2011 33.8 4/2011 45.0 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 214 Content vertical 5/2011 27.6 5/2011 44.6 Orientation 6/2011 49.8 6/2011 43.8 Range 0 7/2011 51.8 7/2011 51.8 Axis Lower 8/2011 77.3 8/2011 52.3 Bound 9/2011 73.8 9/2011 53.8 Show true Legend 10/2011 97.6 10/2011 55.6 11/2011 101.2 11/2011 61.2 12/2011 113.7 12/2011 63.7 XY Line Chart Parameters in Macro Data Table in Macro Rendered Chart Browser Placeholder Type xyLine 12 14 23 Show Legend true Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6 XY Area Chart Parameters in Macro Data Table in Macro Rendered Chart Browser Placeholder Type xyArea 12 14 23 Show true Legend Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 215 Area Charts Example 1 Parameters in Data Table in Macro Placeholder Rendered Chart Macro Browser Type area Satisfaction 2009 2010 2011 Show true Legend Very 20 23 34 satisfied Width 300 Satisfied 40 34 23 Height 300 Dissatisfied 25 26 25 Opacity 50 Very 15 17 18 dissatisfied Example 2 Parameters Data Table in Macro Placeholder Rendered Chart in Macro Browser Type area Satisfaction 2009 2010 2011 Show true Legend Very 12 23 31 satisfied Width 300 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 216 Height 300 Satisfied 1 34 36 Stacked true Dissatisfied 4 6 22 Values Very 2 7 12 dissatisfied Gantt Chart Parameters in Macro Data Table in Macro Placeholder Rendered Chart Browser Type gantt Plan Start End Status Width 300 Stage 1 6/25/2013 7/10/2013 30% Height 200 Columns ,,1,2,3,4 Stage 2 7/13/2013 11/28/2013 40% Date MM/dd/yyyy Stage 3 12/1/2013 12/25/2013 format Actual Start End Status Stage 6/25/2013 7/26/2013 100% 1 Stage 7/29/2013 12/01/2013 40% 2 Stage 12/10/2013 12/25/2013 3 Code examples The following examples are provided for advanced users who want to edit the underlying markup for a Confluence page. Macro name: chart Macro body: Accepts rich text, consisting of tables that hold the chart's data. This macro recognises a large number of parameters, listed here by type for convenience. See all parameters... Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 217 Chart type parameters These parameters determine the type of chart to display and how the chart looks. Parameter Required Default Description type No pie The type of chart to display. XY charts have numerical x- and y-axes. The x values may optionally be time-based. See the timeSeries parameter. Available values: Standard charts - pie, bar, line, area XY plots – xyArea, xyBar, xyLine, xyStep, xyStepArea, scatter, timeSeries Other charts – gantt orientation No vertical The display orientation. Applies to area, bar and line charts. Available values: vertical – y-axis is vertical horizontal – x-axis is vertical 3D No false Show in three dimensions. Applies to area, bar and line charts. stacked No false Stacked values. Applies to area and bar charts. showShapes No true Applies to line charts. Shapes are shown at each data point. opacity No 75 percent A percentage value between 0 (transparent) and 100 for 3D (opaque) that determines how opaque the foreground charts areas and bars are. 50 percent for non-stacked area charts 100 percent for all other charts Chart display parameters Parameter Required Default Description width No 300 The width of the chart in pixels. height No 300 The height of the chart in pixels. dataDisplay No false Determines whether to display the body of the macro, consisting of the data table. By default, the chart data table is not displayed. Available values: false – the data is not displayed. true or after – the data is displayed after the chart. before – the data is displayed before the chart. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 218 imageFormat No png The image format to be used for the chart. Available values: png jpg Chart title and label parameters Parameter Required Default Description title No (None) The title of the chart. subTitle No (None) A subtitle for the chart. xLabel No (None) The label for the x-axis (domain). yLabel No (None) The label for the y-axis (range). legend No false Determines whether to show a legend (key) for the chart. Chart data parameters The data for the chart is taken from tables found in the macro body. The parameters below control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined in Confluence will be tried. You can specify additional conversion options using the parameters below. Parameter Required Default Description tables No All first level You can supply a comma-separated list of table IDs tables and/or table numbers (starting at 1) contained within the body of the macro that will be used as the data for the chart. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros). columns No All columns You can supply a comma-separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the HTML title attribute for the column in the header row. dataOrientation No horizontal The content orientation. By default, the data tables will be interpreted as columns (horizontally) representing domain and x values. Available values: vertical – data table columns will be interpreted as series. horizontal – data tables rows will be interpreted as series. timeSeries No false If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 219 dateFormat No Confluence For time series data, the date format allows for language additional customisation of the conversion of data to defined date date values. If a dateFormat is specified, it will be the formats first format used to interpret date values. Specify a format that matches the time series data. See simple date format. timePeriod No day The time period for time series data. Defines the granularity of how the data is interpreted. Available values: millisecond, second, minute, hour, day, week, month, quarter, year language No (None) Use in combination with the country parameter to form a locale. These additional number and date formats will be used for data conversion before the default languages. Available values are the two-character ISO 639-1 alpha-2 codes. country No (None) Use in combination with the language parameter to form a locale. Valid values are the two-character ISO 3166 codes. forgive No true Determines whether the macro will forgive (allow) some data formatting errors. Available values: true — the macro tries to convert numeric and date values that do not totally match any of the default or user-specified formats. false — the macro enforces strict data formatting. If there are data format errors, the chart will not be produced. Chart colour parameters Colours are specified using hexadecimal notation or HTML colour names. Parameter Required Default Description bgColor No White Background colour of the chart. borderColor No No Colour of the border around the chart. border colors No A comma-separated list of colours used to customise the colours of categories, sections, and series. Chart axis parameters Depending on the chart type, the range and domain axis may be customised. These values are automatically generated based on the data but can be overridden by specifying one or more more of these parameters. Parameter Required Default Description rangeAxisLowerBound No (None) Minimum value for the range axis. rangeAxisUpperBound No (None) Maximum value for the range axis. rangeAxisTickUnit No (None) Range axis units between axis tick marks. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 220 rangeAxisLabelAngle No (None) Angle for the range axis label in degrees. domainAxisLowerBound No (None) Only applies to XY plots. Domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. domainAxisUpperBound No (None) Only applies to XY plots. Domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. domainAxisTickUnit No (None) Only applies to XY plots. Domain axis units between axis tick marks. For a date axis, this value represents a count of the units specified in the timePeriod par ameter. The timePeriod unit can be overridden by specifying a trailing character: y (years), M (months), d (days), h (hours), m (minutes), s (seconds), u (millis econds). domainAxisLabelAngle No (None) Only applies to XY plots. The angle for the domain axis label, in degrees. categoryLabelPosition No (None) Placement of the axis label text for categories. Available values: up45 — 45 degrees going upward up90 — 90 degrees going upward down45 — 45 degrees going downward down90 — 90 degrees going downward dateTickMarkPosition No start Placement of the date tick mark. Available values: start — tick mark is at the start of the date period. middle — tick mark is in the middle of the date period. end — tick mark is at the end of the date period. Pie chart Parameters Parameter Required Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 221 pieSectionLabel No Show only the Formatof pie section labels. The format uses a pie section key string with special replacement variables: value %0% is replaced by the pie section key. %1% is replaced by the pie section numeric value. %2% is replaced by the pie section percent value. Example 1: To display something like 'Independent = 20': %0% = %1% Example 2: To display something like 'Independent (20%)': %0% (%2%) pieSectionExplode No No exploded A comma-separated list of pie keys that are to be sections shown exploded. Note: requires jFreeChart version 1.0.3 or higher. Chart attachment parameters These are advanced options that can be used for chart versioning, to enable automation and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access to re-use the attachment. This can be useful especially when combined with the Cache plugin to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes. Parameter Required Default Description attachment No (None) The name and location where the chart image will be saved as an attachment. The user must be authorised to add attachments to the page specified. Available syntax for this parameter: âttachmentName.png — the chart is saved as an attachment to the current page. page nameâttachmentName.png — the chart is saved as an attachment to the page name provided. spacekey:page nameâttachmentName.png — the chart is saved as an attachment to the page name provided in the space indicated. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 222 attachmentVersion No new Defines the the versioning mechanism for saved charts. Available values: new — creates new version of the attachment. replace — replaces all previous versions of the chart. To replace an existing attachment, the user must be authorised to remove attachments for the page specified. keep — only saves a new attachment if an existing export of the same name does not exist. An existing attachment will not be changed or updated. attachmentComment No (None) Comment used for a saved chart attachment. thumbnail No false If true, the chart image attachment will be shown as a thumbnail (small, expandable) image. Storage format example Below is a simple example of a pie chart. See more examples in Storage Format Examples for Chart Macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 223 Fish Sold pie Fish Type 2004 2005 Herring 9,500 8,300 Salmon 2,900 4,200 Tuna 1,500 1,500 Wiki markup example Below is a simple example of a pie chart. See more examples in Wiki Markup Examples for Chart Macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 224 {chart:type=pie|title=Fish Sold} || Fish Type || 2004 || 2005 || || Herring | 9,500 | 8,300 | || Salmon | 2,900 | 4,200 | || Tuna | 1,500 | 1,500 | {chart} Confluence Storage Format Examples for Chart Macro This page is an extension of the documentation for the Chart Macro. This page contains additional examples for the Chart macro. Pie chart Here is a simple example of a pie chart. Storage format Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 225 Fish Sold pie Fish Type 2004 2005 Herring 9,500 8,300 Salmon 2,900 4,200 Tuna 1,500 1,500 Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 226 Bar chart Here is a simple example of a bar chart. Storage format Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 227 Fish Sold bar Fish Type 2004 2005 Herring 9,500 8,300 Salmon 2,900 4,200 Tuna 1,500 1,500 Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 228 Time series chart Here is an example of a time series chart. Storage format Month vertical 0 MM/yyyy timeSeries true Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 230 Month Revenue 1/2005 31.8 2/2005 41.8 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 229 3/2005 51.3 4/2005 33.8 5/2005 27.6 6/2005 49.8 7/2005 51.8 8/2005 77.3 9/2005 73.8 10/2005 97.6 11/2005 101.2 12/2005 113.7 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 231 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 232 Month Expenses 1/2005 41.1 2/2005 43.8 3/2005 45.3 4/2005 45.0 5/2005 44.6 6/2005 43.8 7/2005 51.8 8/2005 52.3 9/2005 53.8 10/2005 55.6 11/2005 61.2 12/2005 63.7 Resulting chart XY line chart Here is an example of an XY line chart. Storage format Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 233 xyline 12 14 23 Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6 Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 234 XY bar chart Here is an example of an XY bar chart. Storage format Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 235 60 xybar 2005 2006 2007 Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6 Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 236 XY area chart Here is an example of an XY area chart. Storage format Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 237 xyarea 12 14 23 Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6 Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 238 Area chart Here are two examples of area charts. Storage format for area chart 1 300 true 300 50 area true Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 240 Satisfaction 2002 2003 2004 Very satisfied 20 23 34 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 239 Satisfied 40 34 23 Disatisfied 25 26 25 Very disatisfied 15 17 18 Resulting area chart 1 Satisfaction 2002 2003 2004 Very satisfied 20 23 34 Satisfied 40 34 23 Disatisfied 25 26 25 Very disatisfied 15 17 18 Storage format for area chart 2 true 300 true 300 area true Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 241 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 242 Satisfaction 2002 2003 2004 Very satisfied 12 23 31 Satisfied 1 34 36 Disatisfied 4 6 22 Very disatisfied 2 7 12 Resulting area chart 2 Satisfaction 2002 2003 2004 Very satisfied 12 23 31 Satisfied 1 34 36 Disatisfied 4 6 22 Very disatisfied 2 7 12 Wiki Markup Examples for Chart Macro This page is an extension of the documentation for the Chart Macro. This page contains additional examples for the Chart macro. Pie chart Here is a simple example of a pie chart. Wiki markup {chart:type=pie|title=Fish Sold} || Fish Type || 2004 || 2005 || || Herring | 9,500 | 8,300 | || Salmon | 2,900 | 4,200 | || Tuna | 1,500 | 1,500 | {chart} Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 243 Bar chart Here is a simple example of a bar chart. Wiki markup {chart:type=bar|title=Fish Sold} || Fish Type || 2004 || 2005 || || Herring | 9,500 | 8,300 | || Salmon | 2,900 | 4,200 | || Tuna | 1,500 | 1,500 | {chart} Resulting chart Time series chart Here is an example of a time series chart. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 244 Wiki markup {chart:type=timeSeries|dateFormat=MM/yyyy|timePeriod=Month| dataOrientation=vertical|rangeAxisLowerBound=0|domainaxisrotateticklabel=true} || Month || Revenue || | 1/2005 | 31.8 | | 2/2005 | 41.8 | | 3/2005 | 51.3 | | 4/2005 | 33.8 | | 5/2005 | 27.6 | | 6/2005 | 49.8 | | 7/2005 | 51.8 | | 8/2005 | 77.3 | | 9/2005 | 73.8 | | 10/2005 | 97.6 | | 11/2005 | 101.2 | | 12/2005 | 113.7 | || Month || Expenses || | 1/2005 | 41.1 | | 2/2005 | 43.8 | | 3/2005 | 45.3 | | 4/2005 | 45.0 | | 5/2005 | 44.6 | | 6/2005 | 43.8 | | 7/2005 | 51.8 | | 8/2005 | 52.3 | | 9/2005 | 53.8 | | 10/2005 | 55.6 | | 11/2005 | 61.2 | | 12/2005 | 63.7 | {chart} Resulting chart XY line chart Here is an example of an XY line chart. Wiki markup Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 245 {chart:type=xyline} || || 12 || 14 || 23 || | Revenue | 41.1 | 31.8 | 12.4 | | Expense | 31.1 | 41.8 | 43.6 | {chart} Resulting chart XY bar chart Here is an example of an XY bar chart. Wiki markup {chart:type=xybar|opacity=60} || || 2005 || 2006 || 2007 || | Revenue | 41.1 | 31.8 | 12.4 | | Expense | 31.1 | 41.8 | 43.6 | {chart} Resulting chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 246 XY area chart Here is an example of an XY area chart. Wiki markup {chart:type=xyarea} || || 12 || 14 || 23 || | Revenue | 41.1 | 31.8 | 12.4 | | Expense | 31.1 | 41.8 | 43.6 | {chart} Resulting chart Area chart Here are two examples of area charts. Wiki markup for area chart 1 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 247 {chart:type=area|dataDisplay=true|legend=true|width=300|height=300|opacity=50} || Satisfaction || 2002 || 2003 || 2004 || | Very satisfied | 20 | 23 | 34 | | Satisfied | 40 | 34 | 23 | | Disatisfied | 25 | 26 | 25 | | Very disatisfied | 15 | 17 | 18 | {chart} Resulting area chart 1 Satisfaction 2002 2003 2004 Very satisfied 20 23 34 Satisfied 40 34 23 Disatisfied 25 26 25 Very disatisfied 15 17 18 Wiki markup for area chart 2 {chart:type=area|dataDisplay=true|legend=true|width=300|height=300|stacked=true} || Satisfaction || 2002 || 2003 || 2004 || | Very satisfied | 12 | 23 | 31 | | Satisfied | 1 | 34 | 36 | | Disatisfied | 4 | 6 | 22 | | Very disatisfied | 2 | 7 | 12 | {chart} Resulting area chart 2 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 248 Satisfaction 2002 2003 2004 Very satisfied 12 23 31 Satisfied 1 34 36 Disatisfied 4 6 22 Very disatisfied 2 7 12 Cheese Macro The Cheese macro simply displays the words "I like cheese!" You can use this macro to test the Confluence macro functionality. To add the Cheese macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Note: There are no parameters for this macro. Code examples The following examples are provided for advanced users who want to edit the underlying markup for a Confluence page. Macro name: cheese Macro body: None. Parameters: None Storage format example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 249 Wiki markup example {cheese} Children Display Macro Use the Children Display macro to list the child pages of a page and the further descendants (children's children). By default, the macro displays links to the child pages as shown in the screenshot below. People viewing the page will see only the links for pages that they have permission to view. Screenshot: The Children Display macro in Confluence Using the Children Display macro To add the Children Display macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Example This list of child pages is generated by a Children Display macro on this page: Child Page 1 Child Page 2 Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Show false Choose whether to display all the parent page's descendants. Descendants true (all) If shows the complete tree of pages underneath the parent page, regardless of Depth of Descendants Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 250 Parent Page current Specify the page to display children for, from either the current (page) space or a different space. Enter: '/' — to list the top-level pages of the current space, i.e. those without parents. 'pagename' — to list the children of the specified page. 'spacekey:' — to list the top-level pages of the specified space. 'spacekey:pagename' — to list the children of the specified page in the specified space. Number of none Restrict the number of child pages that are displayed at the top Children level. (first) Depth of none Enter a number to specify the depth of descendants to display. For Descendants example, if the value is 2, the macro will display 2 levels of child (depth) pages. This setting has no effect of Show Descendants is enabled. Heading none Choose the style used to display descendants. Style (style) Include false If you have an excerpt macro on any of the returned pages, Excerpts checking this option will display the first line of the excerpt. (excerpt) For pages without an excerpt macro, nothing is displayed. Sort Manual if manually Optional. Choose: Children By ordered, otherwise (sort) alphabetical creation — to sort by content creation date title — to sort alphabetically on title modified — to sort of last modification date. Reverse Sort false Use with the Sort Children By parameter. When set, the sort order (reverse) changes from ascending to descending. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: children Macro body: None. Storage format example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 251 true creation h4 true 99 2 true Wiki markup example {children:reverse=true|sort=creation|style=h4|page=Home|excerpt=true|first=99|depth =2|all=true} Child Page 1 Grandchild Child Page 2 This page is used to test the {children} macro. Related Topics Children Display Macro Code Block Macro The Code Block macro allows you to display source code in your page with the appropriate syntax highlighting, as shown below: public static void main(String[] args) { System.out.println("Hello World!"); } Add the Code Block Macro 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. You type the code block directly into the macro placeholder in the editor. Note that any white space contained in the placeholder is not manipulated in any way by the Code Block macro. This is to provide the writer with flexibility over code indentation. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 252 Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Syntax java Specifies the language (or environment) for syntax highlighting. The default highlighting language is Java but you can choose from one of the following (language) languages/environments: actionscript3 bash csharp (C#) coldfusion cpp (C++) css delphi diff erlang groovy html/xml java javafx javascript none (no syntax highlighting) perl php powershell python ruby scala sql vb Title none Adds a title to the code block. If specified, the title will be displayed in a header row at the top of the code block. Collapsible false If selected, the code macro's content will be collapsed upon visiting or refreshing (collapse) the Confluence page. Clicking the expand source link allows you to view this content. If false, the code macro's content is always displayed in full. Show line false If selected, line numbers will be shown to the left of the lines of code. numbers (linenumbers ) First line 1 When Show line numbers is selected, this value defines the number of the first number line of code. (firstline) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 253 Theme Default Specifies the colour scheme used for displaying your code block. Many of these themes are based on the default colour schemes of popular integrated development environments (IDEs). The default theme is Confluence (also known as Default), which is typically black and coloured text on a blank background. However, you can also choose from one of the following other popular themes: DJango Emacs FadeToGrey Midnight RDark Eclipse Confluence Configure the Code Block macro You can configure the Code Block macro to use a specific language and theme by default and also upload new lanuages. You need Confluence Administrator permissions to change the default theme and language and Sy stem Administrator permissions to upload new languages. To set the default appearance of code blocks in your site: 1. Choose the cog icon , then choose General Configuration under Confluence Administration 2. Choose Configure Code Macro 3. Select a Default Theme and Default Language 4. Choose Save All new code blocks will use the default theme and language unless you specify otherwise. Existing code blocks will be unchanged. To add an additional language: 1. Choose the cog icon , then choose General Configuration under Confluence Administration 2. Choose Configure Code Macro 3. Choose Add a new language 4. Locate your language file and enter a Name for the new language (this will appear when selecting the language) 5. Choose Add Language files must be correctly formatted JavaScript files and adhere to the Custom Brush syntax. You can find some examples of language files here. To disable or remove a user-installed language: 1. Choose the cog icon , then choose General Configuration under Confluence Administration 2. Choose Manage Add-ons 3. Go to User-installed Add-ons and locate the add-on for your uploaded language - it will appear like this 'Custom Code Macro Highlighting for...' 4. Choose Uninstall or Disable The language will no longer appear in the Code Macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: code Macro body: Accepts plain text. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 254 Storage format example The following example shows all parameters and a body:This is my title FadeToGrey true xml 0001 true This is my code]]> Below are three examples of the Code Block macro with various optional parameters used. Description Markup What you will get Code block macro with this is a body and parameters Code block macro with this is a body and html/xml language pa defined Code block macro with This a body and This is my title optional title is , line true my html/xml title parameters my code Wiki markup example {code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=html/xml|firstline=0001|collapse=t rue} This is my code {code} Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 255 Column Macro Used with the Section macro to define columns on a page. See Working with page layouts and columns and sections . Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: column Macro body: Accepts rich text. Parameter Required Default Parameter description and accepted values name width No 100% of the page width, The width of the column. Can be specified either in divided equally by the pixels (for example, 400px) or as a percentage of number of columns in the the available page width (for example, 50%). section. Storage format example 100px This is the content of column 1. Wiki markup example {column:width=100px} This is the content of *column 1*. {column} Content by Label Macro The Content by Label macro is used to display lists of pages, blog posts or attachments that have particular labels. It's great for collecting related pages together and filtering out content that you don't want to see. For example, you could use this macro to display a list of all pages that have the label 'feature-shipped' and include the word 'Blueprint', or to list any pages with the label 'meeting-notes' that you've been mentioned in. Here's how the macro looks on your page: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 256 And here's how you would set it up in the macro browser: Using the Content by Label Macro To add the Content by Label macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 257 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. CQL fields This macro uses CQL (Confluence Query Language) to return matching content, such as pages. You can add as many fields as you need to narrow down your search. Here's some tips... Use the Add Field link to add additional filters to your query. Add as many fields as you need. For an OR search, specify multiple values in the same field. So to show pages with 'label-a', 'label-b' or both you'd put 'label-a' and 'label-b' in the same Label field, like this: For an AND search, add more than one field and specify a single value in each. To show only pages with label-a and label-b you'd put 'label-a' in one label field, then add a second Label field to the macro, and put 'label-b' in the second one, like this: Put simply, OR values are entered in the same field, AND values are entered in different fields. Only some fields support AND. If the field does not support the AND operator, you won't be able to add that field more than once. For a NOT search, enter a minus sign (-) before the label. This will exclude everything with that label. You can use these CQL fields to build your query. Field Required Description Operators Label Yes Include pages, blog posts or attachments with these OR (multiple values in the labels. same field) AND (multiple Label fields) With No Include pages that are children of this page. OR (multiple values in the ancestor same field) This allows you to restrict the macro to a single page tree. Contributor No Include pages or blog posts that were created or OR (multiple values in the edited by these people. same field) Creator No Include items created by these people. OR (multiple values in the same field) Mentioning No Include pages and blog posts that @mention these OR (multiple values in the user people. same field) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 258 With parent No Include only direct children of this page (further EQUALS (one page only) sub-pages won't be included) In space No Include items from these spaces. OR (multiple values in the same field) Including No Include items that contain this text. CONTAINS (single word text or phrase) With title No Include items that contain this text in the title. CONTAINS (single word or phrase) Of type No Include only pages, blogs or attachments. OR (multiple values in the same field) Macro display options These options control how the macro appears on your page. Parameter Default Description Sort by Modified Sort the list by title, the date it was created or the date it was last modified. Reverse sort False Sort the list descending instead of ascending (Z - A, earliest - latest) Maximum number 15 Limit the number of items to include in the list. of pages List title Blank Include an optional heading for the macro Show labels for True Show or hide the labels applied to each item each page Show space name False Show or hide the space name for each item for each page Display excerpts False Show an excerpt from the page or blog post (the page or blog post needs an excerpt macro to be able to show an excerpt). Content by User Macro The Content by User macro generates a tabulated list of the content items, throughout the Confluence installation, that have been created by a specified Confluence user. The list includes all current pages, comments and spaces created by the user. Each item in the table is linked to its corresponding page, page comment or space dashboard. Note that items for page comments contain a link to the page, followed by a second link to the comment itself, with these separated by a greater-than sign (>). Using the Content by User macro To add the Content by User macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 259 where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description Username yes none The Confluence username for a person who has created content. (name) Parameter is unnamed in wikimarkup. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: content-by-user Macro body: None. Storage format example Wikimarkup example {content-by-user:jsmith} Content Report Table Macro The Content Report Table macro displays a set of pages and blog posts in tabular format, based on the labels specified in the macro parameters. A working example Below is a working example of the Content Report Table macro, displaying content with the label 'LDAP'. Error rendering macro 'content-report-table' : In template Confluence.Templates.User.userLinkUrl: When evaluating "contextPath()": Error while computing function "contextPath()": null Using the Content Report Table Macro To add the Content Report Table macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 260 where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description Label(s) Yes None This parameter is required. Specify one or more labels, separated by a (labels) comma. The macro will display the content tagged with any of the label(s) specified here. For example, if you specify labels 'A' and 'B', the macro will display all pages that have the label 'A', and all pages that have the label 'B', and all pages that have both those labels. Space(s) No (All Specify one or more space keys, separated by a comma or a space. (spaces) spaces) The macro will display only the content which belongs to the space(s) specified here. When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or ~jbloggs@example .com. Maximum No 20 Define the maximum number of pages that the macro will show in a Number of single set of results. If there are more pages to be shown, the macro Pages will display a link labelled 'Find more results'. People viewing the page (maxResults can choose the link to go to a search view, which shows all pages ) tagged with the specified label(s). Which pages will appear? Before displaying the results, Confluence will sort them by the date the page was last modified. The most-recently created/updated pages will appear first. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: content-report-table Macro body: None. Storage format example LDAP meeting-notes 5 Wiki markup Wiki markup is not available for this macro. You cannot add this macro via wiki markup. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 261 Contributors Macro The Contributors macro displays a list of Confluence users who have made a contribution of some type to a page. It can also be used to list watchers of the page. The scope of this macro can be extended to include the immediate children or descendants of the specified page. The list of contributors can be based on people who have: authored or edited the page(s) contributed comments or added labels to the page(s), or are simply watching the page(s). Screenshot: Example list of Contributors In this example, the Display Format parameter has been set to list. Using the Contributors Macro To add the Contributors macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Contribution Type authors Filters by either the type of contribution made to a page (and optionally (include) its descendant pages), or the watches on the page. Contribution types are: authors - includes people who created or have edited the page(s) comments - includes people who have added comments to the page(s) labels - includes people who have added labels to the page(s) watches - includes people who are watching the page(s). You can specify one or more contribution types, separated by commas. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 262 Sort By count Specifies the criteria used to sort contributors. Sort criteria are: (order) count - sorts people based on the total number of contributions to the page(s) name - sorts people into alphabetical order update - sorts people based on the date of their last contribution to the page(s). Reverse Sort false Reverses the sort order of contributors in the list. Must be used in (reverse) conjunction with the Sort By parameter. Maximum Number of no limit Limits the number of contributors in the list. If a number is not specified, Contributors all contributors are included. (limit) Display Format inline Sets how the list of contributor's names is formatted: (mode) inline — a comma-separated list list — a bullet list. Show Anonymous false Sets whether to include those who contributed anonymously to a page. Contributions? (showAnonymous) Show Count? false Sets whether to show the number of times each person made a (showCount) contribution of the specified Contribution Type. Show Last false Sets whether to show the last time each person made a contribution of Contribution Time? the specified Contribution Type. (showLastTime) Page Name current Specifies the page to use when generating the list of contributors. If Pag (page) e Name and Space(s) are left blank, the current page is assumed. Label(s) none Filters the list of contributors to those who created the specified labels (labels) from a page. You can specify one or more labels, separated by commas. Space(s) current Specifies the space key of the Confluence space that contains the page (spaces) set in Page Name or alternatively, specifies the spaces to search. Space keys are case-sensitive. This parameter also takes special values, including: @global — All site spaces. @personal — All personal spaces. @all — All spaces in your Confluence site. You can specify one or more space keys or special values, separated by commas. If no Page Name and Label(s) are specified, all pages from the specified set of spaces are included. Content Type both Restricts the content type to use when generating the list of (contentType) pages contributors: and blog posts pages — pages blogposts — blog posts. Blog Post Date none Specifies the publish date for a blog post. The date format required is: (publishDate) YYYY/MM/DD. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 263 Include Page specified Specifies additional pages to include when generating the list of Hierarchy page only contributors: (scope) children — just the child pages of the specified page descendants — all descendants of the specified page. Show Selected false Sets whether to show a list of the pages used to generate the list of Pages contributors. (showPages) Custom "None default Specifies the message to be used to override the default message that Found" Message message is displayed when no contributors are found. (noneFoundMessage ) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: contributors Macro body: None. Storage format example This example specifies a content type of blog posts: 10 ds,@personal true chocolate,cake true Oh dear, no contributors found true blogposts authors,comments,labels,watches list true update true 2012/06/30 Wikimarkup example This example specifies a content type of blog posts: {contributors:limit=10|spaces=ds,@personal|reverse=true|labels=chocolate,cake|showP ages=true|noneFoundMessage=Oh dear, no contributors found|showCount=true|contentType=blogposts|include=authors,comments,labels,watches| mode=list|showAnonymous=true|order=update|showLastTime=true|publishDate=2012/06/30} This example specifies a content type of pages: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 264 {contributors:limit=10|spaces=ds,@personal|reverse=true|scope=descendants|labels=ch ocolate,cake|showPages=true|noneFoundMessage=Oh dear, no contributors found|showCount=true|contentType=pages|include=authors,comments,labels,watches|mode =list|showAnonymous=true|order=update|page=ds:Advanced Topics|showLastTime=true} Contributors Summary Macro The Contributors Summary macro displays a table of contribution-based statistics for a set of pages. These statistics can be grouped according to individual pages or individual contributors. The default scope for this macro is an individual page, but this can be extended to include the immediate children or descendants of a specified page. The statistics cover the following types of contributions: edits to the page(s) comments added to the page(s) labels added to the page(s) people watching the page(s) A simple example of the Contributors Summary macro is shown in the screenshot below. It lists statistics for the number of times each contributor has edited, added comments and added labels to this page. Screenshot: Example Contributors Summary table of statistics In this example, all default parameter settings are used. For more information about this macro's parameters, refer to the Parameters section below. Using the Contributors Summary Macro To add the Contributors Summary macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 265 browser, it will be listed below in brackets (example). Parameter Default Description Group By contributors Specifies the basis for grouping contribution-based statistics: (groupby) contributors — group by the people who have contributed pages — group by the pages used to find contributors. Columns to edits,comments,labels Sets the columns that should appear in the table. The Display statistics or type of information presented depends on the (columns) basis for grouping set with the Group By parameter. Statistics may be calculated for: edits — the number of times each contributor has edited the page(s) or the number of edits made to each page. edited — a list of the pages edited by each contributor or a list of contributors who have edited each page. comments — the number of times each contributor has added comments to the page(s) or the number of comments on each page. commented — a list of pages to which each contributor has added comments or a list of contributors who have commented on each page. labels — the number of times each contributor has added labels to the page(s) or the number of labels on each page. labeled — a list of pages to which each contributor has added labels or a list of contributors who have added a label to each page. labellist — a list of labels either added by each contributor or on each page. watches — the number of pages being watched by each contributor/person or the number of contributors/people watching each page. watching — a list of pages being watched by each contributor/person or a list of contributors/people watching each page. lastupdate — the last time each contributor made an update or when each page was last updated. Valid updates can include edit, comment or label modifications to a page. One or more columns can be used. Sort By edits Sets the criterion used for sorting items in the table. The items (order) sorted depend on the basis for grouping set with the Group By parameter. Sort criteria are: edits — sorts items in the table based on the total number of edits made, either by a contributor or to a page. name — sorts items in the table in alphabetical order, either by contributor or page name. editTime — sorts items in the table based on when the contributor last edited a page (or a specified set of pages) or when the page was lasted edited. update — sorts items in the table based on when the contributor last made any contribution to a page (or a specified set of pages) or when the page last had any contribution made to it. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 266 Reverse Sort false Reverses the sort order of items in the table, as specified (reverse) using the Sort By parameter. (Used only in conjunction with the Sort By parameter.) Maximum Number no limit Limits the number of contributors or pages in the table to the of Items value specified. If no number is specified, all items are (limit) included. Show Anonymous false Includes individuals who have made anonymous contributions Contributions? to a page. (showAnonymous) Show Zero false Sets whether contributors or pages are included for which a Counts? calculated statistic is zero. (showZeroCounts ) Page Name current Sets the page for which to calculate the contribution-based (page) statistics. If no values for Page Name and Space(s) are specified, the current page is assumed. Label(s) none Restricts the contribution-based statistics to the specified (labels) labels only. You can specify one or more labels, separated by commas. Space(s) current Specifies the space key of the Confluence space which (spaces) contains the specified page name or alternatively, specifies a scope of spaces to search. Space keys are case-sensitive. This parameter also takes special values, including: @global — All site spaces. @personal — All personal spaces. @all — All spaces in your Confluence site. You can specify one or more space keys or special values, separated by commas. If no Page Name and Label(s) are specified, all pages from the specified set of spaces are included. Content Type both pages and blog Restricts page types to either pages (pages) or blog posts (bl (contentType) posts ogposts). If no value is specified in the Macro Browser, both pages and blog posts are included. Available values pages and blogposts. Blog Post Date none Specifies the publish date for a blog post. The date format (publishDate) required is: YYYY/MM/DD. Include Page specified page only Includes either the immediate children or all descendants of Hierarchy the specified page. If no value is indicated in the Macro (scope) Browser, only the specified page is included. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: contributors-summary Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 267 Macro body: None. Storage format example This example specifies a content type of blog posts: 10 true true update chocolate,cake edits,comments,labels,lastupdate pages blogposts true 2012/06/07 This example specifies a content type of pages: 10 true true descendants update chocolate,cake edits,comments,labels,lastupdate pages pages true Wiki markup example This example specifies a content type of blog posts: {contributors-summary:limit=10|spaces=ds,@personal|reverse=true|showAnonymous=true| order=update|labels=chocolate,cake|columns=edits,comments,labels,lastupdate|groupby =pages|contentType=blogposts|showZeroCounts=true|publishDate=2012/06/07} This example specifies a content type of pages: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 268 {contributors-summary:limit=10|spaces=ds,@personal|reverse=true|showAnonymous=true| scope=descendants|order=update|page=ds:Advanced Topics|labels=chocolate,cake|columns=edits,comments,labels,lastupdate|groupby=pages |contentType=pages|showZeroCounts=true} Create from Template Macro The Create from Template macro displays a button on a page, linked to a specific template. When someone clicks the button, the macro opens the editor, ready to add a new page, and adds content to the page based on the given template. When adding the macro to the page, you can specify a blueprint or a user-created template in the macro. You will also specify the name of the button displayed, and the space in which the new page will appear. Example Screenshot: A page with three buttons, all displayed by the 'Create from Template' macro Using the Create from Template Macro To add the Create from Template macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description Button 'Create from The description that people will see when viewing this macro on the Text Template' page. Template None Select the template or blueprint to base the new page on. Only Name global and user-created templates for the current space appear (unless you have specified a different space in the 'Space Key' field). Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 269 Template Blank Specify a default title for pages created using this macro (optional). Title You can include @currentDate, @spaceName and @spaceKey variables in the title. Space The space Supply the unique space identifier (space key), to determine where Key where the the new page will be created when someone uses this macro to current page create a page. is located Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: create-from-template Macro body: None. Parameters for storage format differ from those available in the macro browser as follows. Parameter name Required Default Parameter description and accepted values templateId Required for (None) The ID of a user-created template. This is the unique identifier that user-created Confluence assigns when you create a template. For example, 299 templates 630593. To find the ID of a template, edit the template and look at the URL in your browser. The template ID is given in the URL parameter named entityId. blueprintModuleCompleteKey Required for (None) blueprints templateName Yes (None) The ID of a user-created template (for example, 299630593) or the qualified name of the add-on that defines the blueprint (for example, com.atlassian.confluence.plugins.confluenc e-shared-files-plugin:file-list-blueprint ). buttonLabel Yes 'Create The description that people will seeing when viewing this macro on from the page. Template' spaceKey Yes The The unique space identifier, to determine where the new page will space be created when someone uses this macro to create a page. where the current page is located Title No (None) The title for pages created using this macro. You can include @cur rentDate, @spaceName and @spaceKey variables in the title. This title will override any title specified in a blueprint template. Storage format example This example specifies a user-created template: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 270 299630593 Blitz test 299630593 This example uses a blueprint: com.atlassian.confluence.plugins.confluence-sh ared-files-plugin:file-list-blueprint Shared files com.atlassian.confluence.plugins.confluence-shared-files-plu gin:file-list-blueprint Wikimarkup Wiki markup is not available for this macro. You cannot add this macro via wiki markup. Create Space Button Macro The Create Space Button macro displays a create space icon that links to the 'Create Space' page. To see this icon, viewers need the 'Create Space' permission which is assigned by a site administrator. Using the Create Space Button macro To add the Create Space Button macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Icon Size large Specify whether to use large or small icon. Available values: size large small Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 271 Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: create-space-button Macro body: None. The following additional paramteters are available in storage format and wikimarkup. Parameter Required Default Parameter description and accepted values name width No Natural The width of the icon to be displayed, specified in pixels. Confluence will size of stretch or shrink the width of the icon to the number of pixels specified. icon Note: This parameter is not available via the macro browser. (1:1 pixel ratio) height No Natural The height of the icon to be displayed, specified in pixels. Confluence will size of stretch or shrink the height of the icon to the number of pixels specified. icon Note: This parameter is not available via the macro browser. (1:1 pixel ratio) Storage format example small 50px 50px Wikimarkup example {create-space-button:size=small} {create-space-button:height=50px|width=50px} Excerpt Include Macro The Excerpt Include macro is used to display 'excerpted' (that is, a segment of) content from one page in another. Before you can use this macro, the excerpt must have been defined using the Excerpt macro. Note that you can have more than one Excerpt Include macro on a page (although you can have only one Excerpt macro on a page). Example The paragraph below shows an example of an Excerpt Include macro, containing content from an excerpt which we have defined on the Excerpt Macro page. On the Excerpt Include macro below, we have set the options to show both the title of the page and the panel surrounding the content. Define a part of a page as the page's 'excerpt' which can then be displayed in another page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 272 Using the Excerpt Include Macro To add the Excerpt Include macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Page Containing the none Type the name of the page that contains the excerpt to be displayed. Excerpt You can use an excerpt from a page in the same space or another space (default-parameter in the same wiki. ) When you type the name of the page into the Excerpt Include macro dialog, Confluence will offer a list of matching pages, including those from other spaces. Alternatively, you can type the space key followed by a colon (:) and the page name, like this: SPACEKEY:Page name This parameter is unnamed in wikimarkup. Remove Surrounding false Determines whether Confluence will display a panel around the Panel excerpted content. The panel includes the title of the page containing the (nopanel) excerpt, and the border of the panel. By default, the panel and title are shown. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: excerpt-include Macro body: None. Storage format example true My page name Wikimarkup example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 273 {excerpt-include:My page name|nopanel=true} Excerpt Macro The Excerpt macro is used to mark a part of a page's content for re-use. Defining an excerpt enables other macros, such as the Excerpt Include and Blog Posts macros, to display the marked content elsewhere. You can only define one excerpt per page. In other words, you can only add the Excerpt macro once to a page. Using the Excerpt Macro To add the Excerpt macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. To add reusable content to the macro: 1. Add your content inside the Excerpt macro placeholder. 2. Choose the macro placeholder to see the options panel, and select the option to Display on new line or to Display inline. The default is to display the content of the macro on a new line. If you choose the inline option, the content of the macro will form part of the same paragraph as the text preceding and following it. Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused. Screenshot: The Excerpt macro placeholder and options panel Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 274 Hide false Controls whether the page content contained in the Excerpt macro placeholder is Excerpted displayed on the page. Content (hidden) Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: excerpt Macro body: Accepts rich text. The following additional parameter is available in storage format and wikimarkup. It performs the same function as the options panel in the editor. Parameter name Required Default Parameter description and accepted values atlassian-macro-output-type No BLOCK Determines whether the content of the Excerpt macro body is displayed on a new line or inline. Available values: BLOCK – Displays the content of the macro on a new line. INLINE – Displays the the content of the macro as part of the same paragraph as the text preceding and following it. Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused. Storage format example true BLOCK This is the text I want to reuse in other pages. This text is inside an Excerpt macro. Wikimarkup example {excerpt:hidden=true|atlassian-macro-output-type=BLOCK} This is the *text* I want to reuse in other pages. This text is inside an Excerpt macro. {excerpt} Expand Macro The Expand macro displays an expandable/collapsible section of text on your page. Here is an example: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 275 Expand me... This text is hidden until you expand the section. Using the Expand Macro To insert the Expand macro into a page using the macro browser: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Title Click here to expand... Defines the text that appears next to the expand/collapse icon. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: expand Macro body: Accepts rich text. Storage format example Expand me... This text is hidden until you expand the section. Wikimarkup example {expand:This is my message} This text is _hidden_ until you expand it. {expand} Notes Text is expanded in PDF and HTML exports. When you export the page to PDF or HTML, the text between the macro tags is expanded so that readers can see it in the PDF and HTML versions of the page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 276 Nesting your Expand macros. You can put one Expand macro inside another, and Confluence will correctly show and hide the contents of all Expand macros, including the nested ones. Favourite Pages Macro Use the Favourite Pages macro to display a list of your favourite pages. The output of the Favourite Pages macro appears as in the following screenshot. Screenshot: The Favourite Pages Macro in Confluence Using the Favourite Pages Macro To insert the favourite pages macro into a page using the Macro Browser: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. There are no parameters for this macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: favpages Macro body: None. Parameters: None. Storage format example Wiki markup example {favpages} Gadget Macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 277 Gadgets are small applications that can offer dynamic content. They are typically served from a web application server and can be re-used in many other web applications. In Confluence, use the Gadget macro to add gadgets to pages or blog posts. Confluence comes bundled with a few of its own gadgets that you can add to your pages or blog posts. The Confluence gadgets are listed in Confluence Gadgets. However, you can access additional gadgets in this list if your Confluence Administrator has: Installed additional gadgets in Confluence (typically as a Confluence plugin) or Registered gadgets served from an external web application or website (such as those from a JIRA installation or iGoogle). Unlike other macros, the name of each gadget macro is unique and follows the convention " macro", where is the name supplied by the gadget itself. Inserting gadgets into a Confluence page or blog post To add a gadget to a page: 1. Edit your page or blog post. 2. Choose Insert > Other Macros. 3. Click External Content to see a list of gadgets configured for use in your Confluence installation. (Some Confluence macros like the JIRA Issues, RSS Feed, and Widget Connector macros also appear in this category because they can also access external content.) 4. Click the desired gadget to access its parameters and properties. Almost all gadgets allow you to set basic parameters (listed below), which appear in the macro dialog. Some gadgets also have their own set of parameters, that can only be set in the gadget itself. You can use the preview in the macro browser to access them. 5. Set the parameters to your requirements. 6. Click Refresh to preview your changes. 7. Click Insert to add the gadget to the page. Editing gadgets on a Confluence page or blog post To edit an existing gadget on a page or blog post: 1. Edit your page or blog post. 2. Click the Gadget macro placeholder and choose Edit (or double-click the placeholder). 3. Set the gadget's parameters to your requirements. 4. Click Refresh to preview your changes. 5. Save the gadget. Standard gadget parameters Almost all gadgets allow you to set basic parameters (listed below), which appear on the right of the macro dialog. Each gadget may also have its own set of parameters, which appear on the left of the macro dialog. Parameter Default Description Width 450 pixels Set the width of the gadget, using one of the following conventions: Width in pixels, using px or plain numbers. For example, 500px or 500 A percentage of the page width, using %. For example, 50% Automatic resizing of the gadget to fit 100% of the page width: auto Border true Places a thin grey border around the gadget. Contents of a Gadget macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 278 In the addition to the standard parameters, the gadget macro contains 'parameter-like' content, which represents specific property settings that are particular to each gadget. Hence they are not documented here. Typically, this content would only be changed by customising the gadget's default properties using the macro browser. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: gadget Macro body: None. The following additional parameters are available in storage format and wikimarkup. Parameter Required Default Parameter description and accepted values name url Yes (none) This is the location of the gadget specification (XML file). preferences No (Gadget-dependent) Specific property settings that are particular to each gadget. A note about editing a gadget's properties (preferences) in markup: It is possible to edit the values of these properties directly in the wiki markup or storage format. However, this will allow the entry of invalid values. If a gadget property supports a certain set of values, the macro browser will restrict the user to selecting only valid values for that property. For that reason, we recommend that you use the macro browser to edit a gadget's properties. Storage format example This example shows the Confluence Page gadget: 500 false rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluenc e-page-gadget/gadgets/confluence-page-gadget.xml spaceName=Documentation&spaceKey=DOC&quickfind-space= Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-pag e=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15& ;showLink=false This example shows the Confluence News gadget: rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluenc e-news-gadget/gadgets/confluence-news-gadget.xml Wiki markup example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 279 This example shows the Confluence Page gadget: {gadget:width=500|border=false|url=rest/gadgets/1.0/g/com.atlassian.confluence.plug ins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml} spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pa geName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isC onfigured=true&refresh=15&showLink=false {gadget} This example shows the Confluence News gadget: {gadget:url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence- news-gadget/gadgets/confluence-news-gadget.xml} {gadget} Gallery Macro The Gallery macro displays a collection of thumbnail images in a table, based on the images attached to a Confluence page. When viewing the page, a user can click a thumbnail image to zoom into a screen-sized image and then view the images as a slide show. Overview: The images shown in the gallery are taken from the files attached to the Confluence page. You can also specify a different page where the attachments are located. For information about attaching images to a page, see Uploading Files. The captions below the images are drawn from the comments on the attachments. For information about adding comments to attachments, see Uploading Files. By default, the gallery will include all the images attached to the page. You can also exclude or include images using parameters. You can sort your images into a particular order. You can specify a title for the gallery and also configure how many columns you want for the table in which your images are displayed. Illustration: Live example of the Gallery macro Some office photos, and a waterfall Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 280 Using the Gallery macro To insert the Gallery macro onto a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 281 Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). The full list of parameters is shown in the following table. If the name of an attached file or page contains a comma, you can refer to it in the relevant parameters below by enclosing it in single or double quotes, for example "this,that.jpg", theother.png Parameter Default Description Gallery Title Nothing Specify a title for your gallery. (title) Number of 4 Specify the number of columns for your table. Columns (columns) Images to No exclusions. The gallery will ignore any pictures specified. You can specify Exclude Include all the more than one picture, separated by commas. (exclude) pictures on the page. Note: The filename and filetype for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'. Include these Include all the If you specifically include one or more pictures, the gallery will Images Only pictures on the page. show only those pictures. You can specify more than one picture, (include) separated by commas. Note: The filename and filetype for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'. Exclude Images No exclusions. The gallery will ignore any pictures that have the specified label. with these Include all the You can specify more than one label, separated by commas. For Labels pictures on the page. information on labelling the attachments, see Add, Remove and (excludeLabel Search for Labels. ) Include Images None. The images Filters the images to display, based on a list of labels. If you wish with these are not filtered by to enter more than one label, separate the labels with commas. Labels Only label. Confluence will show only images that have all the labels (includeLabel specified. (The match is an AND, not an OR.) For information on ) labelling the attachments, see Add, Remove and Search for Labels. Use Images in If no page is Specify the title of the page which contains the images you want these Pages specified, the gallery displayed. You can specify more than one page name, separated (page) macro displays the by commas. To specify a page in a different space, use the images attached to following syntax: SPACEKEY:Page Title the page on which the macro is used. Sort Images By None. The sort order Specify an attribute to sort the images by. Sort order is (sort) is unspecified and ascending, unless you select the Reverse Sort parameter (see therefore below). Options are: unpredictable. name – file name. comment – comment linked to the attached file. date – date/time last modified. size – size of the attached file. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 282 Reverse Sort Off. Sort order is Used in combination with the Sort Images By parameter above. (reverse) ascending Use Reverse Sort to reverse the sort order, from ascending to descending. Available values in storage format and wikimarkup: true – Sort order is descending. false – Sort order is ascending. Image file formats You can attach image files of any format to a page. Confluence supports the following image formats in the Gallery macro and when displaying an image on a page: gif jpeg png bmp (depending on browser support) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: gallery Macro body: None. Storage format example My holiday pictures true size My page1, ds:Welcome to Confluence badlabel1, badlabel2 3 badpicture.png Wiki markup example {gallery:title=My holiday pictures|reverse=true|sort=size|page=My page1, ds:Welcome to Confluence|excludeLabel=badlabel1, badlabel2|columns=3|exclude=badpicture.png} Global Reports Macro The Global Reports macro displays a list of links to some reports about content on your site. These reports include a list of new or updated pages, orphan pages, undefined pages, and RSS feeds for new pages and blog posts. Screenshot: The Global Reports macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 283 Using the Global Reports Macro To add the Global Reports macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Width of 99% Specify the width of the table in which the links are displayed, as a percentage of Table the window width. (width) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: global-reports Macro body: None. Storage format example 50% Wikimarkup example {global-reports:width=50%} Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 284 HTML Include Macro The HTML Include macro allows you to include the contents of an external HTML file (a webpage) in a Confluence page. HTML macros are disabled by default The HTML macro will only be available if it has been enabled by an administrator. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks. Using the HTML Include Macro To insert the HTML Include macro into a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description HTML Page's URL Yes None The URL of the page to include. (url) Enabling the HTML Include Macro The HTML Include macro is disabled by default. You'll need Confluence Administrator or System Administrator permissions to enable this macro. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks. You should only turn on these macros if you trust all your users not to attempt to exploit them. We strongly recommend leaving this macro disabled if you allow self-signed up or anonymous users to create content. To enable the HTML Include macro: 1. Go to > Add-ons 2. Select System from the drop down and search for the Confluence HTML Macros add-on. 3. Expand the add-on and enable the html-include (html-include-xhtml) module. Administrators can also choose to use the whitelist to restrict URLs that can be displayed in the HTML Include macro. Troubleshooting Administrators can define a whitelist of trusted URLs. If a URL is not in the whitelist, you will see an error message in the HTML Include macro. You can only use the HTML Include macro for pages with absolute links. If you use the macro to include an HTML page that has relative links, you will see a 'Page Not Found' error. See CONF-6567 - HTML Include macro should rewrite relative links to point to remote site OPEN . Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 285 Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: html-include Macro body: None. Storage format example Wikimarkup example {html-include:url=http://www.example.com} HTML Macro The HTML macro allows you to add HTML code to a Confluence page. HTML macros are disabled by default The HTML macro will only be available if it has been enabled by an administrator. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks. Using the HTML Macro To add the HTML macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. There are no parameters for this macro. Enter the HTML code into the body of the macro placeholder. Enabling the HTML Macro The HTML macro is disabled by default. You'll need Confluence Administrator or System Administrator permissions to enable this macro. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks. You should only turn on these macros if you trust all your users not to attempt to exploit them. We strongly recommend leaving this macro disabled if you allow self-signed up or anonymous users to create content. To enable the HTML macro: Created1. in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 286 1. Go to > Add-ons. 2. Select System from the drop down and search for the Confluence HTML Macros add-on. 3. Expand the add-on and enable the html (html-xhtml) module. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: html Macro body: Text, consisting of HTML code. Parameters: None. Storage format example < ac:structured-macro ac:name = "html" > < ac:plain-text-body > Click here to see the Atlassian website.]]> Wikimarkup example {html}Click here to see the Atlassian website.{html} IM Presence Macro The IM Presence macro indicates graphically when a contact is signed into an Instant Messaging (IM) service. The IM Presence macro appears as a small icon on the page. Using the IM Presence Macro To add the IM Presence macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Description User ID/Screen Identify the user by their ID, account name or screen name. Name Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 287 Service aim – AOL Instant Messenger (service) gtalk – Google Talk icq – ICQ jabber – Jabber msn – MSN Instant Messenger sametime – IBM Lotus Sametime skype – Skype. Note: Skype requires 'Show my status on the web' to be checked under 'Privacy' preferences skypeme – Skype wildfire – Openfire Server yahoo – Yahoo! Messenger Show User ID Shows or hides the User ID of the contact. (showid) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: im Macro body: None. Storage format example false skype MySkypeName Wiki markup example {im:MySkypeName|service=skype|showid=false} Include Page Macro You can use the Include Page macro to display the contents of one Confluence page or blog post in another page or blog post. Using the Include Page Macro To add the Include Page macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 288 where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Page to None This is the name of the Confluence page or blog post that you want to include in the Include current page. Start typing a page title, and Confluence will suggest matching pages from the current space and other spaces. Alternatively you can specify the page as follows: If the page or blog post is located in another space, add the space key and a colon in front of the page name. For example, DOC:My page name. The space key is case sensitive. To include a blog post, specify the date as well as the title of the blog post. For example: /2010/12/01/My blog post. You can include pages from personal spaces using ~username as the space key, where 'username' is the person's username. For example, ~jsmith:My page name. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: include Macro body: None. Storage format example Wiki markup example {include:DOC:My chocolate page} Notes If you want to include part of a page rather than the whole page, use the Excerpt and Excerpt Include mac ros. To display a page's contents, you need 'View' permission for that page. Similarly, people who view the page will need 'View' permissions for the embedded page as well as the page into which it is embedded. See space permissions or contact your Confluence space administrator for more information. If you want to embed an external page into a Confluence page, you need the HTML Include Macro. Sample Include Page Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 289 Start of sample page content Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris. End of sample page content Info, Tip, Note, and Warning Macros The Info, Tip, Note, and Warning macros allow you to highlight information on a Confluence page. They create a coloured box surrounding your text, as shown below. Info macro example Note macro example This text is rendered inside the info macro. This text is rendered inside the note macro. Tip macro example Warning macro example This text is rendered inside the tip macro. This text is rendered inside the warning macro. To add an Info, Tip, Note, or Warning Macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Optional Title none The title of the box. If specified, the title text will be (title) displayed in bold next to the icon. Show information/tip/Exclamation true If "false", the icon will not be displayed. Mark/Warning Icon (icon) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: info/tip/note/warning Macro body: Accepts rich text. Storage format example The following example shows the info macro with all parameters and a body: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 290 false This is my title This is important information. Below are some examples of the Info macro with various optional parameters used. Description Markup What you will get Info macro with a body defined and This is imp no optional ortant infor parameters mation. This is important information. Info macro with with a body and This is my an optional Title p This is my title arameter defined title This is imp ortant infor mation. This is important information. Info macro with a body and optional This is my title Title and Icon par false nt information. This is my title This is important information. Wiki markup example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 291 {info:title=This is my title|icon=false} This is _important_ information. {info} JIRA Issues Macro JIRA is the issue tracking and project management system supplied by Atlassian. By adding the JIRA Issues macro to a Confluence page, you can display one or more issues from a JIRA site. You can also choose to create an issue in JIRA, at the time of adding the macro to the Confluence page. Before you can use this macro, your Confluence and JIRA sites must be connected via Application Links. People viewing the page will see the publicly accessible issues from the JIRA site. If your JIRA site has restricted viewing (that is, people need permission to view issues) then they will need to authenticate before seeing the restricted issues. See more about restricted JIRA issues below. What you can do with the JIRA Issues macro Using the JIRA Issues macro, you can: Display a table of JIRA issues on your page, based on the results of a search using JIRA Query Language (JQL). Display a table of JIRA issues onto your page, using a JIRA URL. Display a single issue from the JIRA site, or a subset of selected issues from your JIRA search results. Display a count of issues from the JIRA site. Create new issues in JIRA and display the issues on your page without leaving Confluence. Adding and updating the JIRA Issues macro – an overview Quick guide to using the macro on a Confluence page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Screenshot: Example of JIRA issues macro on a Confluence page Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 292 Displaying issues via a JIRA Query Language (JQL) search You can use the macro to display a table of JIRA issues on your page, based on the results of a search using JI RA Query Language (JQL). JQL is a simple query language, similar to SQL, which works in JIRA. A basic JQL query consists of a field, followed by an operator (such as = or >), followed by one or more values or functions. Examples: The following query will find all issues in the 'TEST' project: project = "TEST" The following query will find all issues in the 'documentation' component of the 'CONF' project: project = CONF and component = documentation For more information about JQL syntax, see the JIRA documentation: Advanced Searching. To display a table of issues based on a JQL search: 1. Insert the JIRA Issues macro onto your Confluence page, as described above. 2. Choose a JIRA server next to the Search button. 3. If prompted, log in to the JIRA server. 4. Enter the JQL query into the Search box. 5. Choose Search. 6. If you want to customise the display, choose Display options and adjust the columns and number of issues that will appear in your table of issues. 7. Choose Insert. Screenshot: Display options in the JIRA Issues macro browser. Displaying issues via a JIRA URL You can paste any of the following JIRA URLs into the JIRA Issues macro. Confluence will immediately convert the URL to a JQL search. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 293 Any URL for a JIRA issue search or filter. A URL for a single issue. The URL of the XML view of a JIRA search. Auto-convert: You can paste a JIRA URL directly into the Confluence editor (without calling up the macro browser). Confluence will automatically convert the URL into a JIRA Issues macro. Displaying a single JIRA issue, or selected JIRA issues To display a single JIRA issue, choose one of the following methods: Paste the URL of the issue directly onto the Confluence page. (There is no need to use the macro browser.) Confluence will auto-convert the link to a JIRA Issues macro. Or: Add the JIRA issues macro to the page as described above, and choose Recently Viewed to see the JIRA issues you have visited recently. Select an issue and choose Insert. Or: Add the JIRA issues macro to the page as described above, and past the issue URL into the search box in the macro browser. Or: Add the JIRA issues macro to the page, define your search criteria in the macro browser via JQL as described above, then select the check box next to the issue in the search results, within the macro browser. To display a subset of JIRA issues from your search results: 1. Add the JIRA issues macro to the page. 2. Define your search criteria in the macro browser via JQL, as described above. 3. Select the check boxes next to the required issues in the search results, within the macro browser. Screenshot: Selecting a subset of issues to display Displaying a count of issues Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 294 You can choose to display the number of issues returned by your search, rather than a table of issues. The JIRA Issues macro will display a count of issues, linked to the search in JIRA. Screenshot: The JIRA Issues macro displaying an issue count on a Confluence page To display an issue count: 1. Add the JIRA issues macro to the page. 2. Define your search criteria in the macro browser via JQL, as described above. 3. Choose Display options, then choose Total issue count next to 'Display options' in the macro browser. 4. Choose Insert. Creating a new JIRA issue in the editor While editing a Confluence page, you can create an issue in JIRA and display it on your Confluence page, without leaving the Confluence editor. To insert an issue into JIRA: 1. Add the JIRA Issues macro to the page, as described above. 2. Choose Create New Issue. 3. Supply the information about your JIRA server, project, and issue, as prompted. 4. Choose Insert. Confluence will send a request to JIRA, to add the issue to the JIRA site. Confluence will also display the resulting JIRA issue on the Confluence page. Limitations The JIRA Issues macro will notify you if it is unable to create an issue in the selected project. This may be because the project has a required field, field configuration or other customisation that is not supported by the JIRA Issues macro. In this situation you will need to create the issue directly in JIRA. Configuring Application Links to display restricted JIRA issues Before you can use this macro, your Confluence and JIRA sites must be connected via Application Links. If the JIRA site allows anonymous viewing of issues, you must configure an application link, but there is no need to configure any incoming or outgoing authentication between JIRA and Confluence. People viewing the Confluence page will see the publicly accessible issues from the JIRA site. If your JIRA site has restricted viewing, or if some JIRA projects or issues are restricted to viewing by certain people, then people will need to log in before seeing the restricted issues. In such a case, the outgoing authentication in the Confluence Application Links determines how the JIRA Issues macro handles restricted issues: If the outgoing authentication is set to Trusted Applications, people can see restricted issues in JIRA if their username is the same in JIRA and Confluence, and if they have permission in JIRA to see the issue. If the outgoing authentication is set to OAuth, people may need to choose Login & Approve, to gain access to the JIRA server and restricted issues. If the outgoing authentication is set to Basic Access, people can see the JIRA issues that are visible to the user account configured in JIRA's outgoing authentication setting. Rendering HTML from JIRA Formatted fields from JIRA can be displayed in Confluence if you set up a Confluence-to-JIRA application link. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 295 Otherwise, such formatted fields will be escaped within the output of the JIRA issues macro. This is to prevent the possibility of malicious HTML being served by an untrusted JIRA server. The most likely field where you will notice this is in the description field. This example shows how a description column may be displayed in JIRA: Description This is the description of my issue If there is no application link between JIRA and Confluence, the description will appear in the JIRA issues macro like this: Description This is the description of my issue Disabling the JIRA Issues macro The functionality is provided by an add-on (plugin) called 'JIRA Macros'. To make the macro unavailable on your site, you can disable the add-on. See Disabling and enabling add-ons. Notes HTTPS: The JIRA Issues macro can access a JIRA site running under SSL provided the Confluence server is configured to accept the JIRA SSL certificate. See Connecting to LDAP or JIRA or Other Services via SSL. Custom fields can be added as columns to the table simply by using the name of the field with no quotes. Earlier versions of the macro required you to use the custom field id, e.g. customfield_10100. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: jiraissues Macro body: None. Note: A number of additional parameters that are not available via the macro browser are available in storage format and wikimarkup. Parameter Required Default Parameter description and accepted values name anonymous No false If this parameter is set to 'true', JIRA will return only the issues which allow unrestricted viewing. That is, the issues which are visible to anonymous viewers, as determined by JIRA's viewing restrictions. If this parameter is omitted or set to 'false', then the results depend on how your administrator has configured the communication between JIRA and Confluence. By default, Confluence will show only the JIRA issues which the user is authorised to view. Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 296 baseurl No The value of If you specify a 'baseurl', then the link in the header, pointing to the 'url' your JIRA site, will use this base URL instead of the value of the parameter 'url' parameter. This is useful when Confluence connects to JIRA with a different URL from the one used by other users. columns No By default, A list of JIRA column names, separated by semi-colons (;). You the following can include any columns recognised by your JIRA site, including columns are custom columns. See the JIRA documentation for a list of names. shown: type key summary assignee reporter priority status resolution created updated due count No false If this parameter is set to 'true', the issue list will show the number of issues in JIRA. The count will be linked to your JIRA site. cache No on The macro maintains a cache of the issues which result from the JIRA query. If the 'cache' parameter is set to 'off', the relevant part of the cache is cleared each time the macro is reloaded. (The value 'false' also works and has the same effect as 'off'.) Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. height No 480 (if The height in pixels of the table displaying the JIRA issues. render mode Note that this height specification is ignored in the following is dynamic) situations: If the 'renderMode' parameter (see below) is set to 'static'. When the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed. Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. renderMode No static If the value is 'dynamic', the JIRA Issues macro offers an interactive display which people can manipulate as follows: Click the column headers to sort the output. Drag and drop the columns into a different order. Temporarily remove a column from the display. View a page of issues at a time, for faster response times. A value of 'static' will disable the dynamic display features. Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 297 title No JIRA Issues You can customise the title text at the top of the JIRA issues table with this parameter. For instance, setting the title to 'Bugs-to-fix' will replace the default 'JIRA Issues' text. This can help provide more context to the list of issues displayed. Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. url Yes none The URL of the XML view of your selected issues in JIRA Issue Navigator. Note: If the URL in the 'url' parameter does not contain a tempMa x argument, then the value of tempMax will default to 500. If your JIRA server is version 3.12 or earlier, this means that the JIRA Issues macro will return a maximum of 500 issues. If your JIRA server is version 3.13 or later, a value of 500 means that the JIRA Issues macro will return a maximum of 500 issues per page. width No 100% The width of the table displaying the JIRA issues. Can be indicated either as a percentage (%) or in pixels (px). Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter. Storage format example Example using a URL that points to the XML view of a JIRA search: true type;key;summary Example using JQL – note that Confluence will insert the server and serverId parameters, based on settings in Application Links: key,summary,type,created,assignee,status Atlassian JIRA 144880e9-a1111-333f-9412-ed999a9999fa project = CONF AND component = documentation AND resolution = unresolved Wikimarkup example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 298 {jiraissues:anonymous=true|url=http://jira.atlassian.com/sr/jira.issueviews:searchr equest-xml/temp/SearchRequest.xml?jqlQuery=project+%3D+CONF+AND+%28summary+%7E+jira issues+OR+description+%7E+jiraissues+OR+comment+%7E+jiraissues%29&tempMax=10|column s=type;key;summary|title=My List of Issues} JUnit Report Macro The JUnit Report macro displays a summary of JUnit test results from a directory accessible by the Confluence server. JUnit is a unit testing framework which allows programmers to ensure that individual units of Java source code are functioning correctly.For security reasons JUnit test result files can only be imported from a specified location in the Confluence server's file system. We recommend administrators create a folder in their Confluence home directory, add the system property confluence.junit.report.directory and specify the location for JUnit test result files to be imported from. JUnit Test result files cannot be imported from the server until this system property is set.The JUnit Report macro appears as shown in the screenshot below. Screenshot: The JUnit Report macro in Confluence Note:When generating reports from the JUnit Report macro, set the Apache Ant formatter to 'XML'. Using the JUnit Report macro To add the JUnit Report macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 299 URL of the test Must None URL of a particular test result XML file. Is overridden by the Directory (URL) of result XML file include your test result files parameter if you use both. (url) either the d Example, from a Confluence instance: http://yourConfluenceInstance.c irectory om/download/attachments//file.xml or the url parameter For Confluence installations without anonymous user access, you can specify logon credentials as part of this parameter in the form of URL parameters: os_username — The username of a Confluence user with permission to access to the JUnit test results. os_password — The password of the Confluence user specified in the os_ username parameter. Directory (URL) Must None URL of a directory containing your test result files. This must be a directory name of your test include and not the XML file itself. Overrides the URL of the test result XML file param result files either the d eter if you use both. (directory) irectory Example, file:///C:/TEMP/ or the url parameter Example, for a network drive: http://*host*/*path* Report Detail No all Detail for the report. Can be all, fixture, summary or failuresonly. (reportdetail ) Debug No None Shows the content of failures, as well as the error messages. (debug) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: junitreport Macro body: None. Storage format example summary true Wiki markup examples Loading JUnit reports from a local drive: {junitreport:directory=file:///C:/TEMP/} Loading JUnit reports from a network drive: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 300 {junitreport:url=http://*host*/*path*} Loading JUnit reports from a Confluence site: {junitreport:url=http://yourConfluenceInstance.com/download/attachments//file.xml} Loading JUnit reports from a Confluence site that requires authentication: If your Confluence site is not accessible by anonymous users, specify login credentials with the os_username a nd os_password URL parameters (as part of the macro's url parameter). In this case, we are specifying a username of 'admin' and a password of 'secret'. {junitreport:url=http://yourConfluenceInstance.com/download/attachments//file.xml?os_username=admin&os_password=secret} Labels List Macro The Labels List macro displays a list of all labels within the current space. Each label in the list links to a page that displays all pages in the current space that contain that label. Using the Labels List macro To add the Labels List macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter name Required Default Parameter description and accepted values Restrict to this Space No Current The key of the space whose labels you want to Key space display. (spaceKey) Excluded label(s) No Blank The labels that you do not want to appear in the list. (excludedLabels) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 301 Macro name: listlabels Macro body: None. Storage format example not-this-label Wiki markup example {listlabels:spaceKey=DOC} Livesearch Macro The Livesearch macro allows you to add a search box to a Confluence page. When users enter a search term into the search box, Confluence will dynamically display matching results as they type. Using the Livesearch macro To add the Livesearch macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Restrict to this all Specify a space key to limit the search to the given space. Case-sensitive. Space Key spaces (spaceKey) Restrict to Specify labels to limit the search to content with that label. If unspecified will label(s) search all content regardless of label. (labels) Size medium Choose a medium or large search field size. (size) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 302 Placeholder Specify the placeholder text to appear in the search field, for example 'Search text this space' (placeholder ) Type all Specify the content types to be included in the search - choose from pages, (type) blogs, comments, space descriptions, or all content types. Additional space Display the space name, a page excerpt or nothing under the search result. (additional) name Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: livesearch Macro body: None. Storage format example page excerpt Search this space myLabel page large Wikimarkup example {livesearch:spaceKey=DOC|size=large|placeholder=Search this space} Loremipsum Macro The Loremipsum macro displays paragraphs of pseudo-Latin text (more information). You can use this macro to generate more-or-less meaningless text for demonstration purposes in pages showing a draft layout or arrangement of page elements. The text is deliberately non-meaningful so that it does not influence the viewer's perception of the page arrangement or design. A basic example of the Loremipsum text: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetur. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris. Using the Loremipsum macro To add the Loremipsum macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 303 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Number of 3 Determines the amount of pseudo-Latin (space-filler) text to display. The macro Paragraphs will display a maximum number of 30 paragraphs. Parameter is unnamed in storage format and wikimarkup. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: loremipsum Macro body: None. Storage format example 2 Wikimarkup example {loremipsum:2} Multimedia Macro The multimedia macro is used to embed attached video, animation and other multimedia files on a Confluence page. Confluence supports the following multimedia formats: Adobe Flash (.swf) Apple QuickTime (.mov) Windows Media (.wma, .wmv) Real Media (.rm, .ram) MP3 and MP4 files (.mp3, .mp4) MPEG files (.mpeg, .mpg) AVI files (.avi) You may need to enable an avi decoder within your browser. See the Widget Connector Macro if you want to display online multimedia content, such as YouTube and Vimeo videos on a page. To add the Multimedia macro to a page: 1. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 304 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. You can also drag a supported multimedia file directly on to the page. Confluence will attach the file and add the macro for you. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required Default Parameter description and accepted values name Page Name Yes Current page Name of the page to which the multimedia file is attached. Start typing the name of the page and then select it from (page / list of suggested pages. space) Include the spacekey if you want to specify a page in another space (for example MYSPACE:My Page Title) Attachment Yes None File name of the attached multimedia file. (name) Width No If not specified, the Width of the movie window to be displayed on the page. browser will By default, this value is specified in pixels. You can also determine the width choose to specify a percentage of the window's width, or based on the file any other value accepted by HTML. type. Height No If not specified, the Height of the movie window to be displayed on the page. browser will By default, this value is specified in pixels. You can also determine the choose to specify a percentage of the window's height, or height based on the any other value accepted by HTML. file type. Autoplay No false If the parameter is set to true then the video or audio file will start playing as soon as the page is loaded. If this (autostart) option is set to false then the file will not play until the user clicks the icon or image on the page. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: multimedia Macro body: None. Storage format example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 305 500 Wikimarkup example {multimedia:space=DOC|page=My macros|name=ninjas.swf|autostart=true} Notes You will need the relevant multimedia plugin for your browser. Your browser may need a plugin to play the video or audio file on a Confluence page. Autoplay may not always work as expected. Some browsers may not autoplay the attached file. If you get the error, 'Unable to embed content of type application/octet-stream', this means the MIME type is not recognised. Advanced users can try styling via CSS. By default, each embedded object is wrapped in a div tag. If you wish to style the div and its contents, override the embeddedObject CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format embeddedObject-ID are used. Navigation Map Macro The Navigation Map macro displays a navigable map of the pages tagged with a given label. Using the Navigation Map Macro To add the Navigation Map macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Label none Specify the label associated with the pages you want to show in the navigation map. This parameter is unnamed in storage format and wikimarkup. Map Title none Specify a title for the navigation map. (title) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 306 Number of 5 Specify the number of cells in a row Cells Per Row (wrapAfter) Cell Width 90 px Specify the cell width (Pixels) (cellWidth) Cell Height 60 px Specify the cell height (Pixels) (cellHeight ) Navigation Confluence Define a theme for the navmap. Map Theme (theme ) If you want to create your own navmap 'look and feel' (for example, one with rounded corners), you need to add a customised navmap macro theme file to the WEB-INF/classes/templates/macros directory. The file name convention to use is navmap-mytheme.vm. Use the name of your choice for the mytheme part of the file name, which is also the value you use for this parameter. Hence, if your theme was called navmap-roundededges.vm, use the value of roundededges for this parameter. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: navmap Macro body: None. Storage format example 4 My map name 50px navmap-mytheme.vm 80px mylabel Wiki markup example {navmap:mylabel|wrapAfter=4|title=My map name|cellHeight=50px|theme=navmap-mytheme.vm|cellWidth=80px} Network Macro The Network macro displays a list of Network activity on a Confluence page or blog post. You can specify the user whose network activity you wish to show. These interactions include the users that the specified user is Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 307 following or users who are following the specified user. The Network macro shows each listed user by their profile picture. It also provides a choice of two themes and the ability to limit the number of users in the list. Screenshot: Network macro Using the Network macro To add the Network macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Username Current The username of the Confluence user whose network interactions you wish to user's show. If no username is specified, then current user's (that is, your) network username interactions are shown. Mode following Determines which users are listed, with respect to the specified user: following – those who the user is following. followers – those who are following the user. This parameter is unnamed in storage format and wikimarkup. Theme full Determines how the user's network is displayed: full – shows a large version of user's profile pictures and, if the following mode is set, provides an entry field function to follow more users. tiny – shows only the small version of user's profile pictures. Maximum No limit Restricts the number of users displayed. If the number of users exceeds the Results imposed up specified maximum, then a Show All link is provided. This link leads to the to a specified user's Network view, showing the complete list of network interactions. (max) maximum of 30 Disabling the Network macro The Network macro is provided by the 'network' module in the 'Profile Macros' plugin. To remove the macro from your site, you can disable the module in the plugin. See Disabling and enabling add-ons. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 308 Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: network Macro body: None. Storage format example 10 full followers Wiki markup example {network:followers|username=admin|max=10|theme=full} Noformat Macro The Noformat macro displays a block of text in monospace font with no other formatting. Using the Noformat Macro To add the Noformat macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Enter the content that is to be unformatted into the body of the macro placeholder. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description No Panel False Removes the panel around the content. (nopanel) Code examples Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 309 The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: noformat Macro body: Accepts plain text. Storage format example true Wiki markup example {noformat:nopanel=true}http://www.example.com{noformat} Office Excel Macro The Office Excel macro displays the content of an Excel spreadsheet on a wiki page. First attach the spreadsheet to a Confluence page, then use the macro to display the content. When viewing the page, people will see the content of the spreadsheet, without needing to have Office installed. For details, see the View File Macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: viewxls Macro body: None. Parameter Required Default Parameter description and accepted values name name Yes (None.) The file name of the Excel spreadsheet to be displayed. The document must be attached to a page on your Confluence site. page No The page The name of a Confluence page to which the Excel spreadsheet is containing attached. the macro col No Last column The number of the last column you want displayed, starting from '0' with content as the first column. Hint for reducing the size of the spreadsheet: Use the col and r ow parameters to reduce the size of the spreadsheet displayed on the wiki page. This is especially useful to prevent the display from showing empty cells. This will also help to prevent 'out of memory' errors. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 310 row No Last row with The number of the last row you want displayed, starting from '0' as content the first row. grid No true Determines whether the macro will show borders around the cells in the spreadsheet. Accepted values: true – Shows borders. false – Does not show borders. sheet No The The name of the worksheet that you want displayed. most-recently viewed worksheet Storage format example E Sheet1 5 Wiki markup example {viewxls:col=5|page=Docs|name=My document.xls|grid=false|sheet=mysheet|row=5} Office PowerPoint Macro The Office PowerPoint macro displays the content of a PowerPoint presentation on a wiki page. First attach the presentation to a Confluence page, then use the macro to display the content. When viewing the page, people will see the content of the presentation, without needing to have Office installed. For details, see the View File Macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: viewppt Macro body: None. Parameter Required Default Parameter description and accepted values name name Yes (None.) The file name of the PowerPoint presentation to be displayed. The document must be attached to a page on your Confluence site. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 311 page No The page The name of a Confluence page to which the PowerPoint containing the presentation is attached. macro height No The height of the macro display, specified in pixels (for example: 10 px, or just 10) or as a percentage (for example: 20%) of the window's height. width No The width of the macro display, specified in pixels (for example: 10 px, or just 10) or as a percentage (for example: 20%) of the window's height. slide No All slides, The number of the slide that you want displayed on the Confluence starting with page, where the first slide is numbered zero. Instead of a slide the first, as a show, the page will display just the single slide, represented as a slide show JPEG image. Storage format example 250 250 Wiki markup example {viewppt:height=20%|page=Docs|width=20%|name=My document.ppt|slide=4} Office Word Macro The Office Word macro displays the content of a Word document on a wiki page. First attach the document to a Confluence page, then use the macro to display the content. When viewing the page, people will see the content of the document, without needing to have Office installed. For details, see the View File Macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: viewdoc Macro body: None. Parameter Required Default Parameter description and accepted values name name Yes (None.) The file name of the Word document to be displayed. The document must be attached to a page on your Confluence site. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 312 page No The page The name of a Confluence page to which the Word document is containing the attached. macro Storage format example Wiki markup example {viewdoc:page=Docs|name=My document.doc} Page Index Macro The Page Index macro creates a hyperlinked alphabetical index of all page titles within the current space. The top section of the index contains a cell for each letter of the alphabet, with cells for numbers and symbols. Each cell indicates how many pages are in the corresponding list. The lower section contains lists of page titles followed by the first few sentences of content on that page. Each letter, number or symbol in the top section is hyperlinked to the corresponding cell in the lower section. Each page title in the lower section is hyperlinked to the page in the space. Screenshot: Page Index macro (partial view) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 313 Using the Page Index macro To add the Page Index macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. This macro accepts no parameters. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: index Macro body: None. Parameters: None. Storage format example Wiki markup example {index} Page Properties Macro The Page Properties and Page Properties Report macro work together to enable you to show summary information from one page on a another page. You can see examples of these two macros in action in the Decisions Blueprint and Product Requirements blueprints. This macro was previously known as the Metadata Details macro. Adding the Page Properties macro to a page The Page Properties macro uses key value pairs. The body of the macro must be set up correctly for your information to appear in the Page Properties Report. To add the Page Properties macro to a page: 1. In the editor, choose Insert > Other Macros > Page Properties. 2. In the macro body create a two column table and remove the header row. 3. In the left column list your 'keys' - these will be the column headings in your report table. 4. In the right column list the value for each key - these will populate the rows in your report table. 5. Add a label to your page - you will need to specify this label in the Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 314 5. page properties report macro. 6. Save your page. On this page: Adding the Page Properties macro to a page Using multiple Page Properties macros on one page Parameter s Related pages: Page Properties Report Macro Decisions Blueprint Product Requireme nts Blueprint Don't forget to add a label to your page, or your page will not appear in the Page Properties Report macro. Next you need to add the Page Properties Report macro to another page. Screenshot: Page Properties macro in the editor. Deadline, Current Status and Team will be column headings in the report. Screenshot: The example above as it appears in the Page Properties Report Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 315 Using multiple Page Properties macros on one page You can add multiple Page Properties macros on a single page, and choose whether to include all or only specific macros in the report. You might use multiple macros because you want the information in the macro to display in context with the rest of the page, or because you want to be able to report on individual Page Properties macros separately. The Page Properties macro includes an optional ID parameter that can be used to identify specific Page Properties macros. To show the contents of all Page Properties macros in the report: Add a label to the page containing the Page Properties macros. Specify this label in the Page Properties Report macro. To show the contents of selected Page Properties macros in the report: Add a label to the page containing the Page Properties macros. Specify an ID in the Page Properties macro that you want to report on. Specify both the label and ID in the Page Properties Report macro. Note: The Page Properties Report macro can only accept one page label, and one ID. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Page (None) Optional ID used to identify a particular Page Properties macro on a page. Specify Properties this ID in the Page Properties Report to include summary information from macros ID with this ID only. Hidden False Determines whether the data in the Page Properties macro will be displayed on the current page. This setting does not affect the display of the detail in the Page Properties Report macro. Notes You can't use text formatting or macros in the left column as the data in this column is used to populate the column headings in your Page Properties Report macro. If your table has a header row, this row will be ignored by the Page Properties Report macro. You should remove the header row. It is not possible to reference the metadata using the metadata key from within the page, or anywhere else on a Confluence page. Page Properties Report Macro The Page Properties and Page Properties Report macro work together to enable you to show summary information from one page on a another page. You can see examples of these two macros in action on the Decision and Product Requirements blueprints. This macro was previously known as the Details Summary macro. Adding the Page Properties Report macro to a page To add the Page Properties Report macro to a page: 1. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 316 1. In the editor, choose Insert > Other Macros > Page Properties Report. On this page: 2. Enter the Labels you want to report on - this is the label added to Adding the pages containing the Page Properties macro. Page 3. Further narrow down your search by adding more fields, or specifying Properties a Page Properties ID (more info on this below) Report 4. Choose Insert. macro to a page Reporting on specific Page Properties macros CQL fields Macro display options Troublesho oting Related pages: Page Properties Macro Decisions Blueprint Product Requireme nts Blueprint Here's how the macro looks on your page: And here's how you would set it up in the macro browser: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 317 Reporting on specific Page Properties macros It's possible to add multiple Page Properties macros on a page, and choose whether to include all or only specific macros in the report. The Page Properties macro includes an optional ID parameter that can be used to identify specific Page Properties macros. To show the contents of: Selected Page Properties macros in the report - specify the label for the page and the ID of the particular Page Properties macro (under Options) All Page Properties macros in the report - specify just the label for the page - leave the Page Properties ID field blank. Note: The Page Properties Report macro can only accept one ID. CQL fields Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 318 This macro uses CQL (Confluence Query Language) to return matching content, such as pages. You can add as many fields as you need to narrow down your search. Here's some tips... Use the Add Field link to add additional filters to your query. Add as many fields as you need. For an OR search, specify multiple values in the same field. So to show pages with 'label-a', 'label-b' or both you'd put 'label-a' and 'label-b' in the same Label field, like this: For an AND search, add more than one field and specify a single value in each. To show only pages with label-a and label-b you'd put 'label-a' in one label field, then add a second Label field to the macro, and put 'label-b' in the second one, like this: Put simply, OR values are entered in the same field, AND values are entered in different fields. Only some fields support AND. If the field does not support the AND operator, you won't be able to add that field more than once. For a NOT search, enter a minus sign (-) before the label. This will exclude everything with that label. You can use these CQL fields to build your query. Field Required Description Operators Label Yes Include pages, blog posts or attachments with these OR (multiple values in labels. the same field) AND (multiple Label fields) With No Include pages that are children of this page. OR (multiple values in ancestor the same field) This allows you to restrict the macro to a single page tree. Contributor No Include pages or blog posts that were created or OR (multiple values in edited by these people. the same field) Creator No Include items created by these people. OR (multiple values in the same field) Mentioning No Include pages and blog posts that @mention these OR (multiple values in user people. the same field) With No Include only direct children of this page (further EQUALS (one page parent sub-pages won't be included) only) In space No Include items from these spaces. OR (multiple values in the same field) Including No Include items that contain this text. CONTAINS (single word text or phrase) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 319 With title No Include items that contain this text in the title. CONTAINS (single word or phrase) Of type No Include only pages, blogs or attachments. OR (multiple values in the same field) Macro display options These options control how the macro appears on your page. Parameter Default Description Page Blank If not specified, the report will show data from all Page Properties macros on a Properties page, where there are multiple macros. Specify an ID to include only data from ID Page Properties macros with the same ID. Title Title The heading to display on the first column in the report table. This column column contains links to pages displayed by the report. The default column heading is heading 'Title'. Columns If not specified, the report will show all columns. You can specify a comma to show separated list of columns to include. If your column heading includes commas, use double quotes around the column name. If your column heading includes quotes, use double quotes. For example, A column, "My ""new"" column, yes", Third column Number of 30 Number of items to display in the table before displaying pagination options for items to additional items. display Sort by Modified Sort the table by a specific column heading. Enter the column name, exactly as it appears in the corresponding Page Properties macro. Select the Reverse Sort check box to sort the table in reverse order. Show No Displays the number of comments for each page in the table. Comments Count Show No Displays the number of likes for each page in the table. Likes Count Troubleshooting If your report is empty, check: You have entered the label correctly and that the label does appear on pages containing a Page Properties macro. The Page Properties macros on each page are configured correctly. Any other fields you have specified have not narrowed your search too far (for example there are no pages with that label under the Parent page you've specified). Page Tree Macro The Page Tree macro displays a dynamic, hierarchical list of pages starting from a specified parent (root) page. It can act as a table of contents or a list of related topics. When viewing the page tree, your reader can click a link to view the relevant page. The page's current position is highlighted in the page tree. Note: The Page Tree macro is used in the Confluence Documentation theme, to create a navigation panel showing a table of contents for your space. Read the instructions on Configuring the Documentation Theme. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 320 Using the Page Tree Macro To add the Page Tree macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Click Refresh in the Macro Browser to see the effect of changes to the macro parameters. Macro Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Root Page The Specify the parent page for the page tree. The tree will include all (root) home children of the given page, plus their children and grand-children etc. page of The tree will not include the root page itself. the space Specify the page title or a special value as follows: Your page title — to specify a page name for the parent or root of the tree. The tree will include all children and grand-children of the specified root. The tree will not include the specified root page itself. '@home' — will include all pages under the home page of the space (default). '@self' — will include all pages under the current page. '@parent' — will include all pages under the parent of the current page, including the current page. '@none' — will include all pages in the space, including orphaned pages and the home page. Sort Pages By position Specify the order to display the pages in the tree. This sort order is for (sort) display purposes only. It does not permanently re-arrange the page order. The value may be one of the following: bitwise — sort alphabetically, for example: title1, title10, title2. creation — sort by date of creation. modified — sort by order of date last modified. natural — sort in 'natural' alphabetical order, for example: title1, title2, title10. position — sort by the default Confluence sorting rules. If your pages have been ordered manually, this sort will respect the defined order. Otherwise the pages will be displayed in the 'natural' alphabetical order, such as: title1, title2, title10. Include Excerpts in false Select if you want the page tree to show excerpts from each page. The Page Tree excerpts must be defined on each page by the Excerpt macro. (excerpt) Reverse Order false Select to show the pages in reverse (descending) natural order. Must (reverse) be used in combination with the Sort Pages By parameter. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 321 Include Search Box false Select if you want to include a search box above the page tree. The above Page Tree search box allows your readers to search within the page tree for the (searchBox) specified value. Show false Select if you want to display the 'expand all' and 'collapse all' links at the Expand/Collapse top of your page tree. Your readers can click these links to open or Links close all branches of the tree at once. (expandCollapseAll Available values in wikimarkup and storage format: ) true – Show the 'expand all' and 'collapse all' options. false – Do not show the options. Start Depth 1 Enter any number greater than 0 to set how many levels of children the (startDepth) tree should show when it opens for the first time. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: pagetree Macro body: None. Storage format example false natural 3 true true true Wiki markup example {pagetree:root=Page Name|sort=natural|excerpt=true|reverse=false|startDepth=3|expandCollapseAll=true|se archBox=true} Sample Page Tree This page is a sample, used to demonstrate the Pagetree macro. For more information, take a look at the main page on the Page Tree Macro. What you need to type What you will get {pagetree:root=@parent|expandCollapseAll=false} Another Sample Page Tree Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 322 We're using this page to demonstrate the Pagetree macro. For more information, take a look at the main page on the Page Tree Macro. What you need to type What you will get {pagetree:root=@parent|expandCollapseAll=true} Expand all Collapse all Sample Page Tree 2 This is another sample page, used to demonstrate the Pagetree macro. For more information, take a look at the main page on the Page Tree Macro. What you need to type What you will get {pagetree:root=@parent|expandCollapseAll=true} Expand all Collapse all Page Tree Search Macro Using the Page Tree Search macro, you can add a search box to your Confluence page. When a viewer enters a search term, Confluence will search a hierarchy of pages starting from a specified parent (root) page and return the search results. You can also add a search box as part of a dynamic page tree, which looks like a table of contents. See the Pag e Tree macro . Using the Page Tree Search macro To add the Page Tree Search macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Name of none The name of the root page whose hierarchy of pages will be searched by this macro. Root Page If this not specified, the root page is the current page. (root) Note: Unlike the Page Tree macro, the Page Tree Search macro does not accept the special values that start with an @ sign, such as @home or @self. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: pagetreesearch Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 323 Macro body: None. Storage format example My page name Wikimarkup example {pagetreesearch:root=My page name} Panel Macro The Panel macro displays a block of text within a customisable panel, like a text box. Handy hint: You can use panels within columns, in table cells and in the sections defined by page layouts. Here is an example of a Panel macro: My Title A formatted panel. Using the Panel macro To add the Panel macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Panel Title none The title of the panel. If specified, this title will be displayed in its own title (title) row. Border Style solid The style of the panel's border. Accepted values are solid, dashed and (borderStyle) other valid CSS border styles. Border Colour The colour of the panel's border. Colours can be specified as HTML colour (borderColor) names or hexadecimal codes. Border Pixel Width The width of the panel's border (in pixels). (Value Only) (borderWidth) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 324 Background Colour The background colour of the panel. Colours can be specified as HTML (bgColor) colour names or hexadecimal codes. Title Background The background colour of the title row of the panel. Colours can be Colour specified as HTML colour names or hexadecimal codes. (titleBGColor) Title Text Colour The colour of the text in the title row of the panel. Colours can be specified (titleColor) as HTML colour names or hexadecimal codes. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: panel Macro body: Accepts rich text. Storage format example #72bc72 #00a400 My title dashed blue white A formatted panel Wiki markup example {panel:title=My title|borderStyle=dashed|borderColor=blue|titleBGColor=#00a400|titleColor=white|bgC olor=#72bc72} A formatted panel {panel} PDF Macro The PDF macro displays the content of a PDF document on a page. First attach the document to a Confluence page, then use the macro to display the document. For details, see the View File Macro. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 325 Macro name: viewpdf Macro body: None. Parameter Required Default Parameter description and accepted values name name Yes (None.) The file name of the PDF document to be displayed. The document must be attached to a page on your Confluence site. page No The page The name of a Confluence page to which the PDF document is containing the attached. macro Storage format example Wiki markup example {viewpdf:page=Docs|name=My document.pdf} Popular Labels Macro The Popular Labels macro displays the most popular labels used throughout your Confluence site or within a space. A popular label is a label that has been added to many pages. Using the Popular Labels Macro To add the Popular Labels macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Number of Labels 100 Specifies the total number of labels to display in the heatmap. to Display (count) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 326 Restrict Labels to none Restricts the list of popular labels to the specified space. this Space Key (spaceKey) Style of Labels list list – displays the popular labels as a bulleted list, ordered by popularity (style) (highest first). heatmap – displays the popular labels using different font sizes for each label depending on the label's popularity, ordered by label names. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: popular-labels Macro body: None. Storage format example 20 Wikimarkup example {popular-labels:style=heatmap|count=20|spaceKey=ds} Profile Picture Macro You can use the Profile Picture macro to display a user's profile picture on a page, and it's useful for things like creating team pages that show all members of a project team. Hover your mouse-over the picture to see the Hover Profile for the user, and choose the user's picture or name to view their user profile. When editing the page, you can also select the macro and choose Vie w User Profile to see the profile for the user. Add the Profile Picture Macro 1. In the Confluence editor, choose Insert > Oth er Macros 2. Find and select the 'Profile picture' macro 3. Search for and select the user and choose Sa ve Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, then select the macro from a list of suggested macros. For more information, see Using Autocomplete. Code examples Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 327 The following example is provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: profile-picture Macro body: None. Storage format example Wiki markup Wiki markup is not available for this macro. You cannot add this macro via wiki markup. Recently Updated Dashboard Macro The Recently Updated Dashboard macro displays a list of the most recently changed content within Confluence. It is similar to the Recently Updated macro but is intended for use on the Confluence dashboard. Using the Recently Updated Dashboard macro To add the Recently Updated Dashboard macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Space(s) The space Filter content by space. The macro will display only the pages etc which (spaces) which belong to the space(s) you specify here. You can specify one or more contains space keys, separated by commas. '*' means all spaces. the page on which the macro is added Include these all types Filter content by type. You can specify one or more types, separated by Content Types commas. Available types are: page, blogpost or news, spacedesc, at Only tachment, comment, mail, userinfo. (types) Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 328 Label(s) none Filter content by label. The macro will display only the pages etc which (labels) are tagged with the label(s) you specify here. You can specify one or more labels, separated by commas. Note: If there are no pages matching any of the specified labels, then Confluence will ignore the labels and will list all recently updated pages, as well as showing a message, "These labels don't exist and were ignored: xxx ". This unexpected behaviour is noted in issue CONF-13860 - recently-updated-dashboard macro doesn't return an empty result when no pages match the specified label(s) RESOLVED User(s) all users Filter by username of the user who updated the content. The macro will (users) only display content created and updated by the user(s) you specify here. You can specify one or more usernames separated by commas. Width of Table 100% Specify the width of the macro display, as a percentage of the window (width) width. Show User Profile false Select whether profile pictures of the users who updated the content are Pictures displayed. (showProfilePic ) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: recently-updated-dashboard Macro body: None. Storage format example 50% choc page Wiki markup example {recently-updated-dashboard:spaces=ds|users=admin|width=50%|showProfilePic=true|lab els=choc|types=page} Recently Updated Macro The Recently Updated macro displays a list of the most recently changed content within Confluence. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 329 Using the Recently Updated Macro To add the Recently Updated macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Author(s) by None Filter the results by author. The macro will display only the pages etc username specified. which were last modified by the author(s) you specify here. (author) That is, display all You can specify multiple users. content Space(s) @self This parameter allows you to filter content by space. The macro will (spaces) display only the pages etc which belong to the space(s) you specify here. That is, the space You can specify one or more space keys, separated by a comma or a which space. contains the page To exclude content in a specific space, put a minus sign (-) on which immediately in front of that space key. For example: If you specify a the macro space key of -BADSPACE you will get only content which is not in the is used BADSPACE. To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.) Special values: @self — The current space. @personal — All personal spaces. @global — All site spaces. @favorite — The spaces you have marked as favourite. @favourite — The same as @favorite above. @all — All spaces in your Confluence site. * — The same as @all above. When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or [email protected]. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 330 Label(s) None Filter the results by label. The macro will display only the pages etc which (labels) specified are tagged with the label(s) you specify here. i.e. display all You can specify one or more label values, separated by a comma or a content space. To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'. To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'. The labels parameter only applies to the page and blog content types. Width of Table 100% Specify the width of the macro display, as a percentage of the window (width) width. Include these All types This parameter allows you to filter content by content type. The macro will Content Types display only the content of the type you specify here. Only (types) You can specify one or more types, separated by a comma or a space. To exclude content of a given content type, put a minus sign (-) immediately in front of that content type. For example: If you specify a content type of -blogpost you will get pages and all other content except for blog posts. Available values: page — Pages. blogpost or news — Blog posts, also known as news items. comment — Comments on pages and blog posts. attachment — Attachments. status — Status updates made by other users. Maximum Number 15 Specify the maximum number of results to be displayed. If this parameter of Results is omitted, then a maximum of 15 results are displayed. The theoretical (max) maximum value that this parameter can accept is 2 to the power of 31, minus 1 (or 2147483647), though this has been limited to 200 in the code, for performance reasons. More details are here. theme concise Choose the appearance of this macro: (theme) concise — the default list, showing the names of pages which were updated or commented on, the users who made the page modifications and time when the modifications occurred. social — lists recent modifications in reverse chronological order, but groups them by user into short time segments. A 'sub' list appears within each user's time segment, showing the names of pages which they updated or commented on and time when these modifications occurred. sidebar — lists recent updates in reverse chronological order, showing the names of pages which were updated or commented on and time when the page modifications occurred. This theme does not show authorship. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 331 Show User Profile false Specify showProfilePic=true to display the profile pictures of the Pictures users who updated the content. (showProfilePic ) Hide Title False Determines whether the macro hides or displays the text 'Recently (hideHeading) Updated' as a title above the list of content. Only available in wikimarkup and storage format. Accepted values: true – Title is hidden. false – Title is shown. Notes The Recently Updated Dashboard macro is similar to this macro, but is intended for display on the Confluence dashboard. If you would like to change the wording displayed by the Recently Updated macro, please refer to the document on modifying the Confluence interface text. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: recently-updated Macro body: None. Storage format example 10 50% sidebar choc page Wikimarkup example {recently-updated:spaces=ds|author=admin|max=10|hideHeading=true|width=50%|theme=si debar|showProfilePic=true|labels=choc|types=page} Recently Used Labels Macro The Recently Used Labels macro displays a list of the labels that have been most recently added to a page, blog Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 332 post or attachment. You can define the number of labels to be displayed and the scope (the current space, your personal space or site spaces, also known as 'global' spaces). Using the Recently Used Labels macro To add the Recently Used Labels macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters of this macro Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Number of Labels 10 Specifies the total number of labels to display in the list. to Display (count) Scope for global Specifies the scope of labels to be displayed in the list. Valid values include: Retrieving Labels (scope) global — covers all site spaces (non-personal) in the Confluence installation. space — the current space. personal — your own personal space. List Style list list – displays the list of labels horizontally. (style) table – includes additional information such as the page to which the label was added and the user who added it. Table Title none Adds a title to the top of the list in table style. Titles are only visible when the (title) List Style parameter has been set to table. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: recently-used-labels Macro body: None. Storage format example My title space table 20 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 333 Wiki markup example {recently-used-labels:title=My title|scope=space|style=table|count=20} Related Labels Macro The Related Labels macro lists all labels from every page which has one or more labels in common with the current page. Using the Related Labels Macro To add the Related Labels macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Restrict to these none Specify the labels for which you want to view related labels. For example, doc Labels umentation,my:stuff. (labels) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: related-labels Macro body: None. Storage format example choc,cake Wiki markup example {related-labels:labels=choc,cake} Roadmap Planner Macro Create simple, visual timelines that are useful for planning projects, software releases and much more with Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 334 the Roadmap macro. Roadmaps are made up of: bars to indicate phases of work Screenshot: Roadmap macro as it appears on a lanes to differentiate between teams, page products or streams markers to highlight important dates and milestones a timeline showing months or weeks. You can provide more information about items on your roadmap by linking a bar to a page. Adding the Roadmap macro To add the Roadmap macro to a page: 1. In the Confluence editor, choose Insert > Oth er Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Typ e { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Editing your Roadmap To edit your roadmap: Select the roadmap and choose Edit. Add lanes, bars and markers. Drag lanes, bars and markers to the desired location on the roadmap. Select lanes, bars and markers to add text, change colours and remove from the roadmap. Select bars to add links to existing pages, create new pages or add a description. Set the start and end dates for the roadmap and choose to display it by weeks or months. Screenshot: Roadmap macro in the editor Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 335 Parameters This macro does not use the macro browser to set parameters. You also cannot add this macro via wiki markup or by editing the storage format directly. Notes The Roadmap macro was previously available as an add-on from The Marketplace. The macro has changed significantly. If you had an older version of the macro installed you will be able to view your existing roadmaps but not edit them. RSS Feed Macro The RSS Feed macro embeds an RSS feed on a page. It can display the contents of external feeds, or of internal feeds generated by Confluence. To display blog posts or to list recently updated pages in a space, use the Feed Builder to create an internal feed, then render it using this macro. CAUTION: Including unknown HTML inside a webpage is dangerous. HTML inside an RSS feed can contain active scripting components. This means that it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a user's authentication cookie and give the attacker their Confluence login password. The RSS Feed macro may be disabled by your Confluence administrator. Also, your Confluence administrator can define a whitelist of trusted URLs. You will see an error message on the Confluence page, if the included URL is not in the whitelist. Using the RSS Feed macro To add the RSS Feed macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 336 where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description RSS Feed URL none The URL of the RSS feed link you want to show. (url) Maximum Number of Entries 15 Limit the number of entries displayed. (max) Show Item Titles Only false Show only the titles of the news items, not the content. (showTitlesOnly) Show Name/Title of RSS Feed true Hide the feeds title bar. (titleBar) How up to date is the feed? By default, the RSS Feed macro caches the feed results for 60 minutes before fetching the data again. If you wish to change the default caching, use the Cache macro to define how often the RSS Feed macro fetches the feed updates. You will need to install the Cache plugin onto your Confluence site. What happens to a page containing a disallowed URL? Your Confluence Administrator can set up a whitelist of allowed URLs. If this is the case, you may see an error on the pages which contain the RSS Feed macro. A user can add the RSS Feed macro or the HTML-include macro to a Confluence page. The macro code includes a URL from which the content is drawn. When the page is displayed, Confluence will check the URL against the whitelist. If the URL is not allowed, Confluence will display an error message on the page. The error message says that Confluence "could not access the content at the URL because it is not from an allowed source" and displays the offending URL. If the person viewing the page is a Confluence Administrator, they will also see a link to the Administration page where they can configure the URL whitelist. Here is an example of the error message, including the link shown only to Confluence Administrators: Here is an example of the error message, but without the link. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 337 Authentication Privatefeeds from external sites RSS feeds which require authentication cannot be accessed using the RSS Feed macro. Accessing internal HTTPS feeds This applies only to Confluence instances which have enabled HTTPS for all content. If your site is fully HTTPS, the RSS Feed macro cannot access internal feeds. To enable the RSS Feed macro to access internal feeds without affecting your HTTPS setup, enable local-only HTTP access: 1. Shut down Confluence. 2. Consult the SSL guide to enable HTTP access to Confluence. You'll want to ensure that you have an HTTP connector and an SSL connector, both commented in. This means that Confluence will be accessible via both HTTP and HTTPS. However, you should not have a redirect port, nor rules in web.xml to redirect all traffic. 3. Instead of using web.xml to redirect traffic, insert a firewall rule to redirect all HTTP requests not from the Confluence server to the equivalent HTTPS URL. This ensures that users will only be able to access Confluence via HTTPS, as intended. If you have still left HTTP access for attachments enabled (to avoid the IE download bug) you must selectively enable those URLS as well. 4. Modify your Confluence RSS Feed macro feed link to use the HTTP URL, and restart Confluence. Enabling the RSS Feed macro The RSS Feed macro is disabled by default. To enable the RSS Feed macro: 1. Go to > Add-ons. 2. Select System from the drop down and search for the Confluence HTML Macros add-on. 3. Expand the add-on and enable the rss (rss-xhtml) module. Code examples Macro name: rss Macro body: None. Storage format example 10 true false Wikimarkup example {rss:max=10|showTitlesOnly=true|url=http://myblog.com/feed|titleBar=false} Search Results Macro The Search Results macro searches your Confluence site based on search terms specified in the macro parameters, and displays the results on the wiki page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 338 Using the Search Results macro To add the Search Results macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Search Terms none The search terms which this macro will use to generate its results. (query) You can refine your search query by using operators such as 'AND' and 'OR'. For example: my_query1 AND my_query2 For more information, take a look at the documentation on the Confluence search syntax. Maximum 10 Set a limit to the number of search results displayed. Number of Results (maxLimit) Restrict to this all Start typing the space name to find the space, or specify the key of the space Space Key you want to search in. Note that the key is case sensitive. Content Type all Specify the content type. The content types are: page, comment, blogpost, att (type) achment, userinfo (the content of user profiles only) and spacedesc (the content of space descriptions only). Last Modified all Specify a period of time in weeks, days, hours and/or minutes, to see the (lastModified content modified within that time frame. ) These are the values you can use: w = weeks d = days h = hours m = minutes For example: 2h 35m 3d 30m Notes: If no time category is specified, Confluence assumes minutes. If you specify more than one time period (for example, weeks and days), you must separate the periods with a space. You can put them in any order. The time categories are not case sensitive. For example, '4d' is the same as '4D'. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 339 Restrict to this all Specify the username of a Confluence user, to show only content created or Username updated by that user. (contributor) Notes Permissions: When a user views the page containing the Search Results macro, the search results will show only pages and other content types for which the user has 'View' permission. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: search Macro body: None. Storage format example 3w choc 10 page Wiki markup example {search:lastModified=3w|query=choc|contributor=admin|maxLimit=10|type=page|spacekey =ds} Section Macro Used with the Column macro to define columns on a page. See Working with page layouts and columns and sections. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: section Macro body: Rich text, consisting of one or more Column macros. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 340 Parameter Required Default Parameter description and accepted values name border No False If the value is true, the columns in this section will have a dashed border. Storage format example The following example shows a section and column macro together. true 100px This is the content of column 1. This is the content of column 2. Wiki markup example {section:border=true} {column:width=100px} This is the content of *column 1*. {column} {column} This is the content of *column 2*. {column} {section} Space Attachments Macro The Space Attachments macro displays a list of all files attached to pages in a space. It shows details of the file and the includes a link to the page a file is attached to. Filters allow you to show only files with a particular label or file extension. Screenshot: The Space Attachments macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 341 Using the Space Attachments macro To add the Space Attachments macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters The Space Attachments macro displays a list of all the attachments in a space. You can choose to show attachments from the current space, or another space. Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 342 Space (none) Selects the Confluence space to display attachments for. If you do not specify a space, the current space will be used. Show Filter true Determines whether or not the filter panel is shown. If you select this option, Controls people viewing the page will be able to filter the list of attachments by file type (showFilter (extension) and by label. ) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: space-attachments Macro body: None. Storage format example false Wiki markup example {space-attachments:showFilter=false|space=ds} Space Details Macro The Space Details macro displays the details of a Confluence space, including the space name, description, and more. Using the Space Details macro To add the Space Details macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 343 Width of 100% The width of the space details table, specified as a percentage (%) of the page Table width. (width) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: space-details Macro body: None. Storage format example 50% Wiki markup example {space-details:width=50%} Space Jump Macro This page describes the Space Jump macro, which is provided with the Documentation theme. You can use space jumping to link from a page in one space to a page with the same name in another space, without knowing the name of the page when you create the link. Advance warning of plans to merge Documentation theme with the default theme This is an advance notice that we plan to merge the functionality of the Confluence Documentation theme with the Confluence default theme. We do not yet have a specific date for this plan, and we are interested in your feedback. The new default theme, introduced with Confluence 5.0, includes a sidebar with contextual navigation. Our plan is to include features from the Documentation theme in the default theme, and then remove the Documentation theme from Confluence. If you are interested in this change and would like to give us feedback, please add a comment on this blog post: Advance warning of plans to merge Documentation theme with the default theme. We are especially interested to know which features of the Documentation theme you use and value the most. The Space Jump macro inserts a link onto the page. When the reader clicks the link, they will jump to a page that has the same name in another space. You specify the space when you insert the Space Jump macro. Example: We use the Space Jump macro to put a standard message at the top of our archive spaces, telling people that they’re reading an old version of the documentation and letting them jump quickly to the same page in the latest documentation. See the words 'this page in the current documentation' in the screenshot below. Screenshot: One way of using the Space Jump macro Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 344 Using the Space Jump macro To add the Space Jump macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Space None The space key that contains a page with the same page title that you want the link to jump to. Space keys are case-sensitive. Alias None The text to display as the hyperlinked text. If you do not supply an alias, Confluence will display the page name. Notes What happens if there is no page with the same name in the target space? For the space jump to work, the target space must contain a page with the same name as the page that renders the Space Jump macro. If the target space does not contain such a page, you will see a broken link. Confluence handles this in its usual manner: the link is coloured red. If you click the link, Confluence offers to create the page for you. Can I use the Space Jump macro in any space? Yes. You can use the Space Jump macro in any space, even if that space is not currently using the Documentation theme. Provided that the Documentation theme plugin and its components are installed and enabled on your Confluence site, the Space Jump macro is available in any space. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: spacejump Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 345 Macro body: None. Storage format example My Space Wiki markup example {spacejump:alias=my link|space=ds} Spaces List Macro The Spaces List macro displays a list of spaces, similar to the list of spaces seen on the dashboard. Using the Spaces List macro To add the Spaces List macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Required? Default Description Scope of no all The view from which spaces are listed. Available options are: spaces all – All spaces in the Confluence installation. category – Spaces grouped according to space categories. favourite – Spaces which you have added to your favourites list. new – New spaces which have been created within the last 7 days. This parameter is unnamed in wikimarkup and storage format. Width of List no 100% The width of the spaces list, specified as a percentage (%) of the (width) window width. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 346 Macro name: spaces Macro body: None. Storage format example 80% favourite Wiki markup example {spaces:favourite|width=80%} Status Macro The Status macro displays a coloured lozenge (a rounded box) that is useful for reporting project status. You can choose the colour of the lozenge and the text that appears inside the lozenge. The macro also displays its current status in the editor, and you can change the status directly in the editor. ALL GOOD! Screenshot: Click on the Status macro lozenge to change the status. Using the Status macro To add the Status macro to a page using the Macro Browser: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Colour Grey The colour of the lozenge. The following colours are available: Grey , Red, Yellow, (colour) Green and Blue. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 347 Title The The text that will appear inside the lozenge. If you do not specify any text, the title (title) colour will be the colour of the lozenge, that is 'Grey', 'Red', 'Yellow', 'Green' or 'Blue'. that you select. Use False The style of the lozenge and its border. The default style lozenge is a solid outline background colour with white text. The outline style lozenge is white with a coloured style border and coloured text as shown here (subtle) ALL GOOD! Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: status Macro body: None. Storage format example Green On track true Wiki markup example {status:colour=Green|title=On track|subtle=true} Table of Contents Macro The Table of Contents macro scans the headings on the current Confluence page to create a table of contents based on those headings. This helps readers find their way around lengthy pages, by summarising the content structure and providing links to headings. Using the Table of Contents macro Hint: For quick access from the editor toolbar, choose Insert > Table of Contents. To add the Table of Contents macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Macro parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 348 Parameter Default Description Output Type list list — produces a typical list-type table of contents. (type) flat — produces a horizontal menu-type series of links. Display clear Select the check box to apply outline numbering to your headings, for example: Section 1.1, 1.2, 1.3. Numbering (outline) List Style disc Select the style of bullet point for each list item. You can use any valid CSS (style) style. For example: none — no list style is displayed circle — the list style is a circle disc — the list style is a filled circle. This is the typical bullet list, and is used for this example list. square — the list style is a square decimal — the list is numbered (1, 2, 3, 4, 5) lower-alpha — the list is lower-case, alphabetised (a, b, c, d, e) lower-roman — the list style is lower roman numerals (i, ii, iii, iv, v, vi) upper-roman — the list style is upper roman numerals (I, II, III, IV, V, VI) Heading Sets the indent for a list according to CSS quantities. Entering 10px will Indent successively indent heading groups by 10px. For example, level 1 headings will (indent) be indented 10px and level 2 headings will be indented an additional 10px. Separator brackets This parameter applies to flat lists only. You can enter any of the following (separator) values: brackets — Each item is enclosed by square brackets: [ ]. braces — Each item is enclosed by braces: { }. parens — Each item is enclosed by parentheses: ( ). pipe — Each item is separated by a pipe: anything — Each item is separated by the value you enter. You can enter any text as a separator, for example "***". If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters. Minimum 1 Select the highest heading level to start your TOC list. For example, entering 2 Heading Level will include levels 2, and lower, headings, but will not include level 1 headings. (minLevel) Maximum 7 Select the lowest heading level to include. For example, entering 2 will include Heading Level levels 1 and 2, but will not include level 3 headings and below. (maxLevel) Include Filter headings to include according to specific criteria. You can use wildcard Headings characters. See Sun's Regex documentation for examples of constructing (include) regular expression strings. Exclude Filter headings to enclude according to specific criteria. You can use wildcard Headings characters. See Sun's Regex documentation for examples of constructing (exclude) regular expression strings. Printable checked By default, the TOC is set to print. If you clear the check box, the TOC will not (printable) be visible when you print the page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 349 CSS Class If you have custom TOC styles in your CSS style sheet, use this parameter to Name output the TOC inside tags with the specified class attribute. (class) Absolute URL By default, the links in the TOC are relative URLs pointing to the current page. If (absoluteURL checked, the links in the TOC will be full URLs. This setting is useful when you ) are including a page with a Table of Contents in another page, and want to control where the links should take the user. Examples The examples below are based on this table of contents: Filtered Table of Contents This example filters the headings to include those that contain 'Favourite', but excludes headings which end with 'Things'. The list is styled with Roman numerals. Parameter Value List Style upper-roman Include Headings Favourite.* Exclude Headings .*Things The resulting table of contents is: Flat List This example filters all headings to render a flat list of 'Unknowns' enclosed in square brackets (the default list style). Parameter Value Output Type flat Maximum Heading Level 2 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 350 Include Headings Unknown.* The resulting table of contents is: Notes When you use a Table of Contents macro in a template, you will see an error when you preview the template itself. But the Table of Contents macro works on the pages that people create from the template – the table of contents shows up after they have saved the page. (This is probably because the template is not defined as a page, and the Table of Contents macro works for pages only.) Due to an outstanding issue in the Table of Contents macro (CONF-10619), the macro browser's Refresh function does not render any parameter modifications. Currently, the rendering of parameter value modifications to the Table of Contents macro occurs only after the page is saved. Using HTML heading markup with the Table of Contents macro The Table of Contents macro cannot handle HTML heading markup on its own. Hence, if you use the HT ML and HTML Include macros to render HTML heading markup in a Confluence page, the Table of Contents macro will not create a contents list out of these headings. (For more information about this issue, please refer to TOC-93.) However, if you insert an HTML anchor into each HTML heading on your page (based on the following syntax), the Table of Contents macro will incorporate these headings into your contents list. Heading Name The syntax for the anchor name is the page name and heading name separated by a hyphen. Remove all spaces and convert all text to lower case. Convert all punctuation marks to their URL-encoded equivalent. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: toc Macro body: None. Storage format example This example shows a list-type table of contents. true square 2 5px 2 bigpink [1//2] list true .* Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 351 This example shows a flat table of contents. 2 2 bigpink [1//2] flat true pipe .* Wiki markup example This example shows a list-type table of contents. {toc:printable=true|style=square|maxLevel=2|indent=5px|minLevel=2|class=bigpink|exc lude=[1//2]|type=list|outline=true|include=.*} This example shows a flat table of contents. {toc:printable=true|maxLevel=2|minLevel=2|class=bigpink|exclude=[1//2]|type=flat|ou tline=true|separator=pipe|include=.*} Table of Content Zone Macro You can use the Table of Content Zone macro to mark out a section (zone) within the page from which to create a table of contents. You can style the headings as a flat list, and place the list of links at the top and bottom of the section or page, to provide navigation bars similar to web navigation. Using the Table of Content Zone macro To add the Table of Content Zone macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description location both Specifies where in the zone the output list is displayed: top, bottom, or both, (location) which encloses the page zone content. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 352 Output Type list Specifies the layout for the table of contents: (type) list – produces a vertical list, typical of a TOC. flat – produces a horizontal menu-type series of links, for example: [Heading 1] [Heading 2] [Heading 3]. Display false Select to apply outline numbering to your headings, for example: 1.1, 1.2, 1.3. Section Numbering (outline) List Style none Specifies the style of bullet point for each list item. You can use any valid CSS (style) style. For example: none — no list style is displayed circle --- the list style is a circle disc — the list style is a filled circle. This is the typical bullet list, and is the one we're using for this example list square — the list style is a square decimal — the list is numbered (1, 2, 3, 4, 5) lower-alpha — the list is lower-case, alphabetised (a, b, c, d, e) lower-roman — the list style is lower roman numerals (i, ii, iii, iv, v, vi) upper-roman — the list style is upper roman numerals (I, II, III, IV, V, VI) Heading Sets the indent for a list output type, according to CSS quantities. Entering "10px" Indent will successively indent list heading levels by 10px. For example, h1 headings will (indent) be indented 10px and h2 headings will be indented an additional 10px. Separator brackets Only applies to the flat output type. Specifies the display style of the links. You (separator can enter any of the following values: ) brackets — Each item is enclosed by square brackets: [ ]. braces — Each item is enclosed by braces: { }. parens — Each item is enclosed by parentheses: ( ). pipe — Each item is separated by a pipe: anything — Each is separated by the value you enter. You can enter any text as a separator, for example '***'. If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters. Minimum 1 Select the largest heading level to start your TOC list. For example, 2 will list h2, Heading h3, and h4 headings, but will not include h1 headings. Level (minLevel) Max 7 Select the smallest heading level to include in the TOC. For example, 2 will list h1 Heading and h2, but will not include h3 and below. Level (maxLevel) Include Filter the included headings according to specific criteria. You can use wildcard Headings characters. See Sun's Regex documentation for examples of constructing regular (include) expression strings. Exclude Exclude headings according to specific criteria. You can use wildcard characters. Headings See Sun's Regex documentation for examples of constructing regular expression (exclude) strings. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 353 Printable true By default, the TOC is set to print. If you clear this parameter, the TOC will not be (printable visible when you print the page. ) CSS Class If you have a custom TOC in your CSS style sheet, you can use this parameter to Name output the TOC with the specified "class" attribute. (class) Examples The examples are based on a page with the following headings: Filtered Table of Contents This example will filter all headings to include those that contain "Favourite", but will exclude any heading which ends with the word "Things". The list is styled with upper-case Roman numerals. Parameter Value Output Type list List Style upper-roman Include Headings Favourite.* Exclude Headings .*Things Screenshot: Filtered TOC 'zone' headings Flat List This example will filter all headings to render a flat list of "Unknowns" enclosed in square brackets. Parameter Value Output Type flat Separator brackets Max Heading Level 2 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 354 Include Headings Unknown.* Screenshot: Filtered TOC 'zone' headings displayed as a flat list Notes Due to an outstanding issue in the Table of Content Zone macro (CONF-10619), the Macro Browser's Ref resh function does not render any parameter modifications. Currently, the rendering of parameter value modifications to the Table of Content Zone macro occurs only after the page is saved. Using HTML heading markup with the Table of Content Zone macro — The Table of Content Zone macro cannot handle HTML heading markup on its own. Hence, if you used the HTML and HTML Include macro s to render HTML heading markup in a Confluence page, the Table of Content Zone macro will not create a contents list out of these headings. (For more information on about this issue, please refer to TOC-93.) However, if you insert an HTML anchor into each HTML heading on your page (based on the following syntax), the Table of Content Zone macro will incorporate these headings into your contents list. Heading Name The syntax for the anchor name is the page name and heading name separated by a hyphen. Remove all spaces and convert all text to lower case. Convert all punctuation marks to their URL-encoded equivalent. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: toc-zone Macro body: Accepts rich text. Storage format example false 2 2 top flat true pipe Only headings within this block are included in the table of contents. Wiki markup example Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 355 {toc-zone:printable=false|maxLevel=2|minLevel=2|location=top|type=flat|outline=true |separator=pipe} Only headings within this block are included in the table of contents. {toc-zone} User List Macro The User List macro displays a list of Confluence users, based on their group membership. The macro can also indicate when users are online or offline. Using the User List macro To add the User List macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Group(s) none Specify the group name. Specify multiple groups separated by a comma, (groups) or use * to show all users in Confluence. Display All Online/Offline registered List online or offline users. Leave blank to show all users, irrespective of Users users status. (online) Accepted values: Unspecified – The macro will show all registered users. true – The macro will show only online users. false – The macro will show only offline users. See below for information on how to configure this macro to display online / offline users. Configuring the User List macro In order to use the Display Online / Offline Users parameter to indicate whether users are currently logged in to Confluence, you will need to enable the User Log In Listener component in the add-on that provides this macro. You'll need Confluence Administrator permissions to do this. To enable the Display Online/Offline Users filter in the User List macro: 1. Go to Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 1. 356 > Add-ons 2. Select System from the drop down and search for the User Lister add-on 3. Expand the add-on and enable the User Log In Listener module. 4. Restart Confluence for the change to take effect. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: userlister Macro body: None. Storage format example confluence-users false Wiki markup example {userlister:groups=confluence-users|online=false} User Profile Macro The User Profile macro displays a short summary of a given Confluence user's profile. This is the same summary that appears in a Hover Profile, which appears whenever you mouse over a user's name in the Confluence interface. Screenshot: Example of the User Profile macro Using the User Profile macro To add the User Profile macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 357 Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Username none The username of the Confluence user whose profile summary you wish to show. (user) Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: profile Macro body: None. Storage format example Wiki markup example {profile:user=admin} User Status List Macro The User Status List macro displays a history of a given Confluence user's status updates. This is the same history that appears in the user's Status Updates view. Screenshot: Example output of the User Status List macro Using the User Status List macro To add the User Status List macro to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 358 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Default Description Username none The username of the Confluence user whose history of status updates you wish to (username show. ) Notes Hint: If you wish to list status updates made by more than one user, you can use the Recently Updated macro w ith the following parameter values: Include these Content Types Only: status Author(s) by username: The user(s) whose status updates you want to include in the list. If you leave this field blank, the status updates of all users will be included. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: status-list Macro body: None. Storage format example Wiki markup example {status-list:username=admin} View File Macro The View File macros allow you to embed an Office or PDF document on a page. First attach the document to a page and then use one of the View File macros to display the document's content. When people view the page, they will see the content of the Office or PDF document. They do not need to have Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 359 Office installed in order to see the content of the file. For a full list of Office Connector prerequisites and limitations, please refer to: Office Connector Prerequisites Office Connector Limitations and Known Issue Displaying an Office or PDF Document in Confluence To display an Office or PDF document in a page, use one of the following View File macros in the macro browser: Office Excel Office PowerPoint Office Word PDF To add one of the View File macros to a page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters for the Office and PDF macros Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Macro Parameter Default Description All View Page The page Enter a page name, if you wish to display a document which is File Name which attached to another Confluence page. macros contains the macro File Name none The file name of the Office or PDF document to be displayed. The document must be attached to a page on your Confluence site. Office Show true Select to show grid lines around each cell of the Excel spreadsheet. Excel Grid? Clear to hide these grid lines. Worksheet Last The name of the worksheet that you want displayed. Name worksheet viewed in the spreadsheet Last Row Last row The number of the last row you want displayed, starting from '0' as with content the first row. Last Last column The number of the last column you want displayed, starting from '0' Column with content as the first column. Hint for reducing the size of the spreadsheet: Use the Last Column and Last Row parameters to reduce the size of the spreadsheet displayed on the wiki page. This is especially useful to prevent the display from showing empty cells. This will also help to prevent 'out of memory' errors. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 360 Office Height Specify the height of the display, in pixels (default) or as a percentage of the window's height. PowerPoint Slide none Specify the number of the slide that you want displayed on the Number Confluence page, where the first slide is numbered zero. Instead of a slide show, the page will display just the single slide, represented as a JPEG image. If not specified, all slides display as a slideshow. Width Specify the width of the display, in pixels (default) or as a percentage of the window's width. Editing an Office document You can launch your Office application and edit Office documents displaying in the view file macros directly from your Confluence page. Word and Excel - choose the Edit Document link above the content PowerPoint - choose the edit icon on the viewer. You will find more information and other methods for editing attached Office documents in Editing Office Files. Troubleshooting Problems? Please refer to our guide to the Office Connector limitations and known issues. Code examples Refer to the page for each macro to see storage format and wikimarkup examples. Office Excel Macro Office PowerPoint Macro Office Word Macro PDF Macro Widget Connector Macro Embed online videos, slideshows, photostreams and On this page: more directly into your page with the Widget Connector macro. Using the Widget Connector Parameters The macro currently supports content from these Examples sites: YouTube Vimeo YouTube MySpace Video Vimeo Flickr MySpace Video Twitter Flickr SlideRocket Twitter Google Calendar Slide Rocket Troubleshooting Google Calendar Code examples Storage format example Using the Widget Connector To add the Widget Connector to a page: 1. In the Confluence editor, choose Insert > Oth er Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Typ e { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 361 To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Parameter Description Web Site's This is the external site's URL. In some sites this will be the URL shown in the address bar Widget of your browser, and in other sites you may need to click a Share or Link button to get the URL URL. (url) Pixel The height of the display, in pixels. Height (Value Only) (height) Pixel Width The width of the display, in pixels. (Value Only) (width) Examples Every site is a little different, so we've put together some info on what you'll need to do to embed each site's content on a page. YouTube The fastest way to embed a YouTube video is to paste the URL into the editor. Confluence will autoconvert the link and insert the macro for you, like magic. Autoconvert works with both long and short YouTube URLs. If you're pasting the URL into the Widget Connector macro URL field manually, you'll need to use the long URL (from the address bar). Long URLs look something like this https://www.yo utube.com/watch?v=k6lK5hlB1nQ. If you're not able to see the video in some browsers, try using https rather than http in your link. Links that contain a parameter to start a video at a particular time won't autoconvert or work in the Widget Connector macro, like this link: https://www.yout ube.com/watch?t=15&v=LhHKkodOPFo. Paste in the short sharing URL to be sure it works. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 362 Vimeo The fastest way to embed a Vimeo video is to paste the URL into the editor. Confluence will autoconvert the link and insert the macro for you. You can use the URL from the address bar in your browser or the Share button in Vimeo. MySpace Video We don't autoconvert MySpace videos, so you'll need to add the Widget Connector macro to your page first, and then paste the video's URL into the URL field. You can use the URL from the address bar in your browser or the Sharing options in MySpace. Flickr You can embed a single photo, a set, an entire user's photo stream or collection of photos with a particular tag. The fastest way is to paste a URL into the editor. This works for sets and tags. For other URLs you'll need to add the Widget Connector macro to the page first and then paste your link into the URL field. Use the URL from the address bar in your browser. Twitter We don't autoconvert Twitter, so you'll need to add the Widget Connector macro to your page first, and then paste the URL into the URL field. To embed a single tweet you'll need to click the Details link on the tweet so you can grab the URL for just that tweet. The URL will look something like https://twitter.com/atlassian/status/3469765212 50037760. To embed a dynamic list of tweets you'll need to create a Widget in Twitter first: 1. In Twitter, go to Settings > Widgets and create a widget to display the tweets you want to embed (for example, a user timeline, list of tweets or hashtag search). 2. Save the widget, then copy the page URL. The URL should look something like this https://twitt er.com/settings/widgets/354381809263472640 (without /edit on the end). 3. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 363 3. In Confluence, paste the URL into the Widget Connector. 4. The list of tweets will display, like this one below. SlideRocket We don't autoconvert SlideRocket presentations, so you'll need to add the Widget Connector macro to your page first, and then paste the video's URL into the URL field. You can get the URL from the Sharing button on the SlideRocket player. Google Calendar We don't autoconvert Google Calendars, so you'll need to add the Widget Connector macro to your page first, and then paste the calender address into the URL field. You can only embed public calendars. To get your calendar's URL, in Google Calendar go to Calendar Settings > Calendar Address and click the HTML button. The URL will look something like this: https://www.google.com/calendar/embed?src=en.austral ian%23holiday%40group.v.calendar.google.com&ctz=Australia/Sydney Troubleshooting If the Widget Connector can't display content from the external site, the macro will look like this: example.com We rely on the external website's APIs to display content in the Widget Connector macro. APIs do change from time to time and this can cause the Widget Connector macro to stop rendering content. If you experience problems, you can raise an issue about it to let us know. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 364 Macro name: widget Macro body: None. Storage format example 480 640 Task Report Macro Use the Task Report macro to display a list of tasks on a page. Filter the On this page: tasks by space, page, user, label, created date and more. Using See Add, Assign, and View Tasks for more information on creating and the Task assigning tasks. You can also use the Task Report blueprint, which will Report create a page and add this macro for you. macro Parameter s Using the Task Report macro Code examples To add the Content Report Table macro to a page: Related pages: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Add, Assign, Speeding up macro entry with autocomplete: Type { and the beginning of and View the macro name, to see a list of suggested macros. Details are in Using Tasks Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Task Report macro showing incomplete tasks, on pages with the label 'meeting-notes'. Parameters Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example). Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 365 Parameter Required Default Description Space(s) and No None Filter by the task location. The Page(s) macro will only display tasks in (spaceAndPage) the pages or spaces specified. You can enter a combination of spaces and pages. Label(s) No None Filter by Label. The macro will (labels) only display tasks on pages with this label. You can enter multiple labels, separated by a comma. Assigned to No None Filter by Assignee. The macro (assignee) will only display tasks assigned to the users specified. Created by No None Filter by Creator. The macro (creator) will only display tasks created by the users specified. Created after No None Filter by created date. The (createddateFrom macro will only display tasks ) created on or after the date specified. Date must be entered as dd-mm-yyyy. Task status Yes Incomplete Show complete or incomplete (status) tasks. Number of tasks to No 20 The number of tasks to display display on each page of results in the (pageSize) table. Choose from 10, 20 or 40. Display columns No description,duedate,assignee,location Columns to include in the (columns) table. Available columns include description, duedate, assignee, location, completedate and labels. Sort by No Due date Sort tasks by due date, (sortBy) assignee or page title. Select the Reverse Sort check box to sort the table in reverse order. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: tasks-report-macro Macro body: None. Storage format example Note: The spaceAndPage multi-picker parameter populates the spaces and pages parameters. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 366 BSP complete space:BSP,page:2555905 2555905 meeting-notes 10 Wiki markup Wiki markup is not available for this macro. You cannot add this macro via wiki markup. JIRA Chart Macro JIRA is Atlassian's issue tracking and project management system. By adding the JIRA Chart macro to a Confluence page, you can display information about JIRA issues and projects as pie charts. Before you can use this macro, your Confluence and JIRA sites must be connected via Application Links. People viewing the page will see charts for publicly accessible issues from the JIRA site. If your JIRA site has restricted viewing (that is, people need permission to view issues) then they will need to authenticate before seeing the charts. This macro is compatible with JIRA 5.x and later. Adding the JIRA Chart macro to a page Quick guide to using the macro on a Confluence page: 1. In the Confluence editor, choose Insert > Other Macros 2. Find and select the required macro Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete. To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro. Using the JIRA Chart Macro To add a JIRA chart to your page: 1. Insert the JIRA Chart macro (see above). 2. Select your JIRA server. If you have multiple JIRA instances linked to Confluence the drop down will default to the primary application link. 3. Search for issues - you can enter the query in JQL or paste a JIRA URL directly into the search field. 4. Choose Preview to see the chart. 5. Choose Insert. To find out more about searching for issues see Displaying issues via a JIRA Query Language (JQL) search. You can further control how the chart appears on your page. Choose Display options: Chart by - select the JIRA field you want to segment the pie chart by. Width - define the total width of the chart area. You can enter values in pixels or percent. Leave blank to auto fit. Show border - add a border around the chart area Show chart information - include a text summary under the chart with the total issues count and chart Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 367 by value. Screenshot: The JIRA Chart Macro in the macro browser Disabling the JIRA Chart macro The functionality is provided by an add-on (plugin) called 'JIRA Macros'. This macro is also used for the JIRA Issues macro. To make the macro unavailable on your site, you can disable the add-on. See Disabling and enabling add-ons. Notes HTTPS: The JIRA Chart macro can access a JIRA site running under SSL provided the Confluence server is configured to accept the JIRA SSL certificate. See Connecting to LDAP or JIRA or Other Services via SSL. Authentication: If the query includes issues that require authentication (issues that are not visible to anonymous users in JIRA), users will be prompted to authenticate to view charts on the Confluence page. In order to search for issues in the macro browser you may need to authenticate. With JIRA 5.x you will be able to search for unrestricted issues as an anonymous user, however with JIRA 6.x you must be authenticated to search for any issues. Code examples The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. Macro name: jirachart Macro body: None. The following parameters are available in storage format. Parameter Required Default Parameter description and accepted values name chartType Yes Pie Type of chart to display. Currently Pie is the only available chart type. Other types may be added in future. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 368 statType Yes Statuses The JIRA field to segment the pie chart by: statuses - displays a breakdown of issues by Status. allFixfor - displays a breakdown of issues by chart by all Fix Versions (useful if issues have more than one fix version). assignees - displays a breakdown of issues by the Assignee nam e. priorities - displays a breakdown of issues by Priority. components - displays a breakdown of issues by Component. issuetype displays a breakdown of issues by Issue Type. showinfor No False Displays text information about the data below the chart. Includes the Total value and the Chart By value. jql Yes JQL query for the chart to display. width 600 (blank) This is the total width of the chart area. Width can be entered in pixels, percent or left blank to fit to the available space. border No False Displays a border around the chart area. Storage format example Example chart by Issue Type - note that Confluence will insert the server and serverId parameters, based on settings in Application Links: pie issuetype true project%20%3D%20CONF%20and%20fixVersion%20in%20('5.3') 600 JAC 144880e9-a353-312f-9412-ed028e8166fa true Collaboration Confluence is all about encouraging team collaboration to get the best Related pages: results, so we've built in a number of ways you can notify other people about content that may be of interest to them. Pages and Blogs You can: Watch Pages, Share a link to a page or blog post via email Spaces Mention a user when you write a page, blog post, comment, or add a and Blogs task Exporting Like a page, blog post or comment Content to Whenever you mention another user, they'll receive an email notification; if Word, you like a page, blog post, or comment, the author will be notified that you lik PDF, e the content. HTML and XML Other users can also find out about changes to content in Confluence by wat ching pages and spaces. Another way to share Confluence content is by exporting it to other formats such as XML, HTML, Microsoft Word and PDF. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 369 Network Overview You can Create a network of users who are important to you, to make sure On this page: you're always up-to-date with their Confluence activity. You might want to follow your boss or teammates, to see what they're working on, or whoever Follow creates the most entertaining blog posts. another user When someone's part of your network, you'll be able to see when they: Access your Add or edit pages or blog posts network Comment on a page or blog post or edit existing comments view Update their user status Notes Update their user profile Related pages: Network Follow another user Macro Subscribin You can follow another user by using either their Hover Profile or your g to a Network view. Network To follow a user with their Hover Profile, hover your mouse over their profile RSS Feed picture when it appears in a page and choose Follow. Email Notification s To follow a user from your Network view: 1. Choose your profile picture at top right of the screen, then choose Network Alternatively, choose More in the Network section of your profile sidebar. 2. Search for and select the user in the Following field 3. Choose Follow If you now refresh or revisit your Network view, the profile picture(s) of the user(s) you just followed will appear within the Following list on the right. Their tracked activities will also start appearing in the Recent Activity list. Access your network view If you want to see what's been happening in your network, access your network view as described above. You can access another user's Network view using the Hover Profile by choosing More > Network Page. Screenshot: Example of the Network view Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 370 Notes RSS feeds: you can subscribe to any Confluence user's network RSS feed and receive summaries on the activities of other users they're following in their network. See Subscribing to a Network RSS Feed. Email notifications: you can request email notifications of any activity in your network. See Email Notifications. Likes and Popular Content Has someone written a good blog post or page on Confluence? Or made a comment you agree with? Click the Like button to them know. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 371 When you like a page, blog post or comment, the author of the content On this page: receives a notification. If enough people like the content, it'll appear on the P opular tab of the dashboard. Disabling the 'like' feature Disabling the 'like' feature Disabling notification The like functionality is provided by a plugin called the 'Confluence Like s when Plugin'. To remove the like functionality from your site, disable the plugin. your content is 'liked' Disabling notifications when your content is 'liked' Related pages: There are two ways to turn the 'someone likes your page' notifications off. Dashboard Do either of the following: Email Notification Open an email notification of a like, and click Manage Notifications s Go to /plugins/likes/view-notifications.action Overview User Status Updates You can set your 'user status' to let other Confluence users know what On this page: you're thinking about right now, or to broadcast any other short message (as long as it's less than 140 characters). Other users can see your status in Setting or recent activity stream on the dashboard, or on their network page if they're updating following you in Confluence. your status Mention Your current status message appears on the profile popup that appears another when people hover over your username or profile photo in Confluence. person in your status update Setting or updating your status Viewing status To set or update your status: updates Enabling 1. Choose your profile picture at top right of the screen, then choose and Update Status (the 'What are you working on' dialog will open) disabling 2. Enter a short message (140 characters maximum) status 3. Choose Update updates Related pages: Mention another person in your status update Your Confluenc e User Status List Macro Recently Updated Macro Recently Updated Dashboard Macro You can include another person's Confluence username in your status update, using square brackets and the tilde sign in the format [~username]. Confluence will send that person an email message with your status update. Note: Mentions in status updates don't appear as notifications in the Confluence workbox. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 372 Viewing status updates Your 'Status Updates' view shows a history your status updates. To view your status updates, choose your profile picture at top right of the screen, then choose Status Updates. View another user's status by going to their profile. You can also clear your latest status update, or delete older updates from this view. Enabling and disabling status updates The status update functionality is provided by a plugin called 'User Status'. To remove the status updates functionality from your site, you can disable the plugin. You can also set the Confluence site permissions to determine which users can use status updates. By default, users will not have permission to use this feature. See Global Permissions Overview. Using Mentions Mentions (often known as @mentions) are a seamless way of drawing Related pages: someone's attention to a page or comment, or assigning a task to them. When you mention a user, they'll receive a notification by email and in their Using the workbox; if you mention them in a task, the task is assigned to them and Editor appears in their tasks list. Using Autocompl There are two ways to mention someone: using autocomplete, or via the ete Insert menu in the editor toolbar. Keyboard Shortcuts Workbox Use autocomplete Notification s To mention someone using autocomplete, type '@' in the editor then start typing their name. Choose the person you want to mention from the list of suggestions. Screenshot: Autocomplete for mentions Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 373 Use the Insert menu If you'd rather use the Insert menu, choose Insert > User Mention then search for and select the user you want to mention. Notes Disable the user mention feature – The functionality is provided by a plugin called the 'Confluence Mentions Plugin'. If you need to remove the user mention functionality from your site, you can disable the plugin. See Disabling or Enabling a Plugin. Mentioning groups – You can only mention individual users. There's a feature request to allow mentions for groups: CONF-23015 - Extend 'Mentions' to work with groups as well OPEN You can Mention people in status updates. See User Status Updates. Link to a user profile – You can use a square bracket '[' and a person's name to trigger Confluence autocomplete and link to a person's user profile or personal space. Confluence will send the person a notification just as if you had used @mention (unless the administrator has disabled the user mention feature). Share a Page or Blog Post You can use the 'Share' option in Confluence to email anyone a link to a page or blog post. The recipients can be Confluence users or any email Related pages: address(es). Workbox To share a link to a Confluence page or blog post: Notification s 1. Go to the page or blog post you wish to share Create and 2. Choose Share Edit Pages Blog Posts The Share button will only visible if your Confluence administrator Configurin has configured an outgoing mail server for your Confluence site. g a Server 3. Enter a username, group or email address, and select the appropriate for user, group or email address from the list of suggestions Outgoing Repeat this process to add multiple recipients to the list. Mail 4. Enter an optional message into the Note box 5. Choose Share to send the link via email In addition to an email, Confluence users will also receive a notification in their Confluence workbox. See Workbox Notifications . To remove a recipient from the list, choose the delete icon to the right of the recipient. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 374 Commenting on pages and blog posts Comments are a great way to bring others into the conversation about a On this page: page or blog post. They allow you to remark on content, add important information, ask questions, and generally drive collaboration and teamwork. Add a page or You can add a comment at the bottom of any page or blog post, or add an in blog post line comment by highlighting specific text on the page. comment Add an inline Add a page or blog post comment comment Resolve 1. Type your comment in the comment field at the bottom of the page inline 2. Optionally, choose Preview to see how your comment will appear comments 3. By default, Watch this page is ticked (This means you'll start Rich receiving notifications about the page. Uncheck it if you don't want to comments watch the page.) Link to a 4. Choose Save (Ctrl+S or +S) comment Comment Other users can reply and/or like your comment, and you or a space permission administrator can edit your comment(s). s Notes Related pages: Create and Edit Pages Blog Posts Collaborati ng on Files Share a Page or Blog Post Add an inline comment 1. Highlight the text you want to comment on 2. Choose the add comment button that appears above the highlighted text 3. Type your comment and choose Save ( Ctrl+S or +S) The selected text will appear with a yellow highlight indicating an inline comment; choose any highlighted text on the page to display the related comment(s). Just like page and blog post comments, others can reply to, or like, your inline comments, and you'll be notified when they do. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 375 Resolve inline comments Hit Resolve to hide a set of inline comments once the conversation's finished. If you want to view resolved comments, choose > Resolved comments; to reopen a resolved comment, choose Reopen at the bottom left. Rich comments Inline and page comments might look simple, but they support rich text (like bold, underline, and italics), bull eted and numbered lists, links, and @mentions. You can also drop images into any comment, to really illustrate your point. Link to a comment You can link directly to a comment on a page. See Working with Links for more information. If you don't see a popup when you highlight text, check that Text Select is enabled in your profile settings. Comment permissions Add a comment – You need the 'Add Comments' permission in the space. Edit a comment – You need the 'Add Comments' permission. Space administrators can edit all comments within their space. The date on a comment always indicates the time the comment was last edited. Delete a comment – You need the 'Remove Comments' permission. Deleted comments cannot be restored. If you don't have the 'Remove Comments' permission, you can delete your own comments, but only if there are no replies to your comment. Disable comments – If you don't want comments in a particular space, remove the 'Add Comments' permission from the 'confluence-users' or 'users' group, anonymous users and all other users and groups. The option to add comments will no longer appear on pages or blog posts in that space. See Space permissions for more information. There is no permission that controls comments across the entire site. Notes Choose Watch at the top-right of the page to receive an email notification whenever anyone edits or adds a comment to the page. On blog posts only, an 'Author' lozenge will appear on any comments made by the original author of the post. It's not possible to delete all comments on a page simultaneously, or change the order of comments. Watch Pages, Spaces and Blogs You can 'watch' a Confluence page, blog post or space. Confluence will then send you a notification email whenever anyone updates your watched content. You'll receive email notifications for: Edits (unless the author clears the 'Notify watchers' check box). Deletions. Attachments, including new versions or deletions of an existing attachment. Comments, including new comments, edits of existing comments or deletions of existing comments. By default, Confluence will assign you as a watcher of any page or blog post that you create or edit. This behaviour is called 'autowatch'. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 376 There's no daily digest for email notifications. You'll receive an email On this page: notification every time someone makes a change. Watching a You will not receive email notifications for content changes due to the page or output of a macro, because the page content itself hasn't been edited. blog post Watching You need 'View' permission for the page, blog post or space to receive an entire notifications. space Watch for Watching a page or blog post new blog posts in a To start watching a page or blog post: space Watch all 1. Go to the page or blog post spaces on 2. Choose Watch and select the relevant check box the site To stop watching the page or post, deselect the relevant check box. Watching for all new blog posts Watching an entire space on the site Manage watches from your user profile Manage watches from the email message Autowatch and other notification options Related pages: Managing Watchers Email Notification s Your User Profile You can choose to watch all the pages and blog posts in a particular space. The quickest way is to use the Watch option on a page or blog post, as described above. To stop watching the space, deselect the relevant check box. Alternatively, choose Pages in the space sidebar, then choose Watch this space at the top right. If your space uses the Documentation theme, choose Browse > Space Operations. Then choose Watch this space in the left-hand menu. Watch for new blog posts in a space You can choose to receive a notification whenever someone adds a blog post in the space. You will not receive notification of updates to or deletions of blog posts, nor of comments on the blog posts. To watch for new posts: 1. Go to a blog post in the space 2. Choose Watch and select Watch all blog posts in this space Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 377 To stop watching for new blog posts, deselect the relevant check box. Alternatively, choose Blog in the space sidebar, then choose Watch this blog at the top right. If your space uses the Documentation theme, choose Browse > Space Operations. Then choose Watch this blog in the left-hand menu. Watch all spaces on the site You can receive notifications about changes to the content of pages, blog posts and comments from all spaces on a Confluence site. To start watching for content changes across the whole site: 1. Choose your profile picture at top right of the screen, then choose Settings 2. Choose Email 3. Choose Edit then choose Subscribe to daily updates 4. Choose Submit Watching for all new blog posts on the site You can choose to watch for all new blog posts in all spaces on the Confluence site. You will not receive notification of updates to or deletions of blog posts, nor of comments on the blog posts. To start watching for all new blog posts: 1. Choose your profile picture at top right of the screen, then choose Settings 2. Choose Email 3. Choose Edit then choose Subscribe to all blog posts 4. Choose Submit Manage watches from your user profile The 'Watches' page in your user profile displays a list of all pages and spaces you are currently watching. To manage your watches: 1. Choose your profile picture at top right of the screen, then choose Watches 2. Choose Stop Watching for any unwanted spaces or pages Manage watches from the email message The email notifications that you receive from Confluence have some useful links at the bottom of the email message. The links in each message vary, depending on the context. In general, the links allow you to view the page online, reply to a comment, and so on. In particular with respect to setting your notification preferences, you will see one or more of the following links: Stop watching page – Click this link to stop watching the page that triggered the email notification. Stop watching space – Click this link to stop watching the space that triggered the email notification. Stop following this user – Click this link to stop following the user whose update triggered the email notification. Manage Notifications – Click this link to go to the email settings page in your user profile. Screenshot: Example email notification footer showing links Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 378 Autowatch and other notification options By default, Confluence will assign you as a watcher of any page or blog post that you create or edit. This behaviour is called 'autowatch'. You can turn autowatch on or off, and set other notification options, in the email settings section of your user profile. See Edit Your User Settings. Managing Watchers If you're an administrator of a space, you can manage the watchers for all pages and blog posts in that space. This means that you can: View a list of the watchers of a page or blog post. View a list of the watchers of the space that contains the page or blog post. Add users as watchers of the page or blog post. Remove existing watchers of the page or blog post. You cannot remove watchers of the space. Related pages: Watch Pages, Spaces and Blogs Email Notifications Watch Pages, Spaces and Blogs Your Confluence To manage the watchers of a page or blog post: 1. Go to the page or blog post for which you want to manage the watchers 2. Choose Watch > Manage Watchers. 3. The 'Manage Watchers' screen will appear The left-hand column shows the users watching the page or blog post. The right-hand column shows the users watching the space. To remove an existing page watcher, choose the icon (trash can) next to the user's name. To add a user as a watcher of the page, type their username and choose Add. Screenshot: Managing watchers Email Notifications You can 'watch' a page, blog post or space. Confluence will then send you a notification by email whenever anyone adds or updates content on that page or space. You can also subscribe to daily email reports and other notifications of various updates, as described below. You will only receive notifications for content that you have permission to view. Users that have been disabled by an administrator will not receive email notifications. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 379 Subscribing to email notifications On this page: Subscribin You can subscribe to the following email summary reports: g to email A daily report of updates to all spaces that you have permission to notification view. s An immediate report of all blog posts added or changed, in all spaces Notes for that you have permission to view. administrat An immediate report of all updates made by the people you are ors following, in all spaces that you have permission to view. Related pages: An immediate report when someone follows you. A daily or weekly report of recommended updates, in all spaces that Watch you have permission to view. Pages, Spaces To edit your email notification settings: and Blogs 1. Choose your profile picture at top right of the screen, then choose S Subscribin ettings g to RSS 2. Click Email in the left-hand panel Feeds 3. Click Edit within Confluenc e Your Confluenc e Edit Your User Settings Below is an explanation of all the email settings is explained below. Setting Description Content Frequency Option: Do you want Pages and blog posts that you create, edit or (Not Autowatch Confluence to comment on. applicable) automatically add you as a watcher on each page or blog post that you add or update? If you are a watcher of a page or a post, you will receive notification of future changes. Receive email reports Pages and blog posts that are added, edited or Daily Subscribe to showing changes to deleted. daily updates content in all spaces Comments on a page or blog post that are that you have added, edited or deleted. permission to view. Updates by users who have changed their personal profile. Note: Daily email reports do not include information about attachments on a page or blog post that are added, edited or deleted. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 380 Receive email Blog posts added, edited or deleted. Immediately Subscribe to notifications for all blog posts changes to blogs in your Confluence installation that you have permission to view. Receive email Pages being added, edited or deleted. Immediately Subscribe to notifications for Blog posts being added, edited or deleted. network changes to content by Comments being added, edited or deleted. all users that you are fol Status updates by the user. lowing, which you have permission to view. Receive an email Immediately Subscribe to message when anyone new follower notifications chooses to follow you. Option: Do you want to All pages and spaces that you are watching. (Not Notify on my receive email This affects all subscriptions set. applicable) actions notifications for your own changes? Note: If you have not subscribed to any email notifications and are not watching any pages/spaces, then selecting 'Notify on my actions' will not do anything. Option: Do you want Edits to pages and blog posts. (Not Show your notifications to applicable) changed content include details of the changes made to the content? If you do not select this option, your notifications will include only the title of the page, and any comment the author made when updating the page. If you do select this option, your notifications will show the differences between the current and previous versions of the page. See Page History and Page Comparison Views. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 381 Receive an email Confluence chooses the content to display, based Daily Subscribe to message showing the on: (weekdays recommended updates top content that is at 1pm) or relevant to you from Pages and blog posts that people have recently weekly spaces that you have liked. permission to view. Pages and blog posts that people have recently commented on. How do you set the Pages and blog posts that have recently been frequency of the mail created. message? A link in the email message allows 'Recent' means any activity that occurred since the you to choose daily or last recommended updates message was sent to weekly notifications. you. How do you enable and The activities are listed in order of popularity, with disable the notification? the most popular at the top. Likes, comments and You can turn off the content creations are scored equally. Activity that notification by clicking a involves people in your network ranks higher than link in the email activity not involving your network. Content in your f message. You can also avourite spaces also ranks higher than content in turn the notification on other spaces. The recommended updates summary or off by setting the does not include any content that you created 'Subscribe to yourself, and it gives a lower ranking to content that recommended updates' you have participated in, for example by adding a option in your user comment or updating the page. profile. If there is no activity to report, Confluence will not send the email message. Notes for administrators To enable Confluence to send email notifications, a System Administrator must configure an email server. See Configuring a Server for Outgoing Mail. Confluence Administrators can set the default options for the recommended updates notification. Choose the cog icon , then choose General Configuration under Confluence Administration. Click Recommended Updates Email in the left-hand panel. See Configuring the Recommended Updates Email Notification. Subscribing to RSS Feeds within Confluence An RSS feed is a format for delivering summaries of regularly changing web content. Subscribing to an RSS feed allows you to stay informed of the latest content from sites that you are interested in. RSS is not designed to be read in a regular web browser. Specialised RSS newsreader programs can check RSS files every so often, and tell you what's new on a site. Your reader may be on a website, an add-on to your browser, part of your email program, or a stand-alone program. Confluence generates its own RSS feeds for tracking updates to content within Confluence. You will need an RSS reader which can grab the RSS feeds from Confluence and display them for you. Confluence's RSS macro allows you to display the contents of an RSS feed on a Confluence page. The feeds may come from a Confluence feed generator or from external sites. In this way, Confluence can act as an RSS reader. For a technical description of RSS, read Mark Pilgrim's "What is RSS?" article on XML.com. Confluence RSS feeds RSS feeds allow you to track updates to content within Confluence. You will need an RSS newsreader to read a feed. You can create a customised RSS feed using the RSS Feed Builder or subscribe to one of the pre-specified feeds generated by Confluence. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 382 What would you like to do? Create and subscribe to customised RSS feeds using the RSS Feed Builder – Create a customised RSS feed. For example, you can filter your feed using a label, specify the number of items and days to include in your feed, and so on. Subscribe to pre-specified RSS feeds – Generate an RSS feed automatically in a minimal number of steps. Subscribe to a feed of any Confluence user's network – Track the activities of users the selected person is following. On this page: Confluence RSS feeds RSS newsreaders Removing an RSS feed Related pages: Watch Pages, Spaces and Blogs RSS Feed Macro RSS newsreaders The following are some popular RSS readers for various operating systems. You can find a more comprehensive list on Google's open directory. Windows SharpReader NewsGator Syndirella FeedDemon NewzCrawler Mac OS X Safari NetNewsWire NewsFire Shrook Multi-platform NewsMonster (Runs in the Mozilla web browser) Radio Userland (Windows and MacOS) AmphetaDesk (Windows, Unix, Mac OS X) Removing an RSS feed There is no need to try to delete or remove an RSS feed built by the Confluence RSS feed builder. Explanation: The feeds generated by the RSS Feed Builder are dynamically generated via the parameters included in the feed URL (address). For example, take a look at the following feed URL: http://confluence.atlassian.com/createrssfeed.action?types=page&sort=modified&showC ontent=true... The above feed URL will generate a list of pages ('types=page'), sorted by the modification date and showing the page content. The feed is generated at the time when the URL is fetched and there is no RSS feed information stored on the database. For that reason, there is no need to remove anything. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 383 Using pre-specified RSS feeds This page tells you how to get hold of an RSS feed which Confluence has Related pages: predefined for you. Using the To subscribe to predefined RSS feeds for a particular space: RSS Feed Builder 1. Go to the space and choose Space tools > Content Tools from the RSS Feed bottom of the sidebar Macro 2. Choose RSS Feeds Network 3. Copy and paste the link for one of the feeds into your RSS Overview newsreader If your space uses the Documentation theme: 1. Choose Browse > Space Operations 2. Choose RSS Feeds in the space operations options 3. Copy and paste the link for one of the feeds into your RSS newsreader Feeds include: Pages Comments Blog Attachments Mail All content To subscribe to predefined RSS feeds for a particular page (where available): Note that the word 'page' here means a part of the Confluence user interface, rather than a page that contains Confluence content. For example, your Network view offers an RSS feed. 1. Go to the page. 2. Locate the following icon, which is available in the top-right corner of certain pages: 3. Copy and paste the icon's link into your RSS newsreader. Notes The predefined RSS feed will return no more than 10 entries within the last 5 days, if you want to customise your Confluence RSS feed (for example, use a label to filter your feed), use the RSS Feed builder instead of the above instructions. Using the RSS Feed Builder Using the RSS feed builder, you can create customised RSS feeds to subscribe to changes within Confluence. Wondering what an RSS feed is? See more information about RSS Feeds. On this page: Building an Building an RSS feed RSS feed Notes Follow the steps below to build your feed, choosing the type of content and the time period you want to monitor. Related pages: To create a customised RSS feed: Watch Pages, 1. Choose the help icon at top right of the screen, then choose F Spaces eed Builder and Blogs 2. Select the content types you want in your feed Subscribin g to RSS Check Mail if you want to know when the email archive is updated. Feeds (See the overview of mail archives in Confluence.) within 3. Select one or more spaces from the list Confluenc 4. Click Advanced Options to set the following: e Option Description Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 4. Confluence 5.8 Documentation 384 Feed Name The default name is based on the name of your Confluence installation. For example, 'Extranet RSS Feed'. With these labels Enter one or more labels separated by spaces or commas. Confluence returns all content (of the selected types) that matches one or more of the labels. See the hint below about using labels to customise your feeds. Exclude these spaces Exclude specific spaces from those already selected. Sorted by Sort content by either the date or creation or the date they were last updated. Limit to Specify the number of items returned in your feed. Within the last Specify how old items returned can be. Include content for pages Specify whether the entire page is displayed in the feed. 5. Choose Create RSS Feed 6. Drag or copy the link into your RSS reader Hints Separate feeds. Try building separate feeds, one for pages only and one that includes comments as well. This allows you to monitor only pages if you are short of time, and to read the comments when you have more time. Labels to customise your feed. You can use the RSS feed builder to track updates to labelled pages and comments on those pages. Here is an idea for customising your RSS feed by using your own personal label(s). This is useful if you want to track updates to specific pages or blog posts, and you do not want to deal with emails. You can use this method as an alternative to watching pages. Build an RSS feed that returns pages, blog posts and comments labelled with a personal label, such as 'my:feed'. Each time you want to 'watch' a page, just label it with 'my:feed'. All updates and comments will automatically come through your RSS feed. Notes Removing an RSS feed: There is no need to try to delete or remove an RSS feed built by the Confluence RSS feed builder. Explanation: The feeds generated by the RSS Feed Builder are dynamically generated via the parameters included in the feed URL (address). For example, take a look at the following feed URL: http://confluence.atlassian.com/createrssfeed.action?types=page&sort=modifi ed&showContent=true... Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 385 The above feed URL will generate a list of pages ('types=page'), sorted by the modification date and showing the page content. The feed is generated at the time when the URL is fetched and there is no RSS feed information stored on the database. For that reason, there is no need to remove anything. Feed authentication options: Confluence can offer you the option of an anonymous feed or a feed that requires authentication. An anonymous feed will show only the content that is visible to anonymous users. The feed URL does not contain the &os_authType parameter mentioned below. This feed is useful only if your Confluence site allows anonymous access. If a feed is anonymous, you only get anonymously-viewable content in the feed regardless of whether you are a Confluence user or not. An authenticated feed requires you to log in to Confluence before you can retrieve the content. The feed URL contains the following parameter: &os_authType=basic. The option to choose between an anonymous and an authenticated feed is currently not available on the feed builder screen. The feed builder offers only authenticated feeds. See CO NF-21601 for details and a workaround. Subscribing to a Network RSS Feed You can create an RSS Feed from any user's network view, allowing you to receive summaries on the activities of users they are following in their network. The types of activities tracked in these RSS feed summaries include: Additions or edits to pages or blog posts Comments added to a page or blog post or edits to existing comments Updates to a user's status updates Updates to a user's profile Subscribing to a user's network feed To subscribe to a user's network RSS feed: 1. Locate the RSS icon , which is available from the top-right of: The 'Recent activity of the users you are following' section of your network page, or The 'Activity of followed users' section of another user's network page. 2. Copy and paste the icon's link into your RSS newsreader. On this page: Subscribing to a user's network feed Customising your network RSS feed Notes Related pages: Network Overview Subscribing to RSS Feeds within Confluence Your Confluence Customising your network RSS feed Confluence does not provide a way of customising a network RSS feed via the user interface. However, you can modify the maximum number of results and type of content displayed in these feeds by directly editing the RSS feed link in your RSS newsreader. To modify the maximum number of results displayed in your RSS feed: 1. Edit the RSS feed link in your RSS newsreader. 2. Change the value of the max parameter from its default value of 40 to a value of your choice. Example: http://confluence.atlassian.com/feeds/network.action?username=MYNAME&max=60&publicFeed=false& os_authType=basic&rssType=atom 3. Save the modified link in your RSS newsreader. To modify the type of content displayed in your RSS feed: 1. Edit the RSS feed link in your RSS newsreader. 2. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 386 2. Append the parameter contentType to the end of the link, followed by an equals sign (=) and then add the appropriate content type value of your choice: USER_STATUS — restricts the RSS feed to user status updates. PAGE — restricts the RSS feed to page additions or updates. BLOG — restricts the RSS feed to blog post additions or updates. ATTACHMENT — restricts the RSS feed to attachment additions or updates. COMMENT — restricts the RSS feed to comment additions or updates. Content type values are case-sensitive. Ensure that each parameter is separated from the other by an ampersand (&). Example: http://confluence.atlassian.com/feeds/network.action?username=ggaskell&max=40&publicFeed=false&o s_authType=basic&rssType=atom&contentType=USER_STATUS 3. Save the modified link in your RSS newsreader. Notes It is not possible to filter for more than one type of content by adding multiple values to the contentType param eter. Workbox Notifications The Confluence 'workbox' is a handy notification-and-task dialog, which displays all On this page: notifications collected from Confluence page Manage your notifications watches, shares, mentions, and tasks. If your Which notifications are included? Confluence site is linked to a JIRA issue tracker, Keyboard shortcuts you'll also see JIRA notifications in your workbox. To Manage notifications with Confluence mobile access your workbox, choose the icon in the Notes Confluence header. Related pages: From your workbox you can reply to comments, like a comment or page, watch a page, or open the Configuring Workbox Notifications relevant page or blog post; with JIRA integration you Email Notifications can watch or unwatch issues, comment on issues, or Watch Pages, Spaces and Blogs follow the link to open the issue in JIRA. Likes and Popular Content Looking to manage your notification email messages instead? See Email Notifications. Manage your notifications 1. Choose the workbox icon in the Confluence page header. A number may appear on the workbox icon, indicating the number of unread notifications waiting for your attention. You can use the keyboard shortcut: Type g then n. (When in the Confluence editor, click outside the editor pane before pressing the keyboard shortcut keys.) 2. Choose a notification from the list, to see the notification details. You can then: Open the related page, blog post, or comment. Like or Unlike the page, blog post, or comment. Watch or Stop Watching to receive notifications, or stop receiving notifications, about a page or blog post. Reply a comment, without leaving the workbox. Screenshot: Your Confluence notifications in the workbox Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 387 Which notifications are included? The workbox displays a notification when someone does one of the following in Confluence: Shares a page or blog post with you. Mentions you in a page, blog post, comment or task. Comments on a page or blog post that you are watching. Likes a page or blog post that you are watching. The workbox does not show notifications triggered because you are watching a space. Only watches on pages and blog posts are relevant here. The notification in your workbox appears as 'read' if you have already viewed the page or blog post. If your Confluence site is linked to JIRA, you will also see the following JIRA notifications in your workbox: Comments on issues that you are watching. Mentions. Shares of issues, filters and searches. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 388 Keyboard shortcuts Shortcut Action g then n Open the Confluence workbox. j Move down to the next entry in the notification list. k Move up to the previous entry in the notification list. n Move down to the next notification for a particular page or blog post. p Move up to the previous notification for a particular page or blog post. Enter Open the selected notification. u Return to the notification list after opening a particular notification. Manage notifications with Confluence mobile You can also view and respond to notifications on your phone or other mobile device. See Using Confluence on a Mobile Device for more about mobile platforms. Notes Read notifications are automatically deleted after 2 weeks. Unread notifications are automaticallydeleted after 4 weeks. You cannot delete your notifications yourself. If a new notification arrives while you have workbox open, the count appears on the workbox icon but the notification is not added to the workbox. You need to close workbox and re-open it to see the new notification. The ability to receive notifications from JIRA or another Confluence site is available in Confluence 4.3.3 and later. To receive JIRA notifications, you need JIRA 5.2 or later . Administrators can enable and disable the workbox on your Confluence site. They can also connect a JIRA site or another Confluence site, so that notifications from those sites appear in your workbox too. See Configuring Workbox Notifications. The Confluence workbox is provided by a set of plugins. To remove the personal notifications and tasks functionality from your site, you can disable the following plugins. See Disabling or Enabling a Plugin for instructions. Disabling these plugins will disable the entire workbox . It is not possible to disable only tasks or only notifications: Workbox - Common Plugin Workbox - Host Plugin Workbox - Confluence Provider Plugin If you want to re-enable the plugins, do so in the following order: Common Plugin, Host Plugin, Confluence Provider Plugin. There is no option to disable the workbox for an individual user. Your Confluence Confluence is very flexible; not only in the many ways you can create and share content, but also in how you can tailor your own Confluence experience. Things like your profile picture, favourite spaces and pages, and your personal space can say a lot about you, and can also make navigating Confluence much quicker and easier. Even a simple thing like adding shortcut links to the sidebar of your personal space, can save you a lot of time in finding the things you use all the time. Set up your personal space, and take a look at any of the pages below, to start making Confluence feel like home. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 389 Your User Profile Related pages: Change Your Password Watch Edit Your User Settings Pages, Set Your Profile Picture Spaces Choose Your Home Page and Blogs Favourite Spaces and Pages Create a View and Revoke OAuth Access Tokens Personal Space Favourite Spaces and Pages Your User Profile Your user profile contains basic information about you, which other On this page: Confluence users can see. It's also displayed to other users when they click your name in the People Directory, if you haven't set up your personal space Find your . user profile Edit your In your own profile, you can access account management features and user profile update information about yourself, like your name, email address, and pass Notes word. You can also view other users' profiles. Related pages: Find your user profile Set Your Profile To find your user profile: Picture Create a Choose your profile picture at top right of the screen, then choose Profile, or Personal choose the Profile link in the sidebar of your personal space. Space To find someone else's user profile: Hover your mouse pointer over a user's linked name or profile picture and choose the user's linked name to open their user profile. Alternatively, you can choose the Profile link in the sidebar of their personal space, or go directly to this URL: http://MY.CONFLUENCE.COM/users/viewuserprofile.action?username=USERNAME Screenshot: User profile screen for the current user Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 390 From your user profile, you can access the following: Profile View and edit your personal details, such as your name and email address details and optionally, your photograph and other personal information. Note that as a security precaution, in order to change your email address, you will be required to re-enter your password. Upload a profile picture (optional). Change your password. Network View the recent activity of users that you are following via the Network view. Follow other users from this view. Status View your history of status updates. Updates Favourites View a list of your favourite spaces. Watches View a list of the pages and spaces you are currently watching. Drafts Retrieve any pages you were in the process of editing. See Working with Drafts. Settings Edit your General Settings (homepage, language and timezone). Subscribe to email notifications. View and revoke your OAuth access tokens. Edit your user profile 1. Choose your profile picture at top right of the screen, then choose Profile Or, choose the Profile link in the sidebar of your personal space. 2. Choose Edit Profile 3. Enter details about yourself in the form displayed 4. Choose Save Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 391 Fields in your user profile: Detail Description Full Name Your name as you'd like it to appear in your profile. Email Your email address that will be used to send you mail notifications. Phone Your phone number. IM Your Instant Messenger (IM) details. To suit a variety of IM applications, this option accepts any string value. For example, you can enter IM details in the form of an email address, or a user ID, like '123456789'. Website Your website's URL. About me Information about yourself that other users can view (such as your professional information, hobbies, and other interests). You can use Confluence wiki markup in this field. Position Your title or position within your organisation. Department The name of your department or team. Location Your location. This can be your town, city, region or country. Handy Hint Confluence administrators can configure Confluence to mask email addresses (e.g. 'example at atlassian dot com'), protecting your email address from search engine spiders and the like. Notes The 'Administer User' link is visible to Confluence administrators only. The administrator can click this link to go directly to the user management screen in the Administration Console. Change Your Password There are two scenarios where you may want to change your Confluence password: Related Topics: You're logged in, but you want or need to change your password Your User You've forgotten your password and can't log in, so you need to reset Profile your password Set Your Profile Change your password when you're logged in: Picture 1. Choose your profile picture at top right of the screen, then choose Pr Create a ofile Personal 2. On your Profile tab, click Password in the left-hand column Space 3. Enter your current password and your new password in the form displayed 4. Click Submit Reset your password from the login page: If you've forgotten your password and need to reset it, you can do so from the Confluence login page. Choose the 'Forgot your password?' link and Confluence will step you through the process to reset your password. Edit Your User Settings If you want to make Confluence fit you, like a well-worn pair of sneakers, you can set some preferences that will make you feel more at home: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 392 General preferences such as home page, language and time zone On this page: Editor settings Email settings for subscriptions to email reports. General OAuth access tokens that you have granted from your Confluence User user account. Preference s More about General User Preferences Language Editor To edit your general user settings: Preference 1. Choose your profile picture at top right of the screen, then choose S s ettings Related pages: 2. Choose Edit and update the settings 3. Choose Submit Your User Profile Set Your Profile Picture Create a Personal Space Using Autocompl ete Setting Description Site Homepage Select the page that you would like to see whenever you log into Confluence. Language Select your language. See below. Time zone Select your time zone. Use Keyboard Shortcuts Enable keyboard shortcuts, other than for the editor. Text select Turn off the popup options panel when highlighting text. Screenshot: Editing your user profile settings Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 393 More about Language Setting your language preference in your user profile is described in the section above. This section gives more information about that setting and other settings that affect the language Confluence will use. Individual users can choose the language that Confluence will use to display screen text and messages. Note that the list of supported languages depends on the language packs installed on your Confluence site. The language used for your session will depend on the settings below, in the following order of priority from Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 394 highest to lowest: The language preference defined in your user profile. Note that you need to be logged in for this setting to take effect. The language that you choose by clicking an option at the bottom of the Confluence login screen. Confluence stores this value in a cookie. When the cookie expires, the setting will expire too. The language set in your browser. The browser sends a header with a prioritised list of languages. Confluence will use the first supported language in that list. Your Confluence administrator can disable this option by setting a system property. The default language for your site, as defined by your Confluence site administrator. Editor Preferences You can set some options that determine the way the Confluence editor works. Note that these settings affect only you. Other people using Confluence can enable or disable the settings on their user profiles independently. To change your editor preferences: 1. Choose your profile picture at top right of the screen, then choose Settings 2. Click Editor under 'Your Settings' in the left-hand panel 3. Click Edit and make your changes 4. Click Submit Setting Description Disable Select to disable autocompletion when you press one of the trigger characters. Autocomplete Disable Select to disable autoformatting when you type wiki markup in the editor. Click ? on Autoformatting the editor toolbar to learn more. Screenshot: User settings for the editor Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 395 Set Your Profile Picture Your profile picture is used as the icon for your personal space, to represent you in the People Directory, and to illustrate your comments. It also appears Related pages: in various other places next to your name, such as in the list of recent Your User updates on the dashboard. Profile When you upload your profile picture, you can resize and reposition it to Create a make sure it looks great. Personal Space Upload and adjust your profile picture: Your Confluenc 1. Choose your profile picture at top right of the screen, then choose Pr e ofile 2. Choose Picture on the left 3. Choose Upload image > Upload an image 4. Locate and select the picture on your computer or file server 5. Adjust the size and position of your photo, then choose Save Screenshot: Choosing a profile picture Screenshot: Resize your profile picture Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 396 Choose Your Home Page When you log in to Confluence, the default is to take you to the dashboard. Related pages: If you want to personalise your Confluence experience, you can choose another space's home page as the first page you see when you log in – this Your will be your new home page. Confluenc e To set your home page: Your User Profile 1. Choose your profile picture at top right of the screen, then choose S ettings 2. Choose Edit 3. Choose a page from the Site Homepage drop down Only spaces for which you have 'view' access display. 4. Choose Submit You'll be directed to your new home page the next time you next log in, and you can click the site logo to reach your personal home page. You can still access the site dashboard by entering the dashboard URL. It'll look something like this: http s://yoursite.com/wiki/dashboard.action. Screenshot: Profile Settings Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 397 Favourite Spaces and Pages Marking a pages or spaces as a favourites means you'll be able to access On this page: them quickly from the dashboard, spaces directory, or from your profile. It's a great way to get to the content you access every day. Add favourite pages and Add favourite pages and spaces spaces View your To add a page as a favourite: favourites 1. Go to the page Related pages: 2. Choose > Favourite The menu item will change to Remove Favourite, so that you can Your remove the page form your favourites if you want to later. Confluenc e To add a space as a favourite: Likes and Popular 1. Choose Spaces > Space directory in the Confluence header Content 2. Choose the star icon next to the space name in the list of spaces Spaces Searching the People Directory The star icon will change to dark grey to indicate that you've added the space as a favourite. You can choose the star again to remove the space as a favourite. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 398 To add someone's personal space as a favourite: If a user has set up a personal space, you can mark it as a favourite in the same way you mark other spaces as favourites. When you're in the Space Directory, choose Personal Spaces to view all the personal spaces in your Confluence site. View your favourites To view your favourite spaces and pages, try any of the following: Scroll to the bottom-left of the dashboard – you'll see tabs for your favourite spaces and pages, as well as your network. Go to Spaces > Space Directory in the Confluence header, then choose Favourite Spaces on the left – this one's for favourite spaces only. Choose your profile picture at top-right of the screen, then choose Favourites – there's a list of your favourite spaces and pages. Recently updated content in your favourite spaces is also listed in the Favourite Spaces tab of the recent activity feed on the dashboard. Screenshot: Viewing your favourites in your profile View and Revoke OAuth Access Tokens OAuth access tokens allow you to use a Confluence gadget on an external On this page: web application or website (also known as the 'consumer') and grant this gadget access to Confluence data which is restricted or privy to your View your Confluence user account. OAuth Access OAuth access tokens will only appear in your user profile if the following Tokens conditions have been met: Revoke your 1. Your Confluence Administrator has established an OAuth relationship OAuth between your Confluence site and the consumer. Access Confluence Administrators should refer to Configuring OAuth for Tokens more information about establishing these OAuth relationships. 2. You have accessed a Confluence gadget on the consumer and have Related pages: conducted the following tasks: a. Logged in to your Confluence user account via the gadget and Configurin then, g OAuth b. Clicked the 'Approve Access' button to allow the gadget for access to data that is privy to your Confluence user account. Confluenc Confluence will then send the consumer an OAuth 'access e Admins token', which is specific to this gadget. You can view the Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 2. b. Confluence 5.8 Documentation 399 details of this access token from your Confluence site's user account. An OAuth access token acts as a type of 'key'. As long as the consumer is in possession of this access token, the Confluence gadget on the consumer will be able to access Confluence data that is both publicly available and privy to your Confluence user account. As a Confluence user, you can revoke this access token at any time. Furthermore, all access tokens expire after seven days. Once the access token is revoked or has expired, the Confluence gadget will only have access to publicly available Confluence data. View your OAuth Access Tokens To view all of your Confluence user account's OAuth access tokens: 1. Choose your profile picture at top right of the screen, then choose Settings 2. Click View OAuth Access Tokens. A view similar to screenshot below is displayed. Refer to OAuth Access Token Details below for information on interpreting this table. If no access tokens have been set, then 'None specified' is shown. Screenshot: Viewing your OAuth Access Tokens OAuth Access Token Details Your list of OAuth access tokens is presented in a tabular format, with each access token presented in separate rows and each property of these tokens presented in a separate columns: Column Description Name Consumer The name of the Confluence gadget that was added on the consumer. Consumer A description of this consumer application. This information would have been obtained from Description the consumer's own OAuth settings when an OAuth relationship was established between Confluence and that consumer. If the consumer is another Atlassian application, this information is obtained from the Con sumer Info tab's 'Description' field of the OAuth Administration settings. The application's administrator can customise this Consumer Info detail. Issued On The date on which the OAuth access token was issued to the consumer by Confluence. This would have occurred immediately after you approved this gadget access to your Confluence data (privy to your Confluence user account). Expires On The date when the OAuth access token expires. This is seven days after the 'Issued On' date. When this date is reached, the access token will be automatically removed from this list. Actions The functionality for revoking the access token. Revoke your OAuth Access Tokens Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 400 To revoke one of your OAuth access tokens: 1. View your Confluence user account's OAuth access tokens (described above). 2. Locate the Confluence gadget whose OAuth access token you wish to revoke and click Revoke OAuth Access Token next to it. The gadget's access token is revoked and the Confluence gadget on the consumer will only have access to publicly available Confluence data. Search Confluence gives you a few ways to find the content you're looking for. Here's a basic overview of Confluence search, and a few tips to help you On this page: find things more easily. Confluenc e quick search Confluence quick search Perform a full search To perform a quick search in Confluence, choose the search field at the Filter your top-right of every page, or type GG on your keyboard to place your cursor in search the search field. Type the name of a page, blog post, person, results file/attachment, or space and select from the list of options displayed. Search for Hover your pointer over the options in the list to see the space they're in. If labels you don't see what you need in the quick search, press Enter or choose the Search the Search for option at the bottom of the search results to perform a full search content of . attachment s You can also search for administrative options in the quick search. For Search example, type 'general' into the search field to go to the General options for Configuration screen. the Document Screenshot: quick navigation showing titles matching the query 'st' ation theme Advanced search syntax Search Confluenc e from your browser's search field Useful plugins Related pages: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 401 Confluenc e Search Syntax Confluenc e Search Fields Recently Viewed Pages and Blog Posts Search Results Macro Livesearch Macro Page Tree Macro (incl udes an optional search box) Viewing Labels and Labelled Content Searching the People Directory More information about quick navigation: Matching items are grouped by type so that you can quickly find the type you want. Confluence shows a maximum of 3 administrative items, 6 pages and/or blog posts, 2 attachments, 3 people and 2 spaces. Items are ordered with the most recently updated first. The part of the title that's matched by the search query is bolded. Confluence permissions determine the administrative options that appear in the search results. You will only see the options you have permission to perform. Perform a full search When you perform a full search, Confluence will search all content in all spaces (site and personal), mail, personal profiles, attachments and the space description. To use the full search: 1. Type your query into the search field at the top-right corner of every screen (or at the top of the Search screen) 2. Press the Enter key The search screen appears, as shown below. If any Confluence pages or items match your search query, the search screen shows a list of the matching items. Choose an item's title to open it. Screenshot: Search results page Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 402 In the search results you'll see the following information for each item: An icon representing the content type (user profile, space, page, blog post, comment, or attachment). The title or name of the content item, linked to the item. The most relevant few lines of content from within the item. Any words that match your search query are highlighted within the content. The space to which the item belongs, displayed on the last line of the item's text block. The date when the content item was last modified. You'll see only search results which you have permission to view. On the left of the page are options which allow you to tailor or filter your search results. We recommend you don't use special characters in page or attachment names, as the page or attachment may not be found by Confluence search, and may cause some Confluence functions to behave unexpectedly. Filter your search results Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 403 On the left of the search results page are options which allow you to filter the search results. Define your filter criteria: By – Restrict your search to content last modified by a particular person. Start typing the person's username or part of their name and Confluence will offer you a list of possible matches. You need to enter at least two letters. For example, if you enter just 'john s', the filter will look for users called 'john' and will ignore the 's'. Space – Restrict your search to a particular space, your favourite spaces, or choose from a list of suggested spaces. You can also include archived spaces. Last modified – Restrict your search to content updated within a particular period of time. Type – Restrict your search to a particular content type. Search for labels Use the 'labelText:' prefix to search specifically for content that has a specific label. The table below gives examples of search terms that you can enter into Confluence's search box, and the search results that you can expect. Searching for ... Returns content that ... recipe labelText:chocolate contains the word 'recipe' or has the label 'chocolat e' recipe AND labelText:chocolate contains the word 'recipe' and has the label 'chocol ate' labelText:cake OR labelText:chocola has the label 'cake' or the label 'chocolate' te labelText:cake AND labelText:chocol has both labels 'cake' and 'chocolate' ate Search the content of attachments When you search Confluence, by default the search will include the content of the following types of attachments: Word Excel Text PDF PowerPoint HTML To search the content of other attachment types, you will need to use an attachment content extractor plugin. For more information, take a look at the following: Existing extractor plugins which you can install on your Confluence site. See this search on Atlassian Marketplace. Guidelines on developing your own attachment content extractor plugin. See our developer documentation on extractor plugins. Search options for the Documentation theme When using the Documentation theme, the Confluence search offers a few options as described below. Using the search box at the top right of the page: By default, the main Confluence search is configured to search the entire Confluence site. You will see the words 'Search Confluence' in the search box at top right of the page. The Confluence search will look for matches in the entire Confluence site. This is the default behaviour for other themes too. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 404 A space administrator can configure the Documentation theme to restrict the search to the current space. You will see the words 'Search this space' in the search box at top right of the page. The search will return results from the current space only. You can override the search restriction. Enter 'all:' and your search term to search the entire site. For example, enter the following into the search box at top right of the page to search the entire site for 'technical writing': all: technical writing Using the search box in the left-hand panel: By default, the Documentation theme's left-hand panel includes a search box. Enter your search term there, to restrict the search to the current space. Specifically, this will search only the pages that are children of the space's home page. If your administrator has restricted the main search to the current space, there will not be a search box in the left-hand panel. For screenshots and a full description, see Using the Documentation Theme. Advanced search syntax See Confluence Search Syntax for more ways to refine the text you enter in the search field. Additionally, see Confluence Search Fields for special parameters you can use in the search field to search on various metadata. Search Confluence from your browser's search field If you are using Firefox or Internet Explorer, you can add your Confluence site as a search provider, using the dropdown menu next to the browser's search field. The example to the right shows the 'Extranet' Confluence site offered for inclusion as a search engine in the browser's search field. Information about OpenSearch: Confluence supports the autodiscovery part of the OpenSe arch standard, by supplying an OpenSearch description document. This is an XML file that describes the web interface provided by Confluence's search function. Any client applications that support OpenSearch will be able to add Confluence to their list of search engines. Your Confluence Administrator can enable or disable the Open Search feature using the Confluence Administration Console. Useful plugins Before installing an add-on (also called a plugin) into your Confluence site, please check the add-on's information page to see whether it is supported by Atlassian, by another vendor, or not at all. See our guidelines on add-on support.This plugin extends the Confluence search, so that you can search for macro parameter names and values: the Confluence Macro Indexer plugin. Confluence Search Syntax This page describes the special words and punctuation marks you can use to refine your search. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 405 On this page: Matched Matched phrase search phrase search Use double quotes to search for content that contains the phrase 'cheese OR search one', or a phrase where 'cheese' and 'one' are the major words: AND search "cheese one" NOT search Excluded term Note: Confluence will ignore common words (stop words), including 'and', search 'the', 'or', and more, even if they are included within double quotes. See the Group default list of stop words used by Confluence's search engine, Lucene, in search the Lucene documentation. terms For example: Title search 1. Searching for "cheese one" returns only pages in which 'one' appears Date range as the first word after 'cheese'. search 2. Searching for "the one" returns all pages containing 'one' because Wildcard 'the' is a stop word. searches If you'd like to override Lucene's tokenisation and stemming, cast your vote Proximity on this improvement request: searches CONF-14910 - Provide ability to override Lucene tokenisation and stemming and search Range for exact text OPEN search Fuzzy search Combined search Searching for macros Searching for labels Related pages: Search Confluenc e Search Fields Searching the People Directory OR search To search for content that contains one of the terms, 'chalk' or 'cheese', use the operator OR in capital letters : chalk OR cheese AND search To search for content that contains both the terms 'chalk' and 'cheese', use the operator AND in capital letters: chalk AND cheese Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 406 NOT search To search for content that contains 'chalk' but NOT 'cheese', use the operator NOT in capital letters: chalk NOT cheese Excluded term search To search for content that contains 'chalk' and 'butter' but not 'cheese': chalk butter -cheese Group search terms To search for content that must contain 'chalk' but can contain either 'cheese' or 'butter', use brackets to group the search terms: (cheese OR butter) AND chalk Title search To search for content with 'chalk' in its title, where 'title' is the field keyword. title:chalk Date range search To search for content created or modified within a certain date range, using the created or modified keywords . The date stamps are in numeric 'yyyymmdd' format: created:[20000101 TO 20131231] modified:[20000101 TO 20131231] Wildcard searches You can use one or more wildcard characters in your search and place them anywhere in the search string, e xcept at the very beginning. So, you could search for http*.atlassian.*, but you can't search for *.a tlassian.* or ?ttps://confluence.atlassian.*, as they begin with a wildcard. Wildcards can either replace a single character in your search, or multiple characters. Single character To replace a single character in your search, use a question mark (?) as a wildcard, For example, to search for 'butter', 'bitter', 'better', or 'batter'. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 407 b?tter Multiple characters To replace multiple characters in your search, use an asterisk (*) as a wildcard. For example, to search for 'chicken' or 'chickpea': chick* Multiple wildcards Use multiple wildcards in your search. The following query will search find 'chick', 'coconut', or 'chickpea': c*c* You can also combine wildcard characters in one search. For example, the search term below will return 'chick' but not 'chickpea': c*c? Note: Confluence doesn't support leading wildcards. This means searching for *heese will not return cheese. Proximity searches Use a tilde character followed by a number, to find two words within a certain number of words of each other. For example, the following search will return 'Octagon blog post', but not 'Octagon team blog post': "octagon post"~1 The following search isn't valid, because you can't search for two words within zero words of each other. If you think the words are next to each other, use the matched phrase search. "octagon post"~0 Range search Use the operator 'TO', in capital letters, to search for names that fall alphabetically within a specified range: [adam TO ben] Note: You can't use the AND keyword inside this statement. Fuzzy search Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 408 Use a tilde (~) character to find words spelled similarly. If you want to search for octagon, but you're not sure how it's been spelt, type the word followed by a tilde: octogan~ Combined search You can also combine various search terms together: o?tag* AND past~ AND ("blog" AND "post") Searching for macros You can search Confluence content to find where a macro is used. Start your search string with macroName : and type the macro name after the colon. For example, to search for all excerpt-include macros: macroName:excerpt-include* For more information about macroName and other search fields, see Confluence Search Fields. Searching for labels Use the 'labelText:' prefix to search specifically for content that has a specific label. The table below gives examples of search terms that you can enter into Confluence's search box, and the search results that you can expect. Searching for ... Returns content that ... recipe labelText:chocolate contains the word 'recipe' or has the label 'chocolat e' recipe AND labelText:chocolate contains the word 'recipe' and has the label 'chocol ate' labelText:cake OR labelText:chocola has the label 'cake' or the label 'chocolate' te labelText:cake AND labelText:chocol has both labels 'cake' and 'chocolate' ate The 'labelText:' prefix is an example of a search field. See more about Confluence Search Fields. Confluence Search Fields This page gives an overview of the Apache Lucene search fields used in Confluence. Searching for content in specific fields Confluence data is stored in fields which can be specified in the search. To search a specific field, type the name of the field followed by a colon ':' and then the term you are looking for. Preliminary examples: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 409 title:"Some Title" labelText:chalk The field specification applies only to the term directly preceding the colon. For example, the query below will look for "Some" in the title field and will search for "Heading" in the default fields. title:Some Heading On this page: Searching for content in specific fields Confluence search fields Personal Information Pages Blog Attachments Mail items More examples Searching for labels Useful plugins Related pages: Search Confluence Search Syntax Searching the People Directory Confluence search fields Below are the fields which can be searched, listed by content type. Personal Information Name Indexed Stored Tokenised Notes handle true true false type true true false urlPath true true false fullName true true true title true true false labelText true true true modified true true false created true true false contentBody true true true Pages Name Indexed Stored Tokenised Notes Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 410 handle true true false type true true false urlPath true true false title true true true spacekey true true false labelText true true true modified true true false created true true false contentBody true true true macroName true true false The name of a macro used on the page Blog Name Indexed Stored Tokenised Notes handle true true false type true true false urlPath true true false title true true true spacekey true true false labelText true true true modified true true false created true true false contentBody true true true macroName true true false The name of a macro used in the blog Attachments Name Indexed Stored Tokenised Notes handle true true false type true true false urlPath true true false filename true true true title true true false comment true true true spacekey true true false modified true true false created true true false Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 411 contentBody true true true Mail items Name Indexed Stored Tokenised Notes handle true true false type true true false urlPath true true false title true true true spacekey true true false messageid true true false inreplyto true true false recipients true true true labelText true true true modified true true false created true true false contentBody true true true More examples Searching for labels Use the 'labelText:' prefix to search specifically for content that has a specific label. The table below gives examples of search terms that you can enter into Confluence's search box, and the search results that you can expect. Searching for ... Returns content that ... recipe labelText:chocolate contains the word 'recipe' or has the label 'chocolate' recipe AND labelText:chocolate contains the word 'recipe' and has the label 'chocolat e' labelText:cake OR labelText:chocolate has the label 'cake' or the label 'chocolate' labelText:cake AND labelText:chocolat has both labels 'cake' and 'chocolate' e Useful plugins Before installing an add-on (also called a plugin) into your Confluence site, please check the add-on's information page to see whether it is supported by Atlassian, by another vendor, or not at all. See our guidelines on add-on support. This plugin extends the Confluence search, so that you can search for macro parameter names and values: the Confluence Macro Indexer plugin. Searching the People Directory The people directory displays a list of people who are authorised to log in to your Confluence site. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 412 The people directory includes anybody who has On this page: logged into Confluence or who has had a user Viewing the people directory account created for them in Confluence. Searching for people The people directory does not include users who can Following people's activities log into Confluence using external user management Notes if they have never yet logged in. Related pages: Create a Personal Space Viewing the people directory Editing your User Profile Set Your Profile Picture Choose People at the top of the screen. Searching for people To search for a particular person, type their first name and/or last name into the search box and choose Sear ch. To see everyone who uses your Confluence site, choose All People. To see just those people who have set up a personal space, choose People with Personal Spaces. Following people's activities Confluence's network features allow you to 'follow' (that is, keep track of) other people's activities in your Confluence site. For more information, please refer to Network Overview. You can use the hover profile feature in the people directory to start following other people. To start following someone, move your mouse over their name or profile picture and choose Follow in their profile popup. To stop following someone, move your mouse over their name or profile picture and choose Stop Following in their profile popup. Once you start following another person, their activities will start appearing in your network view. Screenshot: The people directory Notes The people directory uses the hCard microformat for simple integration with a variety of microformat-enabled tools. hCard is an open data format for representing people, companies, organisations, and places. Read more about microformats and hCard. By default, deactivated users (disabled user accounts) are excluded from the people directory. You can include them by adding the showDeactivatedUsers parameter to the URL. For example: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 413 http://my.confluence.com/dopeopledirectorysearch.action?showDeac tivatedUsers=true By default, externally deleted users (for example, users deleted from an LDAP repository) are excluded from the people directory. You can include them by adding the showExternallyDeletedU sers parameter to the URL. For example: http://my.confluence.com/dopeopledirectorysearch.action?showExte rnallyDeletedUsers=true The Confluence administrator can hide the people directory. If it is hidden, you will not see the People Directory option. Recently Viewed Pages and Blog Posts The Recently Viewed list in Confluence keeps track of pages and blog Related pages: posts you've recently visited, and allows you to easily navigate back to them. Create and To view your recently viewed content: Edit Pages Your 1. Choose your profile picture at top right of the screen, then choose Confluenc Recently Viewed e 2. Choose the title of the page you want to revisit To filter the list, type part of a page title or user's name in the Filter field. Your last ten recently viewed pages also appear when you click in Confluence's Search field before you start typing a search query. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 414 Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 415 Permissions and Restrictions As a tool for communication and collaboration, we believe Confluence is at its best when everyone can On this page: participate fully. Confluence keeps a history of all Levels of permission changes to pages and other content, so it's easy to Global permissions see who has changed what, and reverse any Space permissions changes if you need to. Page restrictions How do permissions and Confluence does, however, give you the choice to restrictions interact? make your site, spaces, and pages as open or closed as you want to. Related pages: Confluence Groups Levels of permission Global Permissions Overview Space Permissions Overview There are three levels of permissions in Confluence: Page Restrictions Global permissions, space permissions, and page Configuring Confluence Security restrictions. Confluence Security Overview and Advisories Global permissions Global permissions are site-wide permissions, and can be assigned by either a System or Confluence administrator. These permissions are pretty broad, and don't really interact with space permissions or page restrictions. For full details, check out the overview of global permissions in the Administrator's Guide. Space permissions Every space has its own independent set of permissions, managed by the space admin(s), which determine the access settings for different users and groups. They can be used to grant or revoke permission to view, add, edit, and delete content within that space, and can be applied to groups, users, and even to anonymous users (users who aren't logged in) if need be. One thing to watch out for is where a user is a member of multiple groups. You may have revoked permission for that individual user to add pages, for example, but if they're a member of a groups that is allowed to add pages, they'll still be able to create new pages in the space. If you can't get the result you want from space permissions, or you're not sure, check with one of your Confluence administrators to determine what permissions you should apply to individuals and groups. Page restrictions Page restrictions work a little differently to global and space permissions. Pages are open to viewing or editing by default, but you can restrict either viewing or editing to certain users or groups if you need to. Don't forget, every page in Confluence lives within a space, and space permissions allow the space admin to revoke permission to view content for the whole space. Even the ability to apply restrictions to pages is controlled by the 'restrict pages' space permission. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 416 How do permissions and restrictions interact? You can restrict viewing of a page or blog post to certain users or groups, so that even if someone has the 'view' permission for the space, they won't be able to view the content of the page or blog post. If someone's a space admin and you've used page restrictions to prevent them viewing a page, they won't be able to see the page when they navigate to it. As a space admin though, they can see a list of restricted pages in the space and remove the restrictions. What about links? Space permissions and page restrictions affect how links between Confluence pages are displayed. If someone doesn't have 'View' space permission, links to pages in that space won't be shown at all. If someone has the "View" space permission, but the page has view restrictions, the link will be visible but they'll get an "access denied" message when they click the link. Links to attachments are also affected. If the visitor doesn't have permission to view the page the attachment lives on, the link won't be rendered. Confluence Groups For Confluence administrators, grouping users in Confluence is a great way to cut down the work required when managing permissions and restrictions. On this page: Groups are also very useful, however, to anyone who's a space admin, or Default can apply page restrictions. Confluenc If you're a space admin, you can assign a set of space permissions to a e groups group rather than to each individual user. And as a page creator with Anonymou 'Add/Delete Restrictions' permission, you can also add and remove page s Users restrictions for groups. Related Pages: Space Default Confluence groups Permission s Overview There are some default groups in every Confluence instance but, beyond Assign that, Confluence administrators are free to set up and edit groups in any way Space they see fit. Permission s Page Restriction s Confluenc e Groups for Administra tors The two special groups in Confluence are: confluence-administrators – Can perform most of the Confluence administrative functions, like assign permissions to other users, but they can't perform any functions that could compromise the security of the Confluence system. They can also access the Confluence Admin console. confluence-users - this is the default group into which all new users are assigned. Permissions defined for this group will be assigned to all new Confluence users. Anonymous Users All users who don't log in when they access Confluence are know as 'anonymous' users. By default, anonymous users don't have access to view or change any content in your Confluence instance, but Confluence admins can assign permissions to this group if it's required. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 417 Overlapping group and user permissions When a user is assigned more than one permission, the more powerful permission will prevail. Further explanation: A user may be assigned a permission specifically to their username. They may also be assigned a permission by belonging to a group, or even several groups. The user will then be able to perform all functions assigned to them. So if a user is allowed to do something over and above what the group can do, the user will be able to do it. And if the group is allowed to do something over and above the specific permissions granted to the user, the user will still be able to do it. Add-ons and Integrations Confluence has a wide range of features on its own, but you can also extend Related pages: those features with add-ons, and by integrating Confluence with other applications. Integrating with JIRA, JIRA Agile, and/or HipChat can really Use JIRA take your Confluence experience to the next level by improving the way your and teams communicate and collaborate, track vital work, and plan and release Confluenc new products. e together Use JIRA If there's an extra piece of functionality you need, the Atlassian Marketplace Agile and is the place to look for useful Confluence add-ons (or add-ons for other Confluenc Atlassian products). Whether you need to create diagrams, like the ones you e together can create with Gliffy, or you want to make awesome mockups and Using wireframes with Balsamiq, there are heaps of great add-ons in the HipChat marketplace. You may even find a really useful add-on you never knew you and needed, but now can't live without. Confluenc e together In this section: Using a Use JIRA and Confluence together WebDAV Use JIRA Agile and Confluence together Client to Using HipChat and Confluence together Work with Request Add-ons Pages Using a WebDAV Client to Work with Pages Working Working with Mail Archives with Working with Confluence Gadgets Confluenc e Gadgets Working with Mail Archives Request Add-ons Use JIRA and Confluence together Confluence and JIRA are like bacon and eggs; coffee and cake; Simon and Garfunkel. Separately, they're great, but together, they're amazing! If you use JIRA, and have your Confluence and JIRA instances connected using Application Links, you can display and create JIRA issues and more from within Confluence. Some of these features require a specific version of JIRA. Display JIRA issues in Confluence You can display JIRA issues on a Confluence page using the JIRA Issues macro. Display a single issue, a list of issues, or show the total number of issues. The simplest way to add a JIRA issue to Confluence is to paste a JIRA URL Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 418 on a Confluence page. For example: On this page: /browse/CONF-1234 will insert the JIRA Display Issues macro and display a single issue. JIRA /issues/?filter=56789 will insert the issues in JIRA Issues macro and display a list of issues matching the saved Confluenc filter. e /issues/?jql=project%20%3D%20CONF Create will insert the JIRA Issues macro and display a list of issues matching JIRA the JIRA search. Issues from Alternatively, you can add the JIRA Issues Macro to the page and use the Confluenc macro browser to search for issues directly: e Creating reports and charts Promp users to add JIRA Issues to a page View connection s between Confluenc e and JIRA Related pages: Use JIRA Agile and Confluenc e together Using Confluenc e as a Knowledge Base Use Confluenc e as your Intranet 1. In the editor choose Insert > JIRA Issue 2. Follow the prompts in the macro browser to choose a project and search for an issue – you can even use JIRA Query Language (JQL). Once you've added the macro, you can customise how the issue or list of issues appears on the page, including how much information to display, how many issues, and more. Create JIRA Issues from Confluence You can create issues while viewing Confluence a page, or from the within the editor. This is really useful if you use Confluence for requirements gathering. To create an issue when viewing a page: 1. Highlight some text on your page and choose the Create JIRA issue icon that appears above the highlight 2. Enter or select the following information: Server (if you have multiple instances of JIRA connected to Confluence) Project Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. 2. Confluence 5.8 Documentation 419 Issue Type Summary (your highlighted text will populate the issue summary by default) Description (optional) 3. Choose Create The issue will be created in JIRA and added to your page. If your text is in a table, you'll have the option to create multiple issues using text from the same column. If you don't see a popup when you highlight text, check that Text Select is enabled in your profile settings. To create an issue in the editor: 1. In the editor choose Insert > JIRA Issue > Create new issue 2. Enter or select the following information: Server (if you have multiple instances of JIRA connected to Confluence) Project Issue Type Summary (your highlighted text will populate the issue summary by default) Description (optional) 3. Choose Insert The issue will be created in JIRA and added to your page. There are some limitations when creating JIRA Issues from Confluence. The JIRA Issues macro or Create JIRA Issue dialog will notify you if it's unable to create an issue in the selected project. You can find out more in the JIRA Issues Macro page. Creating reports and charts Reporting on information stored in JIRA is simple in Confluence. In addition to the JIRA Issues Macro, you can use the JIRA Report blueprint or JIRA Chart macro. You can: Use the JIRA Report blueprint to create a Change Log or Status report. Use the JIRA Issues Macro to display a list of resolved issues, for example for use in release notes. Use the JIRA Chart Macro to display data as a pie chart. Promp users to add JIRA Issues to a page If you use templates (including templates provided by blueprints), you can add a JIRA Issue placeholder that, when clicked, opens the JIRA Issues macro and prompts users to search for or create a JIRA issue. For example, the JIRA Issues placeholder is used in the Product Requirements blueprint. See Creating a Template for more information on using instructional text and placeholders. View connections between Confluence and JIRA The JIRA Links button gives you quick access to issues connected to the Confluence page you're viewing. Links are displayed when: You've created or added single issues to the page using the JIRA Issues macro in Confluence. You have added a link from the issue to the Confluence page in JIRA. If you use JIRA Agile, sprints and epics will also appear on the JIRA Links button. The number on the JIRA Links button indicates the total number of issues connected to the page, regardless of whether you have permissions to view the issues. The dropdown will only show issues, epics and sprints that you have permission to view in JIRA. Note: The JIRA Links button only appears in the default theme; it's not available in the Documentation theme. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 420 The JIRA Links button doesn't detect links from issues displayed in the JIRA Issues macro in table format. Use JIRA Agile and Confluence together When you use JIRA Agile and Confluence together, you can unleash the On this page: potential in your development team. Here are some suggestions to help you get the most out of Confluence and JIRA Agile. The features described on Use this page require JIRA 6.1.3 and JIRA Agile 6.3.5 and later. Confluenc e and JIRA Agile to Use Confluence and JIRA Agile to define requirements define requireme Confluence is the perfect place to start defining your requirements. You can nts use the Product Requirements Blueprint to capture your requirements, Use and it'll let you create your JIRA epic and other issues right from the Confluenc requirements page in Confluence. e and JIRA Agile to manage your sprints Viewing links between Confluenc e and JIRA Here's how it works: 1. Create a Confluence page using the Product Requirements Blueprint 2. Choose the placeholder text 'Link to JIRA epic or feature' and choose Create new issue to create your epic in JIRA 3. Collaborate with your team to define your stories and save the page 4. Highlight text on your requirements page and choose the Create JIRA issue link to create stories in JIRA, and automatically link them to your epic 5. Track the progress of the stories from the Confluence page or from within JIRA The tight integration between Confluence and JIRA Agile means you can easily access JIRA issues from the Confluence page and see their status at a glance, and from within JIRA you can see links to related Confluence pages. All the information you need is right there. Use Confluence and JIRA Agile to manage your sprints There's often a lot of material in Confluence that provides useful context for your team during a sprint. These might be requirements documents, designs, tech specs, customer research and more. By linking these pages to epics, you make them easy for your team to find during the sprint. Here's how you can use Confluence to support your sprint from within JIRA Agile: Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 421 In JIRA Agile, create a Confluence page to plan your sprint. The page is created using the Meeting Notes Blueprint – and handy template that helps capture the details you need – and is automatically linked to the sprint. In an epic, link to useful Confluence pages, including requirements, designs, and more. Report on your progress to stakeholders using the JIRA Reports blueprint in Confluence. Use the Retrospective blueprint in Confluence at the end of your sprint to take stock of what went well and not so well For users who work primarily in JIRA Agile, the integration means that useful Confluence pages are only a click away. Viewing links between Confluence and JIRA Whenever you add a link to JIRA issues in Confluence, or link to a Confluence page from JIRA, the JIRA Links button appears at the top of the Confluence page. This makes it really easy to jump from Confluence to JIRA and vice versa, speeding up your workflow. The number on the JIRA Links button indicates the total number of issues, epics, and sprints connected to that page, regardless of whether you have permission to view them. The dropdown, however, will only show details of issues, epics, and sprints that you have JIRA permissions to view. Note: The JIRA Links button only appears in the default theme; it's not available in the Documentation theme. The button doesn't detect links from issues displayed in the JIRA Issues macro in table format. Using HipChat and Confluence together HipChat is group and video chat for teams. On this page: Connect Confluence to HipChat to send real time Connect Confluence and HipChat notifications to your team or project's HipChat room Send space notifications to HipChat Don't have HipChat yet? You can sign up for free a Invite users nd start using HipChat right away. Presence indicator Connect Confluence and HipChat First your organisation's HipChat account needs to be connected to Confluence. It only takes a minute. You'll need administrator permissions for your HipChat group to do this. If you're a Confluence admin go to > General Configuration > HipChat Integration and click Conne ct HipChat to get started. If you're a Space Admin you can go to Space Tools > Integration > HipChat to get started. Using the Documentation theme? If your space uses the Documentation theme go to Browse > Space Admin > HipChat. You'll need to be logged in to HipChat as a Group Admin to complete the integration. Send space notifications to HipChat Keep your team in the know by sending notifications about space activities, like new pages and blogs, to your team's HipChat room. Notifications appear in real-time, and one click takes you straight to Confluence. To set up space notifications go to Space Tools > Integration > HipChat and add a room to the list. Using the Documentation theme? If your space uses the Documentation theme go to Browse > Space Admin > HipChat. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 422 You'll need Space Admin permissions, and if you are connecting to private HipChat rooms, you will need to log in to HipChat on the integration screen. Invite users If you have administrator permissions you can invite users to join HipChat directly from the Integration screen. Follow the instructions in Connect Confluence and HipChat above, to access the integration screen. You must have at least one space integrated with a room to see the invite users link. Select the link to send an email inviting users to HipChat. Presence indicator When you hover over a user mention or a byline it will show if the user is available in HipChat. Green, yellow and red icons indicate when someone is available, away or doesn't want to be disturbed. Request Add-ons The Atlassian Marketplace website offers hundreds of add-ons that the administrator of your Atlassian application can install to enhance and extend Confluence. If the add-on request feature is enabled for your Confluence instance, you can submit requests for add-ons from the Marketplace to your Confluence administrator. The 'Atlassian Marketplace for Confluence' page provides an integrated view of the Atlassian Marketplace from within your Confluence instance. The page offers the same features as the Marketplace website, such as searching and category filtering, but tailors the browsing experience to Confluence. This in-product view of the Marketplace gives day-to-day users of the Atlassian applications, not just administrators, an easy way to discover the add-ons that can help them work. When you find an add-on of interest, you can submit a request with just a few clicks. Submit an add-on request Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 423 To browse for add-ons in the Atlassian Marketplace, follow these steps: 1. Choose your profile picture at top right of the screen, then choose Atlassian Marketplace. 2. In the Atlassian Marketplace page, use the search box to find add-ons or use the category menus to browse or filter by add-ons by type, popularity, price or other criteria. You can see what your fellow users have requested by choosing the Most Requested filter. 3. When you find an add-on that interests you, click Request to generate a request for your administrator. 4. Optionally, type a personal message to your administrators in the text box. This message is visible to administrators in the details view for the add-on. 5. When ready, click Submit Request. 6. Click Close to dismiss the 'Success!' message dialog box. At this point, a notification appears in the interface your administrators use to administer add-ons. Also your request message will appear in the add-on details view, visible from the administrator's 'Find New Add-ons' page. From there, your administrator can purchase the add-on, try it out or dismiss requests. Update an add-on request After submitting the request, you can update your message at any time. Click the Update Request button next to the listing in the Atlassian Marketplace page to modify the message to your administrator. The administrator is not notified of the update. However, your updated message will appear as you have modified it in the details view for the add-on immediately. Using a WebDAV Client to Work with Pages Create, move and delete pages and attachments in Confluence using a file manager like Finder (OS X), Explorer (Windows) or Dolphin (Linux) or other WebDav compatible local client like CyberDuck. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 424 For example, if you need to delete a lot of pages you can bulk delete them in your local file manager (like Finder or Explorer), rather than one by one in your browser. Access to Confluence through a native client is provided by the WebDav plugin. Your administrator may have disabled the WebDav plugin, or may have restricted the actions that you can perform using a local client. See Co nfiguring a WebDAV client for Confluence for more information on how to set it up. Managing pages and files in a native client Accessing Confluence through a native client is useful for performing bulk actions. Before you can start creating and moving things around, it's useful to understand how the content is organised. The hierarchy in the file system looks like this: Type of space (global or personal) Space (folder name is the spacekey) Homepage (and other top level pages) Child pages (folder name is the name of the page) Attachments (filename of the attachment) Essentially the file structure is the same as the page tree in your space. Here's how the Confluence demonstration space looks in Finder. Here's some things you might choose to do in a local client, rather than in your browser: Move pages to another space Select the page folders, and drag them into the other space's folder (drag them from Space A to Space B) Delete multiple pages Select all the page folders you want to delete and delete them. Delete multiple attachments from a page Navigate down to the page folder, select the attachments you want to delete and delete them. Upload multiple attachments Navigate to the page folder, and drag the files into the folder (note you can attach multiple files through the insert dialog as well). Working with Mail Archives Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 425 The information on this page does not apply to Confluence Cloud. Confluence allows you to collect and archive mail within each space. It's Related pages: useful for storing the email messages that relate to a particular project – you can put them in the same Confluence space as the content for that project. Spaces Confluenc You can download mail from one or more POP or IMAP accounts, or import e User's mail from an mbox file on your local system or on the Confluence server. Guide You need space administration permissions to manage the mail archives. Confluence mail archiving is an optional feature. This means that the 'Mail' options may be disabled and will therefore not appear in the Confluence user interface. Mail archiving features are contained in a bundled plugin. To activate mail archiving features in Confluence, enable the plugin – choose > General Configuration > Manage Add-ons. Then choose System in the drop down, and enable the Confluence Mail Archiving Plugin. To see archived mail: Go to a space and choose Space tools > Integrations > Mail Or, if your space uses the Documentation theme, choose Browse > Mail in the header. Choose a message to see its contents, or choose Next, Previous an d other options to navigate around the mail archives. Managing mail archives: Adding a Mail Account Delete and Restore Mail Import Mail from an mbox Screenshot: Viewing a message in the mail archive Notes Only site spaces – not personal spaces – can store mail archives. See Spaces for information on site and personal spaces. You can also search the mail messages and their attachments. See Search. Confluence mail archiving is an optional feature. This means that the 'Mail' options may be disabled and will therefore not appear in the Confluence user interface. Mail archiving features are contained in a bundled plugin. To activate mail archiving features in Confluence, enable the plugin – choose Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 426 > General Configuration > Manage Add-ons. Then choose System in the drop down, and enable the Confluence Mail Archiving Plugin. Adding a Mail Account The information on this page does not apply to Confluence Cloud. When you add a mail account, you're configuring Confluence to download mail from that account and archive it within the space. You need space administration permissions to add a mail account. See Spa ce Permissions Overview. Note: Confluence will remove email messages from an email account when it transfers them to the mail archive. You must therefore configure Confluence to poll a clone email account rather than the actual account. For example, to archive the actual account [email protected] to your Confluence Sales space, you must first create a clone account such as con [email protected] that contains the same email content. Add a mail account Step 1. Create a clone email account on the mail server 1. Add a new email account on the mail server with the clone email address. 2. Copy all existing email messages from the actual account to the clone account. 3. Set up the actual account to bcc sent email messages to the clone account. 4. Set up the actual account to forward received email messages to the clone account. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 427 On this page: Add a mail account Ste p 1. Cre ate a clon e ema il acc ount on the mail serv er Ste p 2. Con figur e Con flue nce to arch ive the clon e acc ount Fetching Mail Notes Related pages: Working with Mail Archives How do I check which spaces have email accounts? How do I disable automatic mail polling? Confluenc e User's Guide Step 2. Configure Confluence to archive the clone account 1. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 428 1. Go to the 'Mail Accounts' view: Go to the space and choose Spa ce tools > Integrations from the bottom of the sidebar. Choose Mail Accounts. If your space uses the Documentation theme: Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. Choose Integration > Mail Accounts. 2. Choose Add mail account 3. Enter configuration details for the account: Account Name: Enter a name for this account by which it will be known in Confluence. Description: Provide a description for this account (optional). Protocol: Choose from POP, IMAP, POPS or IMAPS. Hostname: Enter the host name of the mail server on which the account resides. Port: Don't edit this field. The mail server's port number will be displayed by default. Username: Enter a username that has permission to retrieve mail from this account. Password: Enter the account's password. 4. Choose Test Connection to verify the details 5. Choose Create to add the account to Confluence For each mail account you add, you can perform these actions in the Mail Accounts tab: Edit: Change the configuration settings for the mail account. Remove: Remove the account permanently. Disable/Enable: Temporarily disable the account, or enable a disabled account. Fetching Mail Confluence automatically fetches mail from the server once every 30 minutes. You can manually retrieve new mail from the configured mail accounts by selecting the Mail tab and choosing Fetch new mail. You need to be a space administrator to manually retrieve mail. See Space Permissions. Notes Only site spaces – not personal spaces – can store mail archives. See Spaces for information on site and personal spaces. Confluence mail archiving is an optional feature. This means that the 'Mail' options may be disabled and will therefore not appear in the Confluence user interface. Mail archiving features are contained in a bundled plugin. To activate mail archiving features in Confluence, enable the plugin – choose > General Configuration > Manage Add-ons. Then choose System in the drop down, and enable the Confluence Mail Archiving Plugin. Once mail is fetched it will be removed from the server. Delete and Restore Mail Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 429 The information on this page does not apply to Confluence Cloud. To delete mail from a space, you need 'Delete Mail' permission. On this page: Only a space administrator can delete all email messages in the space Delete mail simultaneously. from a space: Delete mail from a space: Restore mail that 1. Go to a space and choose Space tools > Integrations > Mail was Or, if your space uses the Documentation theme, choose Browse > deleted: Mail in the header. A list of email messages in the space is displayed in reverse Related pages: chronological order 2. Do either of the following: Working with Mail Delete an individual email message by choosing the trash Archives icon beside it. Confluenc Delete all email messages within the space by choosing Delet e User's e All. Guide Email messages deleted using the 'Delete All' option can't be restored. Space administrators can restore deleted email messages, provided they were deleted individually. Restore mail that was deleted: 1. Go to the space and choose Space tools > Content Tools from the bottom of the sidebar 2. Choose Trash You'll see a list of email messages and other content deleted from the space. 3. Choose Restore beside the email message you want to restore If your space uses the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Trash in the left-hand panel You will see a list of email messages and other content deleted from the space. 3. Choose Restore beside the email message you want to restore Import Mail from an mbox The information on this page does not apply to Confluence Cloud. Confluence allows you to import mail from mbox files located either on your Related pages: local system or in a specified location on the Confluence server. Confluence will store the imported email messages in the space's mail archive. Working with Mail You need to be a space administrator to import mail for a space. See Space Archives Permissions. Adding a Mail NB: You may need to enable the Confluence Mail Archiving Plugin as it is Account disabled by default. Confluenc To import mail from an mbox file: e User's Guide 1. Go to the space and choose Space tools > Integrations from the bottom of the sidebar. 2. Choose Mailbox Import. To import from a location on your file system: Browse to the location of the mbox file, select the file and then choose Import. To import from the Confluence server: Enter the location of the mbox file on the server, then choose Import. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 430 If your space uses the Documentation theme: 1. Choose Browse > Space Admin from the header Note: The Space Admin option appears only if you have space admin permissions, or if you're part of the 'confluence-administrators' group. 2. Choose Mailbox Import in the space administration options. To import from a location on your file system: Browse to the location of the mbox file, select the file and then choose Import. To import from the Confluence server: Enter the location of the mbox file on the server, then choose Import. Notes Only site spaces can store mail archives. Personal spaces cannot. See Spaces for an explanation of site spaces and personal spaces. Confluence mail archiving is an optional feature. This means that the 'Mail' options may be disabled and will therefore not appear in the Confluence user interface. Mail archiving features are contained in a bundled plugin. To activate mail archiving features in Confluence, enable the plugin – choose > General Configuration > Manage Add-ons. Then choose System in the drop down, and enable the Confluence Mail Archiving Plugin. For security reasons mail can only be imported from a specified location in the Confluence server's file system. We recommend administrators create a folder in their Confluence home directory, add the system property confluence.mbox.directory and specify the location for mailboxes to be imported from. Mail cannot be imported from the server until this system property is set. See Configuri ng System Properties. Working with Confluence Gadgets This section introduces the concept of gadgets in Confluence and provides an outline on how to use gadgets in Confluence and other web applications. Introduction to Gadgets in Confluence A gadget is a small object (i.e. a piece of functionality) offering dynamic content that can be placed into the page of: An Atlassian application's website, such as a Confluence page or blog post or a JIRA 4.0+ dashboard. A third-party application's website, such as iGoogle or Gmail. (But see the limitations on using Confluence gadgets in other applications.) Gadgets allow interactions between Confluence and other compatible websites. Confluence interacts with gadgets that support the OpenSocial specification. For more information about Atlassian gadgets, please refer to the introduction to Atlassian gadgets and the big list of Atlassian gadgets. Using Gadgets in Confluence You can place any gadget that complies with the OpenSocial specification from an external source, such as iGo ogle or other Atlassian applications such as JIRA 4.0+, onto a Confluence page or blog post. To add a gadget to a page, use the Confluence macro browser to add a Gadget macro. See the page on adding JIRA gadgets to a Confluence page. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 431 On this page: Introduction to Gadgets in Confluence Using Gadgets in Confluence Adding Confluence Gadgets in Other Applications Adding a Confluence Gadget to JIRA Adding a Confluence Gadget to Non-Atlassian Web Applications Confluence Gadgets Related pages: Gadget Macro Configuring Confluence Gadgets for Use in Other Applications Adding a Confluence Gadget to a JIRA Dashboard Confluence Gadgets All Atlassian gadgets External Gadgets Adding Confluence Gadgets in Other Applications You can add a Confluence gadget to a JIRA dashboard or another Confluence site. In principle, you can also put a Confluence gadget on any other OpenSocial-compliant website such as iGoogle or Gmail. See the limitations on using Confluence gadgets in other applications. Adding a Confluence Gadget to JIRA See Adding a Confluence Gadget to a JIRA Dashboard. Adding a Confluence Gadget to Non-Atlassian Web Applications For instructions on how to add Confluence gadgets in another compatible non-Atlassian web application or container, refer to Configuring Confluence Gadgets for Use in Other Applications. Confluence Gadgets The Confluence Gadgets topic explains the purpose of the 'Confluence Gadgets' window and provides information about the gadgets which are bundled with Confluence. Adding a Confluence Gadget to a JIRA Dashboard JIRA 4.0 is the first major Atlassian application that can incorporate OpenSocial-compliant gadgets, On this page: such as Confluence gadgets onto its dashboard. Creating an Application Link This page explains how to add a Confluence gadget between Confluence and JIRA to the dashboard of a JIRA 4.0+ installation. Finding a Confluence Gadget's URL To add a Confluence gadget to a JIRA dashboard, Adding a Confluence gadget to complete the steps below. JIRA's gadget directory Adding a Confluence gadget to the JIRA dashboard Creating an Application Link between Confluence and JIRA Related pages: If your Confluence gadgets need to access All Atlassian gadgets user-restricted Confluence data, then your Working with Confluence Gadgets Confluence administrator must first establish an Appl ication Link between your Confluence site and the JIRA site. If you only need to access anonymously accessible Confluence data, then you can skip the section about adding an Application Link, and go directly to Finding a Confluence Gadget's URL, below. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 432 Finding a Confluence Gadget's URL A gadget's URL points to the gadget's XML specification file. These URLs look something like this: http://example.com/my-gadget-location/my-gadget.xml To find a Confluence gadget's URL: 1. Choose the help icon at top right of the screen, then choose Available Gadgets. 2. Find the gadget you want. 3. Copy the Gadget URL link to your clipboard. Screenshot: Finding a gadget's URL Adding a Confluence gadget to JIRA's gadget directory To add a Confluence gadget to the gadget directory in JIRA: 1. Go to the dashboard by clicking Dashboard at the top left of the screen. 2. The dashboard will appear. Click Add Gadget. 3. The 'Add Gadget' screen appears, showing the list of gadgets in your directory. See screenshot 1 belo w. Click Add Gadget to Directory. Note: You will only see this button if you have system administrator permissions in JIRA. 4. The 'Add Gadget to Directory' screen appears. See screenshot 2 below. Paste the gadget URL (which you copied to your clipboard above) into the text box. 5. Click Add Gadget. 6. The gadget appears in your gadget directory. (It will be highlighted for a short time, so that you can see it easily.) Screenshot 1: Gadget directory with 'Add Gadget to Directory' button Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 433 Screenshot 2: Adding a gadget to the directory Adding a Confluence gadget to the JIRA dashboard Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 434 In the procedure below, 'your Atlassian dashboard' and 'your Atlassian application' refers to the JIRA dashboard and application, respectively.You can add a gadget from the directory of gadgets that are available to your Atlassian application. To add a gadget to your Atlassian dashboard, 1. Go to the dashboard by clicking the 'Dashboard' link or the 'Home' link at the top left of the screen. 2. The dashboard will appear, looking something like screenshot 1 below. Click 'Add Gadget'. 3. The 'Add Gadget' screen will display a list of available gadgets in your gadget directory, as shown in screenshot 2below. Find the gadget you want, using one or more of the following tools: Use the scroll bar on the right to move up and down the list of gadgets. Select a category in the left-hand panel to display only gadgets in that category. Start typing a key word for your gadget in the 'Search' textbox. The list of gadgets will change as you type, showing only gadgets that match your search term. 4. When you have found the gadget you want, click the 'Add it Now' button to add the gadget to your dashboard. Screenshot 1: An Atlassian dashboard Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 435 Screenshot 2: Adding a gadget from the gadget directory Note: You need administrator privileges to add a gadget to the list of available gadgets. If you have permission to add gadgets to and remove gadgets from the directory itself, you will see the 'Add Gadget to Directory' and 'Remove' buttons on the 'Add Gadget' screen, as shown in the screenshot about. Please refer to the Gadgets and Dashboards Administration Guide. In Atlassian OnDemand products, it is not possible for administrators to add gadgets to the directory. If you would like to add an Atlassian gadget to a directory, please contact Atlassian Support. Configuring Confluence Gadgets for Use in Other Applications This page tells you how to add a Confluence gadget to another (external) application. The instructions and examples given in this topic focus on adding and using Confluence Gadgets in other web applications. Atlassian support does not cover gadgets on external sites like iGoogle and Gmail In principle, you should be able to add Atlassian gadgets to iGoogle, Gmail and other external sites that support OpenSocial gadgets. However, these external integrations are experimental at this stage and we have encountered problems with them. Please do have fun playing around with them, but be aware that Atlassian does not support the use of Atlassian gadgets on iGoogle, Gmail or other external web sites. See the detailed section on gadget limitations. Gadgets that display information from Atlassian applications, such as Confluence, should be able to run on iGoo gle, Gmail and other web applications that provide OpenSocial containers. Below are specific instructions for iGoogle and Gmail. You can experiment by adding a Confluence gadget to other web sites and applications, such as a Ning community like The Content Wrangler. On this page: Overview of Adding a Confluence Gadget to Another Web Application Finding a Confluence Gadget's URL Adding an Atlassian Gadget to iGoogle Adding an Atlassian Gadget to Gmail Limitations and Support Related Topics Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 436 Overview of Adding a Confluence Gadget to Another Web Application The exact procedure for adding a Confluence gadget depends on the application where you want to add the gadget. The basic steps are the same: 1. Find the Confluence gadget's URL, i.e. the URL for the gadget's XML specification file. 2. Ensure one of the following two mandatory (typically one-off) procedures have been conducted: An OAuth relationship between Confluence (as the 'service provider') and the other web application (as the 'consumer') has been established. Refer to Configuring Authentication for an Application Link for more information about OAuth and instructions on establishing these relationships. A Trusted Applications relationship between Confluence and JIRA has been established. Refer to Configuring Trusted Applications in the JIRA documentation for more information about establishing these relationships. 3. Follow the procedure provided by the external web application where you want to add the Confluence gadget. Finding a Confluence Gadget's URL A gadget's URL points to the gadget's XML specification file. These URLs look something like this: http://example.com/my-gadget-location/my-gadget.xml To find a Confluence gadget's URL: 1. Choose the help icon at top right of the screen, then choose Available Gadgets. 2. Find the gadget you want. 3. Copy the Gadget URL link to your clipboard. Screenshot: Finding a gadget's URL Adding an Atlassian Gadget to iGoogle Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 437 You can customise your iGoogle home page by adding gadgets and moving them around on the page. To add an Atlassian gadget to your iGoogle page: 1. First find the gadget's URL as described above. 2. Go to iGoogle and log in if you have a username and password. 3. Click Add stuff near the top right of the iGoogle page. 4. The Google gadget directory will appear, showing a list of available gadgets. Click Add feed or gadget in the right-hand panel. 5. A text box will open, as shown above. Enter or paste the gadget's URL from your clipboard into the textbox and click Add. 6. Go back to your iGoogle home page. The gadget will appear on your iGoogle page. Adding an Atlassian Gadget to Gmail You can add gadgets to the left-hand panel of your Gmail page. To add an Atlassian gadget to your Gmail page: 1. First find the gadget's URL as described above. 2. Log in to Gmail. 3. Click Settings near the top right of the Gmail page. The Gmail settings page will appear. 4. Click the Labs tab. The Gmail Labs page will appear. This is a laboratory area or testing ground where Google allows you to use experimental features in Gmail. 5. Scroll down to find the feature called 'Add any gadget by URL'. 6. Select the Enable option, as shown here: 7. Click Save Changes. 8. A new Gadgets tab will appear on your 'Settings' page. Click the Gadgets tab. The 'Gadgets' page will appear, as shown in the screenshot below. 9. Enter or paste your gadget's URL into the Add a gadget by its URL box, then click Add. 10. The gadget will appear in the left-hand panel of your Gmail page, as shown in the screenshot below. Screenshot: Adding a gadget to Gmail Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 438 Limitations and Support Atlassian support does not cover gadgets on external sites like iGoogle and Gmail In principle, you should be able to add Atlassian gadgets to iGoogle, Gmail and other external sites that support OpenSocial gadgets. However, these external integrations are experimental at this stage and we have encountered problems with them. Please do have fun playing around with them, but be aware that Atlassian does not support the use of Atlassian gadgets on iGoogle, Gmail or other external web sites. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 439 Related Topics The big list of Atlassian gadgets Confluence Gadgets This page describes the purpose of the 'Confluence Gadgets' dialog and how to access it, and provides information about the gadgets that are bundled with Confluence. Gadgets: Interact with and provide access to data in your Confluence installation. Can be used externally such as on a JIRA dashboard, a page or blog post of another Confluence site, or any compatible page on a we site that accepts gadgets, such as iGoogle. (But see the limitations on using Confluence gadgets in other applications.) The gadgets dialog The 'Confluence Gadgets' dialog displays a list of all the Confluence gadgets available in your Confluence installation. The Confluence gadgets bundled with Confluence are described below. Any additional Confluence gadgets installed by your Confluence administrator (typically as Confluence plugins), will also appear in this list. To access the Confluence Gadgets dialog: Choose the help icon at top right of the screen, then choose Available Gadgets. You can use a Confluence gadget within the same Confluence site, by adding it to a page or blog post using the gadget macro. You can also add Confluence gadgets to external applications. See Adding a Confluence Gadget to a JIRA Dashboard and Configuring Confluence Gadgets for Use in Other Applications. On this page: The gadgets dialog Confluence gadgets Related pages: Adding a Confluence Gadget to a JIRA Dashboard Configuring Confluence Gadgets for Use in Other Applications Gadget Macro The big list of Atlassian gadgets Screenshot: The 'Confluence Gadgets' dialog Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 440 Confluence gadgets This following table lists the gadgets which are bundled with Confluence. Click the name of the gadget for more information. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 441 Name Description Confluence The Confluence page gadget allows you to show content from a page on your Confluence site Page in a gadget. You can optionally configure the gadget to display links to view and/or edit the Gadget page on your Confluence site. The page gadget can also be displayed in canvas view, so that it takes up all of the space provided by your dashboard. Activity The activity stream gadget is similar to the recently updated macro and shows a list of the most Stream recently changed content within your Confluence site. Gadget Confluence The Confluence news gadget is an example of a 'news feed' gadget that shows a list of recent News Confluence Product Blogs and events at Atlassian. Gadget Confluence The Confluence QuickNav gadget provides the Quick Navigation Aid functionality for searching Quicknav the Confluence site. For more information on how to use this feature, refer to the Quick Gadget Navigation Aid section of Search. Activity Stream Gadget The activity stream gadget is similar to the recently updated macro and shows a list of the most recently changed content within your Confluence site. For instructions on how to use Confluence gadgets in your applications, please see Confluence Gadgets. In addition to showing a list of most recently changed content, the activity stream gadget also groups activities by separate date, and provides an RSS feed link to its content in the top-right corner. Activity Stream Gadget Properties Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget. These properties are located in the preview panel in the macro browser. Property Required? Default Description Title Yes None Adds a title to the top of the Activity Stream. Global No None Allows you to add filters to the gadget including: filters space username update date JIRA issue key (if your Confluence instance is integrated with JIRA) Available Yes All If you have application links to other sites, JIRA or another streams Confluence instance, you can choose to include activity from those streams also. Display No 10 Specify the maximum number of results to be displayed. A options: maximum of 10 results will be displayed by default. The maximum limit value that this property can accept is 100. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 442 Display No Never/false Specify the time interval between each 'refresh' action undertaken options: by the activity stream gadget. A refresh makes the activity stream Refresh gadget reflect any new activity that has been conducted on the Interval Confluence site. Confluence News Gadget The Confluence news gadget is an example of a 'news feed' gadget that shows a list of recent Confluence Product Blogs and events at Atlassian. For instructions on how to use Confluence gadgets in your applications, please see Confluence Gadgets. Clicking an item in the Confluence news gadget takes you directly to the selected blog post of the Confluence Product Blogs feed or event details on the events at Atlassian page. Clicking More news takes you to the Confluence Product Blogs feed page and clicking More events takes you to the events at Atlassian page. Screenshot: The News Gadget Confluence: News Gadget Properties Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget. Property Required? Default Description Show News? No True Shows a short list of the most recent Confluence Product Blogs. Show Events? No True Shows a short list of the most recent events at Atlassian. Show Banners? No True Shows any banner advertisements (if available). Confluence Page Gadget The Confluence page gadget allows you to show content from a page on your Confluence site in a gadget. You can optionally configure the gadget to display links to view and/or edit the page on your Confluence site. The page gadget can also be displayed in canvas view, so that it takes up all of the space provided by your dashboard. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 443 For instructions on how to use Confluence gadgets in your applications, please see Confluence Gadgets . Macros that work with the page gadget Please note, not all macros work with the page gadget. Please refer to the Working Macros section below for more information. On this page: Confluence Page Gadget Properties Working Macros Related pages: Confluence Gadgets Screenshot: The Confluence page gadget displaying a sample page Confluence Page Gadget Properties Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget. Property Required? Default Description Space No None Specify the space that your desired page is located in. Suggestions will display in a dropdown when you start typing. (Note, this property is only used to make searching for pages easier. It is not required.) Page Yes None Specify the page that you want to display in your gadget. Suggestions will display in a dropdown when you start typing. Show No Yes Select whether to display a link to view the page on your Confluence View site. Clicking the link will open the page in Confluence. Link Show No No Select whether to display a link to edit the page on your Confluence Edit Link site. Clicking the link will open the page for editing in Confluence. Refresh No Never/false Specify the time interval between each 'refresh' action undertaken by Interval the page gadget. A refresh makes the activity stream gadget reflect any new activity that has been conducted on the Confluence site. Working Macros Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 444 The Confluence page gadget will only render a subset of the macros that are used in Confluence correctly. Refer to the table below for the list of macros that work and do not work with the page gadget and known limitations. Some of the issues with macros in the page gadget can be worked around, if you are comfortable developing in Confluence. Please see Troubleshooting Macros in the Page Gadget for more information. Key: Works with the page gadget * Partially works with the page gadget Does not work with the page gadget Macro Works Limitations with page gadget? Activity You cannot have another gadget embedded within the Confluence Page Gadget Stream Anchor (wit * Opens in a new page hin a page) Attachments N/A Blog Posts N/A Chart N/A Children N/A Display Content By N/A Label Content By N/A User Excerpt N/A Gallery N/A Include N/A Page Info N/A Labels List N/A Livesearch N/A Note N/A Metadata N/A Metadata N/A Summary Pagetree N/A Search Pagetree N/A Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 445 Panel N/A Quick Nav You cannot have another gadget embedded within the Confluence Page Gadget Recently N/A Updated RSS Feed N/A Section & C N/A olumn Spaces List N/A Table of * Works, however links will be opened in a new browser window when clicked. Contents Team See here for the Improvement Request: Calendars TEAMCAL-862 - Make Team Calendars display in a Confluence Page Gadget, for use on a JIRA Dashboard REOPENED View File (P * Works, but you may need to refresh the gadget the first time (see CONF-19932). DF or PPT) Widget * Only works for some content: Connector Works: blip.tv, Episodic, Flickr, Google Calendar, presentations on Google Docs, MySpace Video, Scribd, Skitch.com, SlideRocket, SlideShare, Viddler, Vimeo, YouTube, Dailymotion, Metacafe, FriendFeed, Yahoo Video, Wufoo HTML Form Builder Does not work: FriendFeed, Google Gadgets, Google Video (consumer service discontinued), Twitter, Widgetbox, DabbleDB, BackType Confluence Quicknav Gadget The Confluence QuickNav gadget provides the Quick Navigation Aid functionality for searching the Confluence site. For more information on how to use this feature, refer to the Quick Navigation Aid section of Search. For instructions on how to use Confluence gadgets in your applications, please see Confluence Gadgets. Screenshot: Using the QuickNav Gadget Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 446 Confluence QuickNav Gadget Properties This gadget has no properties and cannot be customised. Adding JIRA Gadgets to a Confluence Page The Confluence Gadget macro is a specific type of macro which is used to display gadgets, including JIRA gadgets, in a Confluence page. Once you have configured external gadgets in the Confluence Administration Console, they will appear in the Macro Browser. Before you can start adding JIRA Gadgets: Your JIRA administrator will need to configure JIRA to trust Confluence via Application Links. (Not required if your JIRA site allows anonymous access) Your Confluence administrator will need to add the JIRA gadget URL to the list of authorised external gadgets in Confluence. To add a JIRA Gadget to a Confluence page: Choose Insert > Other Macros. Navigate to the gadget you wish to add to the page and choose Insert. Refer to the Gadget Macro page for more information on adding the macro to your page. Advanced and Special Uses of Confluence This section describes the more advanced features of Confluence, and gives guidelines on some specific use cases for Confluence. Confluence markup formats The syntax and usage of Confluence wiki markup and the Confluence XHTML-based storage format – see Worki ng with Confluence Markup. Gadgets How to add gadgets to a wiki page, or use Confluence gadgets on other sites – see Working with Confluence Gadgets. Using Confluence for technical documentation A technical communicator's guide to using Confluence – see Develop Technical Documentation in Confluence. Setting up a knowledge base A support engineer's guide to using Confluence as a knowledge base – see Using Confluence as a Knowledge Base. Setting up an intranet A quick guide to setting up an intranet wiki – see Use Confluence as your Intranet. Related pages: Confluence Administrator's Guide Add-ons and Integrations Develop Technical Documentation in Confluence Confluence is a flexible platform with a range of features and add-ons that can help you capture, distribute, and update your technical documentation. Below are some tips to help you get your technical documentation site started, and to save you time and effort managing your documentation's life cycle. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 447 Create your Documentation Space On this page: Create Creating spaces in Confluence is quick and easy. All you need to do to get your your documentation started is choose Spaces > Create space from the Document Confluence header. To make things even easier, choose the ation 'Documentation Space' option in the create space dialog; it'll give you a Space custom home page with a search box (the livesearch macro) to search just Save time your documentation space, a recently updated macro, and a few other by re-using goodies. content Give your space a name, and Confluence will automatically create the home Use page page and space key for it (change the space key if you're not happy with the templates one Confluence chooses for you). Feel free to customise the home page at Draft your any time; what it looks like is completely up to you! work Use links Choose the Documentation theme (optional) and anchors The Documentation theme is specifically formatted for technical Useful documentation, and provides a left-hand navigation bar and space-specific macros search. If necessary, you can configure the Documentation theme to add Keep track your own page header and footer, or customise the default left-hand of page navigation bar. You should note though, that the Documentation theme has updates been deprecated and isn't compatible with some newer features like the Customise JIRA links button. PDF export Other useful tools and add-ons Related pages: Spaces Confluenc e Administra tor's Guide If you'd like to set the space's theme to 'Documentation', choose Space tools > Look and feel from the bottom of the sidebar, then choose Themes and select the Documentation theme. Save time by re-using content If there's something you're going to use multiple times in your documentation space – whether it's a word, sentence or paragraph; an image; a product version number; or anything else – you can create it once and include it on as many pages as you like (or use it in the header and/or footer). Inclusions not only save you typing the same thing many times, they also make it easier when things change – it's much better to update the info in one place, than 47! There are 3 macros that allow you to re-use content: The Excerpt macro to define a re-usable section, or 'excerpt', on a page – add content inside this macro, and you can reuse it on as many pages as you like. The Excerpt Include macro (excerpt-include) to include the contents of an excerpt on another page. The Include Page macro (include) to include the entire content of a page on another page. For example, let's say you create release notes for each major release of your product, and you want to include the intro from each release notes page on a 'what's new' page. Place each release notes intro in an E xcerpt macro, then add an Excerpt Include macro for each set of release notes to the what's new Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 448 page. Your intros will magically appear on the what's new page, and if you update the release notes it'll automatically update the what's new. Another example is one of the ways we use the Include Page macro. Whenever the ellipsis ( ) appears in our documentation – for example, go to > Copy – it's actually an Include Page macro. We have a page with just that image on it, so we can include it whenever we need an ellipsis. Why do we do use an Include Page macro for one tiny image? Well, just in case that UI element is ever changed. If we attach the image to every page, there might be 50 pages we need to update when things change; if we use an Include Page macro, we update once and it's changed everywhere. Doing it this way also allows us to know how many pages we're using the image on. By going to > Page Information, we can see how many incoming links there are to this page, and that tells us how many pages use the image. Create an inclusions library (optional) You can include content from any Confluence page, but you may want to create an 'inclusions library' to hold content that's specifically for re-use. The inclusions library isn't a specific feature of Confluence; the pages in the inclusions library are just like any other Confluence page. This is just a technique you can use if you want a place to store content that's specifically for re-use. To create your inclusions library: 1. Choose Create and create a new page in your space 2. Enter a suitable title. We use '_ConfluenceInclusions' (the underscore before the title helps to let people know this page is special) 3. Enter some content and save the page We enter text explaining the purpose of the inclusions library and how to re-use the content 4. Choose Space tools > Reorder pages (or Browse > Pages if you're using the Documentation theme) and drag your new page above the space homepage 5. Go to your new inclusions page and choose Create to add child pages containing your re-usable content Because you've moved the pages to the root of the space, they won't appear in the page tree in the sidebar. The pages will be picked up by other searches though, as they're normal Confluence pages. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 449 Use page templates Creating one or more page templates can be a real time-saver if you're creating a lot of pages with the same layout. If you're constantly adding the same macros, like panels and table of contents, save yourself from RSI and put them into a template – you can start with one, but make as many as you need to maximise your efficiency. To create a page template that's available in all spaces: 1. Go to > General Configuration 2. Select Global Templates and Blueprints from the list on the left 3. Choose the Add global page template button at the top-right 4. Create your template page and choose Save For detailed info on page templates, see Creating a Template. To get to Global Templates and Blueprints, or any other admin page quickly, hit / on your keyboard and start typing the name of the admin page you're looking for. Draft your work When you're creating a new page in your documentation, you'll likely want to do it over time, saving as you go, and have a select few people review it to provide feedback. A loose description of this workflow is 'draft, review, publish'. You don't want any half-finished pages being seen by your users, and most documentation needs to be reviewed before it's finalised, so here's a technique for drafting pages and allowing for review: 1. Create a page and restrict its permissions For example, you might restrict viewing to a group of people such as your team, or a few select individuals. On a public site, you might restrict viewing to staff members, so that the general public can't see the page. 2. Write your page content 3. Share the page with your reviewers and ask them for feedback (make sure you haven't restricted them Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 450 3. from seeing the page!) The reviewers can add comments to the bottom of the page or highlight text to add a comment inline. If you give them permission, they can also edit the page content directly. 4. Publish the page when ready, by doing the following: a. Delete any comments on the page b. Remove page restrictions so that your audience can see it You've now published your page. The space permissions and site permissions now determine who can see and/or update the page. Use links and anchors Add links In any documentation site, it's essential to be able to link from one page to another, and often to specific sections on a page. You can add any URL to a Confluence page and Confluence will automatically detect it and turn it into a link. If you paste the URL for another page in your Confluence site, Confluence will display the link text as the page name and turn it into a relative link, meaning if the name of the page changes, Confluence will adjust the link so it doesn't break. Add and link to anchors The anchor macro allows you to create anchors in your documentation, which can be linked to from anywhere. I've added an anchor at the top of this page so you can click to go back to the top. To add a macro and link to it from the same page: 1. Type {anchor in the editor, select the anchor macro and give your anchor a name (top in my example) 2. Select the text that'll link to the macro and hit Ctrl+K (Windows) or Cmd+K (Mac) (this opens the link dialog) 3. Choose Advanced from the options on the left and type # followed by your anchor name (#top in my example) Check out our documentation for links and anchors to get the full rundown on linking to anchors on other pages and other anchor goodness. Useful macros Confluence ships with a great range of macros, and there are a few that are particularly useful in technical documentation. Here's a few: Table of contents macro The Table of Contents macro helps people navigate lengthy pages by summarising the content structure and providing links to headings used on the page. The best part is, you don't need to do anything except add the macro; once you've added it, it'll automatically detect headings and add them to the table of contents. Tip, Note, Info, Warning, and Panel macros Often when creating documentation, there are elements of a page that you want to highlight or draw the the viewers' attention to. Confluence ships with the Tip, Info, Warning, Note and Panel macros, which will help you focus a viewer's attention on a particular part of your content. Tip of the day Use the tip macro to give your readers handy hints! Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 451 Keep track of page updates In Confluence, it's quite usual for a number of different people to update a single page. Technical writers need to know what happens to our documents, both during review and after publication. Watch pages or the space So that you know when changes are made, it's a good idea to watch pages or even the entire space. That way, when changes are made to pages you're watching, or someone comments on them, you'll get an email notification letting you know who changed what. Whenever you're on a page in your documentation space, choose the Watch button at the top-right of the page. From there, you can choose to watch just that page, or all pages in the space. View page history Confluence creates a new version of the page every time someone edits the page. The page history shows all the versions, with date, author, and any comments made on the update. To view page history, go to the page and choose > Page History On the page history view, you can: View the content of a specific version of the page. Revert to (restore) a specific version. Select any two versions and ask for a comparison, to see what has changed between those two versions. Take a look at Page History and Page Comparison Views for a detailed explanation. Show a list of contributors If you want to see at a glance who's updated a page or pages, you can add the contributors macro. This macro displays a customisable list of people who've contributed by creating, editing, or, optionally, commenting on the page. Customise PDF export If you're planning to provide a PDF version of your documentation – whether it be for email, download, print, or any other form of delivery – you can customise the look of the PDF by adding a title page, header, and footer. The process you take depends on whether you're trying to customise the PDF export for one space or for your whole site, so, if you're keen to make these changes, take a look at our page on Customising Exports to PDF for more detailed instructions. Other useful tools and add-ons Confluence is already a great tool for technical documentation, but you can still add to it depending on your documentation and workflow needs. Here are some useful add-ons available on the Atlassian Marketplace, most of which we use ourselves, which can extend the functionality of Confluence. Scroll Versions (supported) Scroll Versions, by K15t, allows you to tie versions of your documentation to versions of your product, so that Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 452 when a new version of your product ships you can publish that version of your documentation. Create as many versions of your documentation as you like, make the changes you need to, and keep them up your sleeve until release time. You can even publish different variations of your documentation – like if you have versions of your documentation for different operating systems – to different spaces or Confluence instances. Copy Space (unsupported) The Copy Space add-on does what its name suggests; it allows a space administrator to copy a space, including the pages within the space. Great for when you want a space template that you can copy to create other spaces. This plugin is also useful when you need to archive a copy of a current space at a particular point in time, like when you're moving from one version of your product to the next – copy the space, give it a new name, and keep it wherever you like, all without losing the existing space. At this point this plugin won't copy page history, blog posts and email. Scroll PDF Exporter (supported) If you're going to produce a PDF of your documentation space, wouldn't you like it to be professionally formatted? The Scroll PDF Exporter, by K15t, lets you style single pages or whole spaces for export, using handy PDF templates. Gliffy (supported) Create diagrams, wireframes, flowcharts and more with Gliffy. Gliffy features a highly intuitive drag-and-drop interface, and allows you to export your diagrams in multiple formats, including: JPEG, PNG and SVG. Add Gliffy flowcharts, UI wireframes, and network diagrams directly to your Confluence pages to communicate your ideas visually, making them easy to understand and faster to spread through your team. Lucidchart (supported) Lucidchart is available in versions for Cloud and Server, and allows you to create and insert diagrams within your Confluence Cloud environment. Quickly draw flowcharts, wireframes, UML diagrams, mind maps, and more inside our feature-rich editor. The server version also comes with a free Visio viewer, so you can view Microsoft Visio (.vsd) files, Visio stencils (.vss) and it also supports exporting back to Visio. Using Confluence as a Knowledge Base A knowledge base is a repository for how-to and troubleshooting information. Knowledge Bases are commonly used by IT Support teams, but can be useful for procedural and troubleshooting information in any organisation or team. What do people want out of a knowledge base? Using an IT Support team as an example: Customers want fast access to a solution, and relevant search results. Help desk staff want to be able to create new articles quickly. Help Desk team leads wants the space to be self curating, and do not want to spend a lot of time manually organising content. Everyone wants a way to be notified when articles they are interested in have been updated or important notices are added. Creating a knowledge base space You'll need the Create Space global permission to do this. To create your knowledge base space: 1. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 453 1. Create a space using the knowledge base space blueprint (Choose Spaces > Create space > Knowl edge base space). 2. Set permissions for the space, including anonymous access (Choose Space Tools > Permissions) 3. Create your first knowledge base article (Choose Create > How-to or Troubleshooting and follow the prompts) The knowledge base space blueprint includes everything you need to get started, including article templates, and a pre-configured homepage with Livesearch and Content By Label macros. Page labels are essential in knowledge base spaces. These are used to add topics to your articles, and allows your knowledge base to become self organising over time. Users will generally find articles by searching, and using the topic navigation on the homepage and end of each article, rather than navigating through a tree-like page hierarchy. When starting off your knowledge base space, it is a good idea to brainstorm a few topics to get started. Customising your knowledge base space You'll need Space Admin permissions to do this. To make it easy for your users to create knowledge base articles (such as your help desk or support team) we recommend customising the how-to and troubleshooting article templates to make them relevant for your organisation. The more guidance and structure you can put in your template, the faster it will be for your team to create great articles. To edit the article templates: 1. Go to Space Admin > Content Tools > Templates. 2. Edit the How-to or Troubleshooting article templates. 3. Add headings and instructional text (choose Template > Instructional Text). You can also add additional templates, such as a policy or procedure page templates. We also recommend customising the look and feel of your space. Simple changes like a space logo and welcome message can make a huge difference. To change the look and feel: Add a space logo and useful shortcuts to the sidebar (choose Space Tools > Configure Sidebar) Edit the homepage to add a custom welcome message. Edit the colour scheme (choose Space Tools > Look and Feel > Colour Scheme). Providing communication and notification options Channels of communication with your audience, internal or external, is essential in a good knowledge base. Here are some out of the box options: Blog - blog updates and important notices, and encourage people to watch for new blogs in your space. Watch - encourage people to watch pages that interest them, or watch the entire space. Comments - allow logged in users (or even anonymous users) to comment on knowledge base articles. This is a simple way to connect with your end users. RSS - create an RSS feed and add the link to your knowledge base homepage (choose Help > Feed Builder). Alternatively encourage users to create their own feed - useful if they want to keep up with particular topics (labels), rather than receive notifications for the whole space. Integrating your knowledge base with other Atlassian products If your Confluence site is connected to another Atlassian product (via an application link), you can make use of these great integration features: If you use JIRA - add a JIRA Issues macro to your troubleshooting article to provide quick access to known issues. This has the added advantage of automatically updating when an issue is resolved or its status changes. One simple way to do this would be to add some labels to JIRA to indicate the Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 454 issue should appear in the knowledge base (for example 'printer-kb'), and then add a JIRA Issues macro with a query like 'label = 'printer-kb and status <> resolved'' on all articles with the printer topic. If you use JIRA Service Desk - specify your Confluence space to be used as a knowledge base. Users can search your knowledge base directly from within the Service Desk customer portal. If you use Confluence Questions - add a Questions list macro to troubleshooting articles, to highlight the top questions with the same topic as the article, and an Ask a Question button to the knowledge base homepage. Extending your knowledge base with third party add-ons The Atlassian Marketplace has a large number of add-ons for Confluence. A common addition to Knowledge Base spaces is a survey or form tool, which enables you to get feedback on the usefulness or usability of your knowledge base articles. Search for 'knowledge base' on Marketplace and see if there is an add-on that's right for your knowledge base. Use Confluence as your Intranet Your intranet is the hub of your organisation. When choosing your intranet platform, you need to ensure that the system is simple enough for non-technical users, information and content can be shared easily, and access is restricted to those within your organisation. Confluence has a host of great out-of-the-box features that allow you to share and collaborate with your colleagues, while keeping your information secure. Share things like procedures, specifications and important files – or organise company events and functions – and get your teams working together. It's one place to share, find, and collaborate to get work done. Create your community It's quick and easy to add users to your Confluence site. Allow people to add themselves as users of the site; invite people to sign up by sending them an invitation link; add new users manually; or use an existing directory – like an LDAP directory – for authentication and to manage users and groups. Whichever way you choose, you can quickly build a community of Confluence users and give them access to your intranet; you'll also have a ready-made people directory. Match your company branding Upload your company logo, and Confluence's auto look and feel will change the colour scheme to match. It'll make your intranet feel more familiar to your colleagues, and help with adoption. A space for everything, and everything in its space A Confluence space is essentially a container for a group of pages and blog posts with related content. When you're starting out with Confluence, the easiest way to organise things is to create a space for each team or department within your organisation. Each team's space is then a place for them to create and share pages, blog posts, meeting notes, files, and much Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 455 more – and becomes the place to go for team members to get the information they need. Just choose Spaces > Create space from the header, and Confluence provides a list of space blueprints to help get you started. Each space can have its own colour scheme and has a customisable home page, which you can edit to suit your purpose – like displaying and tracking team goals and displaying a list of team members. Use the built-in 'Team Space' template to automatically add all members of the team to the homepage, to help everyone get to know each other. You can set permissions for each space, so if there's sensitive information that should only been seen by certain users or groups, it's easy to secure it with Confluence. Don't feel restricted to creating spaces for teams though; you can also create spaces for projects (large or small), events, and anything else where you want to collect information under a common heading or permissions structure. Once you have some spaces set up, create some pages and blog posts to give your colleagues an example of how Confluence can be used, then invite them to create their own pages and blogs. Add a personal space Every Confluence user, including you, can also create their own personal space; it can be a place to keep your own work, add shortcuts to your most used content, and you even get your own blog for sharing your ideas and opinions with the rest of your organisation (or just those that you want to see them). Create pages, meeting notes and more You can create pages for anything you want in Confluence - meeting notes, project plans, decisions, and more. Pages are editable so others can contribute and keep them up to date after you create them. Choose Create from the Confluence header and choose a blank page, or use a template to get you started. Type your page, change its layout, add images and links, and do it all without any specialist skills or training. You can also attach files – allowing everyone in a team access to assets that are critical to the project – like mockups and requirements. You and your colleagues can like the page, and comment on it to start a conversation about the content. Confluence also offers a series of useful built-in page blueprints, which help you with the content and formatting of the page. The meeting notes and decisions blueprints are two that can be really useful when others need to be in-the-know about what happened, and why it happened. Avoid the reply-all and blog about it Each space you create in Confluence has its own blog, where you and your teams can share news and events, discuss important projects and developments, or congratulate a teammate for a special effort; blogging is a great way to foster company culture and celebrate achievements across your organisation. You can watch any blog to make sure you get updated when there's a new post. Blog posts are automatically organised by date, and grouped by year and month, so they're also easy to find. Share stuff that matters If you need to be sure that the right people see a page or blog post, Confluence offers a range of ways to make sure you can get their attention. Type the @ symbol and the name of a Confluence user to mention the m in a page, blog post, or comment. They'll get an email notification that you've mentioned them, with a link to the page, post or comment. There's also aSharebutton at the top right of every page. Type the name or email address of a user or group and send them a short message with a link to the content you're sharing. Watch and learn Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License. Confluence 5.8 Documentation 456 Don't miss out on important updates. Watching spaces, pages, and blogs is a great way to stay up-to-date with what's happening in your own team, or any other team or person you need to keep up with. When you watch something, you'll get email updates when changes are made or a comment is added. The Confluence dashboard also has a recent activity feed, which allows you and your team to see what's trending throughout the company or in your network. Let team collaboration take on a life of its own If you want to communicate in-the-moment, HipChat – our private service for chat, video, and screen sharing – is built for teams. Share ideas and files in persistent group chat rooms, or chat 1-1 for that personal touch. HipChat integrates with Confluence, so you can get real-time notifications in HipChat whenever new information is shared in Confluence pages and blogs. Got a question (that's not rhetorical)? Why not ask your team? Confluence Questions is an add–on for Confluence that gives you knowledge sharing with your own Q&A service. Run company-wide polls to gauge reaction to a new marketing initiative, or let people vote on the venue for the Christmas party. Ask questions, get answers, and identify experts. You can also try Confluence Team Calendars for organising and sharing team events, leave, and other important appointments. Embed each team's calendar on their home page so that everyone knows what's happening, and when. Created in 2015 by Atlassian. Licensed under a Creative Commons Attribution 2.5 Australia License.