Space Label Index Macro - Getting started

Introduction to Space Label Index Macro

Introducing the Space Label Index Macro – a versatile tool designed to streamline content organization and navigation within Confluence spaces. This macro creates an index of all labels within the space, along with the pages associated with each label. With its intuitive functionality, users can easily filter which labels to include in the index, allowing for targeted exploration of specific topics or categories.

Customization is key with the Space Label Index Macro. Users can configure the index to display content in one, two, or three columns, adapting 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.

What sets it apart? The Space Label Index Macro empowers users to create rich, dynamic indexes based on labels related to documentation or other useful information. By organizing content based on labels, users can quickly locate relevant pages and streamline their navigation experience within Confluence spaces. Whether users are searching for specific topics or exploring related content, this macro offers a smart and efficient solution for content discovery and management.

Get a full overview of the index tabs here: Introduction of Index Tabs

image-20240410-093414.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.

  • Label Filter: If you only want results from certain labels - Use commas to separate labels. For example: label1, label2

  • 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 space

By default, the Space Label Index Macro generates an index based on the current space. However, you have the flexibility to specify a different space by providing its space key. This feature empowers you to create indexes tailored to specific spaces within Confluence, facilitating focused exploration and organization of content according to your needs.

As mentioned you can define a different space by using the space key text field.

There is the following to be aware of:

If the space key is not valid, it will show the index for the current space with a information text stating: Space key now valid, using current space instead.

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

If there is no content in the defined space, the macro will just state: No data to show.

Label Filter

If you only want results from specific labels, simply use commas to separate the labels. For instance: label1, label2. This functionality is invaluable for spotlighting particular subjects or documentation areas, enabling focused exploration and organization of content within Confluence.

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: Introduction of Index Tabs

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.