Child pages
  • Include Page Macro

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{color:red}This page is a DRAFT and is visible to *Atlassian staff only*. We will publish it with the release of Confluence 3.5.{color}

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*:

h2. Usage with the Macro Browser

{color:#0099cc}*To insert the Include Page macro into a page using the Macro Browser,*{color}
{panel: borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor= #D5EFFF}
{excerpt-include:Navigating to the Macro Browser|nopanel=true}

h2. 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||
|{nomarkup}{include:Sample Include Page}{nomarkup}|{include:Sample Include Page}|

h2. Parameters


| *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}}. |

h2. 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}

h2. Notes

* If you want to include part of a page rather than the whole page, use the [Excerpt|Excerpt Macro] and [Excerpt Include|Excerpt Include Macro] 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|Space Permissions Overview] or contact your Confluence [space administrator|Confluence Glossary#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|HTML Include macro].


[Working with Macros]

Take me back to the [Wikis Help Guide].