Page Index Macro

The Page Index macro creates an alphabetical index of all pages in the current space.

The top section provides the total number of pages in the space, followed by a count of pages for each letter. Click any letter to jump to the bottom section, which lists all the pages in the space alphabetically. The first few lines of each page will be included if there are less than 200 pages in the space. 

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, and don't list any pages if there are more than 5000 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.


Screenshot: Page Index macro (partial view)


Using the Page Index macro

To add the Page Index macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.

This macro accepts no parameters.

Wiki markup example

This example 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 Apr 23, 2018

Was this helpful?

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