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,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon on the toolbar. The macro browser window will open.
- Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
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
Take me back to the Wikis Help Guide.