• Products
  • Documentation
  • Resources

Insert the 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 and preferably given a unique name. You can create more than one excerpt on a single source page. You can include more than one excerpt on any given page as well.

Using the Excerpt Include Macro

To add the Excerpt Include macro to a page:

  1. From the editor, select from the toolbar to bring up the insert menu.

  2. Find the Excerpt Include macro and select it. You can also type /excerptinclude right in the body of your page to select this macro from the insert menu. Upon selection, the Excerpt Include modal will appear.

  3. In the Source page field, type the name of the source page of your preferred excerpt.

  4. From the Excerpt name dropdown, select the name of the excerpt you’d like to include.
    If you encounter an untitled or duplicate named excerpt in the dropdown list, you may want to first give each excerpt a unique name on the source page before making a selection.

  5. You can opt to keep or remove the border panel from your excerpt. Select the Preview icon to see what the excerpt will look like on the page before including it.

  6. Select Save to display the excerpt on your page.

An image of the excerpt include modal with dropdown for selecting an excerpt from a source page
Image of excerpt preview in the excerpt include modal

To edit an existing Excerpt Include macro:

  1. From the editor, select the embedded excerpt you want to configure.

  2. Select the Edit icon to open the modal.

  3. Configure the source page, selected excerpt, border panel, and preview as needed.

  4. Select Save to save your changes.

Parameters

Parameters are options that you can set to control what and how content from the macro appears on the page. 

If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).

Parameter

Default

Description

Source page
(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 altogether.

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:

1 2 3 4 SPACEKEY:Page name

This parameter is unnamed in wikimarkup.

Remove border 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.

Wiki markup example

Wiki markup is only supported in the legacy editor.

Wiki markup is useful when you need 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.

1 2 3 4 {excerpt-include:My page name|nopanel=true}

Additional Help