The Excerpt Macro is used to mark a part of a page's content for re-use. By itself, the excerpt macro does not change the display of a page. However, defining an excerpt enables other macros such as excerpt-include and blog-posts macros to display the specified content elsewhere.
You can only define one excerpt per page. In other words, you can only include one {excerpt}...{excerpt} macro on a page.
On this page:
Usage with the Macro Browser
To insert the excerpt macro into a page using the Macro Browser,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - 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.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
Once you've found the excerpt macro, click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
{excerpt}A short summary of this page{excerpt}
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 |
|---|---|---|
hidden |
false |
Controls whether the text between the |
Hiding the contents of the excerpt:
{excerpt:hidden=true}A short summary of this page{excerpt}
RELATED TOPICS
Excerpt Include Macro
Working with Macros
Take me back to the Wikis Help Guide.