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.
Using the Excerpt Include Macro
To add the Excerpt Include macro to a page:
- In the Confluence editor, choose
> Other Macros - Find and select the required macro
Speeding up macro entry with autocomplete:
- In the new editor - Type / and the beginning of an element (tool or things in the insert menu) to see a list of suggestions.
- In the legacy editor - Type { and the beginning of the macro name to see a list of suggested macros.
Details are in Keyboard shortcuts, markdown, and 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 Excerpt | 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: This parameter is unnamed in wikimarkup. |
Remove Surrounding Panel | 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 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.
{excerpt-include:My page name|nopanel=true}