Include Page Macro

Still need help?

The Atlassian Community is here for you.

Ask the community

You can use the Include Page macro to display the contents of one Confluence page or blog post in another page or blog post. Any changes to the original page are automatically reflected wherever it is included. 

Using the Include Page Macro

To add the Include Page macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.

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 to Include

None

This is the name of the Confluence page or blog post that you want to include in the current page. Start typing a page title, and Confluence will suggest matching pages from the current space and other spaces.

Alternatively you can specify the page as follows:

  • If the page or blog post is located in another space, add the space key and a colon in front of the page name. For example, DOC:My page name. The space key is case sensitive.
  • To include a blog post, specify the date as well as the title of the blog post. For example: /2010/12/01/My blog post.
  • You can include pages from personal spaces using ~username as the space key, where 'username' is the person's username. For example, ~jsmith:My page name.

Wiki markup example

This example 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: include

Macro body: None.

{include:DOC:My chocolate page}

Notes

  • If you want to include part of a page rather than the whole page, use the Excerpt and Excerpt Include macros.
  • To display a page's contents, you need 'View' permission for that page. Similarly, people who view the page will need 'View' permissions for the embedded page as well as the page into which it is embedded. See space permissions or contact your Confluence space administrator for more information.
  • If you want to embed an external page into a Confluence page, you need the HTML Include Macro.
Last modified on Feb 15, 2018

Was this helpful?

Yes
No
Provide feedback about this article

In this section

Powered by Confluence and Scroll Viewport.