Excerpt Macro

Add the Excerpt macro to a page to define a snippet of content to be re-used on another page.

This is great single sourcing important information. For example you could provide the contact details and dates from each project page on a summary page. When the info is updated in the excerpt, it will flow though to all the other places it is used.  

This is a two-step macro. Once you've added the Excerpt macro to one page, use the Excerpt IncludeChildren Display, or Blog Posts macro to display the contents of that excerpt on another page. 

On this page:

Screenshot: A project summary page containing a Children Display macro, configured to show the contents of the Excerpt macro on each child page. 

Add this macro to your page

To add the Excerpt macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Excerpt from the Confluence content category.
  3. Choose Insert

Enter your text into the macro body. You can then publish your page to see the macro in action. 

Screenshot: the Excerpt macro in the editor, containing a short project summary.


Using this macro

This macro must be used in conjunction with either the Excerpt IncludeChildren Display, or Blog Posts macros. 

You can only have one excerpt per page. If you add more than one excerpt macro to a page, only the first one will be used by these macros. 

You can choose to position the except on its own line, or inline with the surrounding text. This option affects only the page that contains the Excerpt macro, it doesn't affect how the content displays when it is reused on other pages.

Screenshot: The Excerpt macro placeholder and options panel

  1. New line 
  2. Inline

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

Parameter

Default

Description

Hide Excerpted Content
(hidden

false

Controls whether the page content contained in the Excerpt macro placeholder is displayed on the page.

Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused.

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).

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: excerpt

Macro body: Accepts rich text.

{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}
Last modified on Aug 22, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.