Note Macro

The Note macro displays a block of text in a yellow highlighted box. This is useful for emphasising important information.

Example:

My note

This is the content of my note.

Using the Note Macro

To add the Note 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.

Add the text of the note to 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

Optional Title
(title

none

If specified, the title is displayed in bold next to the icon.

Show Exclamation Mark Icon
(icon

true

    • true – displays the warning icon
    • false – the icon is not displayed

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: note

Macro body: Accepts rich text.

Storage format example

<ac:structured-macro ac:name="note">
  <ac:parameter ac:name="icon">false</ac:parameter>
  <ac:parameter ac:name="title">My title</ac:parameter>
  <ac:rich-text-body>
    <p>This is the content of my note.</p>
  </ac:rich-text-body>
</ac:structured-macro>

Wiki markup example

{note:icon=false|title=My title}
This is the content of my note.
{note}

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport