Page Children Index Macro - Getting started

Introduction to Page Children Index Macro

Introducing the Page Children Index Macro – a powerful tool designed to streamline content navigation and exploration within Confluence. This macro provides users with a comprehensive overview of direct child pages or all descendants, depending on their preference. By default, it generates an index based on the page where the macro is added, but users have the flexibility to define any page as the starting point for their index.

Customization is at the heart of the Page Children Index Macro. Users can configure the index to display content in one, two, or three columns, tailoring the layout to suit their preferences and optimize readability. Additionally, the macro offers the option to include supplementary index tabs such as A-Z index, created date, modified date, creators, and last editors, providing users with valuable context and insight into their content.

With the Page Children Index Macro, users can quickly locate the pages they seek, facilitating efficient content discovery and navigation. Whether users are searching for specific child pages or exploring the entire descendant hierarchy, this macro empowers them to find the information they need and move forward in their quest for knowledge within Confluence.

Get a full overview of the index tabs here:

image-20240405-122046.png

Finding the macro in the Confluence macro navigator

Maybe you’re already a Confluence guru and know the ease of the macro navigator.

However, for those who early in the Confluence journey, here is a quick guide. Click as below and write IndexPro, then you get a overview of all the IndexPro macros.

image-20240405-113313.png

 

Configuration

When the macro have been added to a page, it will start with the default configuration, which is the index is based on the current page, the A-Z index enabled with 3 columns in the index and showing direct children.

But you can configure the macro to suit your needs, you have the following options:

  • Define which page the index should be based on by defining page id.

  • Depth: Choose if you only want to see direct children or all descendents of a page

  • Columns: 1 to 3 columns

  • Index Tabs: A-Z index, created date, modified date, creators, and last editors

Open the configuration panel

Just click on the macro and then click on the pen!

Voila! the configuration panel opens!

 

 

Defining Page

By default, the index is generated based on the current page. However, you have the option to specify another page to use as the basis for creating the index. Thus, you only need to define a page ID if you wish to generate the index based on a different page.

To find the page ID of a page, follow these steps:

  1. Navigate to the page you would like to create an index based on within Confluence.

  2. Look at the URL in your browser's address bar.

  3. Within the URL, you will find a section that contains the page ID. It typically appears after somesite.atlassian.net/wiki/spaces/SPACEKEY/pages/PAGEID in the URL.

There is the following to be aware of:

If there is no children or descendents to the defined page or the page id is incorrect then it will show as below.

If some of users is getting this message even though the page exists - It is because they don’t have access to the defined page.

Depth

Select whether you prefer to view only the direct children or all descendants of a page. This option empowers you to create an index tailored to the specific content you wish to explore.

Number of Index columns

Empowering you with choice and flexibility, the Space Page Index Macro lets you dictate the layout that best suits your needs. Whether you prefer a streamlined view with just one column or a more expansive display with two or three columns, the decision is entirely yours.

For some users, a single column may offer optimal clarity, allowing for a focused, uncluttered presentation of content. Others may find that two columns strike the perfect balance between compactness and comprehensiveness, accommodating a broader range of information without overwhelming the viewer. And for those who require maximum detail and organization, three columns provide the space to display content-rich indexes.

One column

Two columns

Three columns

 

Configure Index tabs

Index tabs such as A-Z index, created date, modified date, creators, and last editors can be effortlessly integrated, providing users with a wealth of information at their fingertips.

The index tabs are almost the same on all three macros. - You can read a full description of each index tab here:

By default the A-Z Index is enabled.

When a new index tab is enabled the will show in top of the macro as tabs.

 

 

Â