Excerpt Include Macro

Add the Excerpt Include macro to display the contents of an Excerpt macro 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. You need to add the Excerpt macro to another page, before you can use the Excerpt Include macro.

On this page:

The example below shows an example of an Excerpt Include macro as it appears in the editor, and as it would appear to someone viewing the page. We have set the options to show both the title of the page and the panel surrounding the content.

  1. The Excerpt Include macro as it appears in the editor
  2. The Excerpt Include macro as it appears when viewing the page

The content is being pulled from a Excerpt macro on a page called 'reusable note'. 

Add this macro to your page

To add the Excerpt Include macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Excerpt Include from the Confluence content category.
  3. Enter the title of the page containing the Excerpt macro you want to include. 
  4. Choose Insert

You can then publish your page to see the macro in action. 

If the page contains more than one Excerpt macro, the Excerpt Include macro will display the contents of the first one on the page.  It can't display content from multiple Excerpt macros on the same page. 

Want to show more than just an excerpt? The Include Page Macro allows you to include the entire contents of another page.


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

Page Containing the Excerpt
(default-parameter

none

Type the name of the page that contains the excerpt to be displayed. You can use an excerpt from a page in the same space or another space 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 Panel
(nopanel)
 

false

Determines whether Confluence will display a panel around the excerpted content. The panel includes the title of the page containing the excerpt, and the border of the panel. By default, the panel and title are shown.

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-include

Macro body: None.

{excerpt-include:My page name|nopanel=true}
Last modified on Nov 10, 2020

Was this helpful?

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