Page tree
Skip to end of metadata
Go to start of metadata

Introduction

For the Intern Projects Page, we created a table that lists all the children pages dynamically.  This is a feature of Confluence called Page Properties Report.  It looks similar to the following:

There are three parts to creating a report like this:

  1. The {page properties report} macro.  This goes into the parent page (or really, any page; it does not need to be the parent to produce the table).

  2. A child page with the {page properties} macro.  Inside this macro will be a table of column headings and values.

  3. A label for the child page.  The report macro finds all pages with that label (this is why it does not need to be a child page), and looks for the page properties to generate the report.

Report Page

For the report page, enter the {page properties report} macro.  The configuration of the macro is as follows:

 

The label field is used to determine what pages are candidates for inclusion.  Personally, I wish this could just be "children", but it doesn't work that way.  You must label each page before it can be included in the report.

 

You can restrict the search to a specific space, to avoid picking up pages from other spaces that might have the same label.

 

Optionally, if there is more than one page properties macro in the page, you can choose which page properties to use.

 

You can also change the name of the "Title" column.  This still uses the page title as the content.

Additionally, the order or number of columns to show can be changed.  If not specified, the order of the columns is alphabetical, not the order shown in the page properties table.

 

You can limit the number of results to show in the table.  Leaving it blank shows every page found that matches your criteria.

 

You can also specify the default sort.  I usually prefer to sort by title.

Page to be Included in Report

Any page can be a candidate for inclusion.  I prefer to have the pages be children so that it shows nicely in the side banner, but this is not a requirement.

First, create or edit the page you want to include in the report.  Click on the Label button to add your label.

Labels that already exist will automatically show up as you start typing.  The first time you create a label, just enter your new one and click Add.

After that, it will pop up after the first few characters so that you don't end up accidentally adding a different label due to spelling mistakes.

Insert the {page properties} macro.  This will create a blank box in your page.

Insert a two column table into the box using the button.

Each word in the left column will be a report column header.

Anything (including macros, JIRA references and so on) put into the second column will be placed under that column's heading.

Be aware that differences in these tables from one page to another will result in different headings being displayed in the final report.  There is no method to make the tables standard across a set of pages; this must be done manually.

 

 

Also note that the page properties shows up as a table inside the rendered page when someone view it.  If you do not want the table to be visible, edit the page properties, and check the Hidden option.

And that's about it.  Hope this is useful.

Page viewed times

  • No labels