12 Days of Confluence Elements: Day 12 - Table of Contents macro
If you’ve made it this far - thank you! Let me know other themes you’d like to cover in the next season.
The Table of Contents macro scans the headings on the current Confluence page to create a table of contents based on those headings.
Any text formatted as a heading along with emojis, mentions, statuses, and dates are available for inclusion in your table of contents.
When would you use Table of Contents macro?
This helps readers find their way around lengthy pages, by summarizing the content structure, and by providing links to headings. A rule of thumb is to use the Table of Contents macro when your article requires scrolling past the “fold” of a page. Users generally familiar with the page may be looking for a specific section, and the Table of Contents macro can help them navigate to the specific content they’re looking for.
Where is this used in our instance?
An example of the Table of Contents macro is found on Viewing and maintaining a student's academic standing (SHAINST/SGASTDN). Rather than using a formatted heading for “On this page”, we use bolded Normal text to prevent the heading from pulling into the macro.
Use the Table of Contents macro
To add a Table of Contents to your page:
From the editor, select Insert from the toolbar to bring up the insert menu.
Find the Table of contents macro and select it. You can also type
/tableofcontents
to select this macro from the insert menu right in the body of your page.Upon selection, the Table of Contents placeholder will appear in the body of your page.
Your table of contents won’t be visible while editing. When you preview the page or publish it, you’ll be able to see an auto-generated table of contents based on the page’s headings.
To configure your Table of Contents:
From the editor, select the Table of Contents placeholder.
Select the Edit () icon to open the configuration panel.
Customize the parameters of your table of contents in either Basic or Advanced mode.
Your selections won’t be visible while editing. When you preview the page or publish it, you’ll be able to see how your customized table of contents looks.
As you continue editing the page, the configuration panel will close.
You can also select the centered, medium-width, or full-width icon to adjust the width of your table of contents. Select the copy icon to duplicate it elsewhere, and/or the trashcan icon to remove it entirely.
Parameters
Parameters are options that you can configure to control exactly how your table of contents appears on the page.
To customize your table of contents, you can configure its basic and/or advanced parameters, depending on your needs and preference.
ID numbers should never be released via ticket, phone, or email. Students can access their ID numbers via Gibson. Students needing ID numbers for transcript orders can enter their SSN or 9 0's in the ID number field.