This page last changed on Jun 03, 2009 by ggaskell.

The Page Index macro creates a hyperlinked alphabetical index of all pages within the current space.

The top section of the Index contains a cell for letter of the alphabet, including separate cells for numbers and symbols. Each of these cells indicates the number of pages in which the first letter of the title matched the corresponding letter, number or symbol in the cell.

The lower section is effectively an extended version of the top section. However, each cell shows the page name followed by the first few sentences of content on that page.

Each letter, number or symbol in the top section is hyperlinked and leads to its corresponding cell in the lower section. Additionally, each page title in the lower section is hyperlinked and leads to its corresponding page in the space.

Screenshot: Index Macro segment

On this page:

Usage with the Macro Browser

To insert the Page Index macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the Page Index macro, click 'insert' to add it to your page.

Usage in Wiki Markup

What you need to type Segment of what you will get
{index}

Parameters

This macro accepts no parameters.

RELATED TOPICS

Working with Macros

Take me back to the Confluence User Guide.


page-index.png (image/png)
Document generated by Confluence on Dec 10, 2009 18:45