Page Index Macro

Add the Page Index macro to a page to create an alphabetical index of all pages in the current space.

This is a legacy macro, and does have some limitations, so it's not suitable for use in very large spaces. 

In small spaces, this macro can be useful for providing a directory of pages, such as:

  • project pages
  • knowledge base articles
  • process and procedure pages.

On this page:

Add this macro to your page

To add the Page Index macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Page Index from the Navigation category.
  3. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: Page Index macro on a page.

Limitations

The Page Index macro can be quite memory hungry in large spaces.  To prevent it causing out of memory errors in your site, we:

  • don't show page excerpts when there are more than 200 pages in the space, 
  • don't list any pages if there are more than 1000 in the space. This limit is configurable. System Administrators can use the page.index.macro.max.pages system property to reduce the number of pages displayed.

Change the macro parameters

This macro has no parameters.

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: index

Macro body: None.

{index}
Last modified on Nov 29, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.