Confluence Docs 3.0 : Include Page Macro This page last changed on Jul 02, 2009 by ggaskell. The Include Page Macro allows you to display the contents of one Confluence page in another. To display part of a page rather than include the whole page, use the Excerpt Macro and the Excerpt Include Macro. To display a page's contents, you require 'View' permission for that page. This is assigned by a space administrator from the Space Administration screens. See Space Permissions or contact your Confluence space administrator for more information.
| If the name of the included page is changed after you have written the macro, the page name does not change automatically in the macro. In the event of that happening, you will need to change the page name manually in the macro parameters.
On this page: Usage with the Macro Browser Usage with the Wiki Markup Editor Parameters Example ## Usage with the Macro Browser To insert the include page macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. Once you've found the include page macro, click 'insert' to add it to your page. ## Usage with the Wiki Markup Editor Where 'Sample Include Page' is the title of the page whose contents you want to display:
What you need to type | What you will get
--- | ---
{include:Sample Include Page} | 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 settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
Parameter | Default | Description
--- | --- | ---
Page to Include | None | This is the name of the Confluence page you want to include in the current page. If the page you wish to include is located in another space, precede the name of the page with the space key value and ensure that the two values are separated by a colon. For example, `DOC:Include Page Macro`. The space key value is case-sensitive.
Once the desired page is set, there are no further parameters for this macro. ## Example To display contents of a page located in another space Use the following code, where 'DS' is the spacekey of the other space and 'Confluence Overview' is the name of the page you want to display.
    {include:DS:Confluence Overview}
You can include pages from personal spaces using ~username as the space key. ##### RELATED TOPICS Embed only part of an internal page Embed an external page Working with Macros Take me back to the Confluence User Guide.

Document generated by Confluence on Nov 05, 2009 23:35