NYU Wikis Help Center
Child pages
  • Include Page Macro
Skip to end of metadata
Go to start of metadata

This page is a DRAFT and is visible to Atlassian staff only. We will publish it with the release of Confluence 3.5.

You can use the Include Page macro to display the contents of one Confluence page or blog post into another page or blog post.

On this page:

Usage with the Macro Browser

To insert the Include Page 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.

Usage with the Wiki Markup Editor

Let's assume that 'Sample Include Page' is the title of the page whose contents you want to display. Our sample page is here: Sample Include Page.

What you need to type

What you will get
Unknown macro: {nomarkup}

Start of sample page content

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

End of sample page content

Start of sample page content

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

End of sample page content

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

Page to Include

None

This is the name of the Confluence page or blog post that you want to include in the current page.

  • 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.
  • 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.
  • The space key is case sensitive.
  • 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.

Examples

This example shows how to display the contents of a page located in the same space as the current page, where 'Confluence Overview' is the name of the page you want to display. 

{include:Confluence Overview}

In this example, the page is located in another space, where 'DS' is the key of the other space. 

{include:DS:Confluence Overview}

This example shows how to display the contents of a blog post located in the same space, where 'Free chocolate in the kitchen' is the name of the blog post you want to display, and the URL of the blog post contains the date '2010/12/01'. 

{include:/2010/12/01/Free chocolate in the kitchen}

In this example, the blog post is located in another space, where 'DS' is the key of the other space. 

{include:DS:/2010/12/01/Free chocolate in the kitchen}

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 someone changes the name of the included page after you have added the macro to your page, the page name does not change automatically in the macro. You will need to change the page name manually in the macro parameters.
  • If you want to embed an external page into a Confluence page, you need the HTML Include macro.
RELATED TOPICS

[Working with Macros]

Take me back to the Wikis Help Guide.