Page Properties Macro

The Page Properties and Page Properties Report macro work together to show summary information from one page on a another page. You can see examples of these two macros in action in the Decisions and Product Requirements blueprints.

Adding the Page Properties macro to a page

The Page Properties macro uses key/value pairs.

To add the Page Properties macro to a page:

  1. In the editor, choose Insert > Other Macros > Page Properties
  2. In the macro body create a two column table
  3. In the left column list your 'keys' – these will be the column headings in your report table
  4. In the right column list the value for each key – these will populate the rows in your report table
  5. Add a label to your page (you'll need to specify this label in the page properties report macro)
  6. Save your page

Next you need to add the Page Properties Report macro to another page.

Here's an example of the Page Properties macro in the editor. Deadline, Current Status, and Team will be column headings in the report.

Here's what the example above will look like in the Page Properties Report.


You can also set up the Page Properties macro horizontally. To do this:

  • Create a two row rather than two column table, and ensure the first row has the heading row style applied.
  • List your keys in the first row, and values in the second row.

The Page Properties Report Macro will be able to pull this information accurately even if you're using the Page Properties Macro vertically elsewhere.

Using multiple Page Properties macros on one page

You can add multiple Page Properties macros on a single page, and choose whether to include all or only specific macros in the report. You might use multiple macros because you want the information in the macro to display in context with the rest of the page, or because you want to be able to report on individual Page Properties macros separately. 

The Page Properties macro includes an optional ID parameter that can be used to identify specific Page Properties macros. 

To show the contents of all Page Properties macros in the report:

  1. Add a label to the page containing the Page Properties macros
  2. Specify this label in the Page Properties Report macro

To show the contents of selected Page Properties macros in the report:

  1. Add a label to the page containing the Page Properties macros
  2. Specify an ID in the Page Properties macro that you want to report on
  3. Specify both the label and ID in the Page Properties Report macro

Note: The Page Properties Report macro can only accept one page label, and one ID.

See the Page Properties macro in action in How to document product requirements in Confluence. This powerful macro lets you create a summary page that pulls in information from multiple pages.

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 Properties ID

(None)

Optional ID used to identify a particular Page Properties macro on a page. Specify this ID in the Page Properties Report to include summary information from macros with this ID only.

Hidden False Determines whether the data in the Page Properties macro will be displayed on the current page. This setting does not affect the display of the detail in the Page Properties Report macro.

 

Notes

  • You can't use macros in the left column as the data in this column is used to populate the column headings in your Page Properties Report macro. 
  • It is not possible to reference the metadata using the metadata key from within the page, or anywhere else on a Confluence page.
  • There is a known issue where the Page Properties Report macro does not correctly display content from multiple Page Properties macros. See  CONF-34141 Released to Server  for more information. 

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport