You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 84 Next »

The Excerpt Include macro is used to display 'excerpted' (that is, a segment of) content from one page in another.

(info) To use this macro, the excerpt must have been defined using the Excerpt macro and both pages must exist in the same space. 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).

The excerpt appears as shown below:

Excerpt Macro
A short summary of this page

For this example, we are taking content from a page called 'Excerpt Macro', where the excerpt tags have already been placed. The title of the page is shown at the top of the panel and the text between the remote excerpt tags is rendered as the body of the text.

On this page:

Usage with the Macro Browser

To insert the excerpt include macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the excerpt include macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get

{excerpt-include:Excerpt Macro}
Excerpt Macro
A short summary of this page

For this example, we are taking content from a page called 'Excerpt Macro', where the excerpt tags have already been placed.

Parameters

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

Parameter

Default

Description

nopanel
(nopanel)

false

Controls whether the square panel border around the excerpt should be removed. By default, the square panel is always shown.

Examples

Basic example

The following code renders an excerpt from this page with default settings:

{excerpt-include:Excerpt Macro}

The excerpt appears as shown below:

Excerpt Macro
A short summary of this page

Removing the square panel around the excerpt

By default, the excerpt is displayed within a panel. A value of "nopanel=true" displays the excerpt without the panel.

{excerpt-include:Excerpt Macro|nopanel=true}

The excerpt then appears as shown below:

A short summary of this page
RELATED TOPICS

Excerpt Macro
Working with Macros

Take me back to the Confluence User's Guide.

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.