Include Page Macro

Add the Include Page macro to a page to display the contents of another page or blog post in this page. 

This macro is great for:

  • single-sourcing instructions and procedures
  • sharing useful information in multiple spaces
  • all types of content reuse.

You can add multiple Include Page macros to your page, and combine them with text, images, tables and other macros.

Because you're simply including the content of the other page, rather than duplicating it, any changes to the original automatically flow through to wherever the page is used.  

The Include Page macro respects space permissions and page restrictions, so be sure to check who can view the page you're including.

On this page:

Screenshot: Meeting notes page with a reusable warning at the top. 

To learn how to create a reusable content library, check out Develop Technical Documentation in Confluence.

Add this macro to your page

To add the Include Page macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Include Page from the Confluence content categories.
  3. Enter the title of the page you want to include. It can be in this space, or another space.
  4. Choose Insert

You can then publish your page to see the macro in action.  

Screenshot: The Include Page macro nested within a Note macro in the editor.  


Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

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.

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).

Limitations

This macro has a few limitations you need to be aware of:

  • The macro respects space permissions and page restrictions. It won't display the contents of the included page to anyone who doesn't have adequate permissions to see the included page. 
  • The macro will include the entire page content. If you only want to display part of a page, use the Excerpt Include Macro instead. 
  • The macro can only display pages that exist in your current site. You can't use the Include Page macro to display the contents of pages in other Confluence sites.   

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This 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}
Last modified on Oct 9, 2020

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.