Page Properties Macro

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

This macro was previously known as the Metadata Details macro.

Adding the Page Properties macro to a page

The Page Properties macro uses key value pairs. The body of the macro must be set up correctly for your information to appear in the Page Properties Report.

To add the Page Properties macro to a page:

In the editor, choose Insert > Other Macros > Page Properties.
In the macro body create a two column table and remove the header row.
In the left column list your 'keys' - these will be the column headings in your report table.
In the right column list the value for each key - these will populate the rows in your report table.
Add a label to your page - you will need to specify this label in the page properties report macro.
Save your page.

On this page:

Related pages:

Don't forget to add a label to your page, or your page will not appear in the Page Properties Report macro.

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

Screenshot: Page Properties macro in the editor. Deadline, Current Status and Team will be column headings in the report.

Screenshot: The example above as it appears in the Page Properties Report

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:

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

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

Add a label to the page containing the Page Properties macros.
Specify an ID in the Page Properties macro that you want to report on.
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.

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.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.

Macro name: details

Macro body: Accepts rich text.

Storage format example

The following example contains two pieces of data - Owner and Date.

<ac:structured-macro ac:name="details">
  <ac:rich-text-body>
    <table>
      <tbody>
        <tr>
          <td>Owner</td>
          <td>Rach Admin</td>
        </tr>
        <tr>
          <td>Date</td>
          <td>1 May</td>
        </tr>
      </tbody>
    </table>
  </ac:rich-text-body>
</ac:structured-macro>

Notes

You cannot use text formatting or macros in the left column as the data in this column is used to populate the column headings in your Page Properties Report macro.
If your table has a header row, this row will be ignored by the Page Properties Report macro. You should remove the header row.
It is not possible to reference the metadata using the metadata key from within the page, or anywhere else on a Confluence page.

Page tree