How To Create A Table Of Contents In Confluence

Screenshot: The Table of Contents macro neatly organizes lengthy blog content.Read: how to create a table of contents in confluence

Using the Table of Contents macro

Contents

To add a Table of Contents macro to a page:

Choose Table of contents are from Confluence content Category.

Enter any parameters.

Choose Insert.

You can then publish your page to see the macro in action. Screenshot: Enter the parameters for the Table of Contents macro.

Changing macro parameters

Macro parameters are used to change the behavior of the macro. To change the macro parameters:

In the editor, click the macro placeholder and select Edit.

Update the parameters as required and then select Insert.

Read more: how long does it take to format the hard drive Below is a list of the parameters available in this macro. in brackets (example).

Examples

The following examples are based on this table of contents:Filtered Table of Contents This example filters titles to include those containing ‘Favorites’, but excludes titles ending with ‘Things’. Lists are styled with Roman numerals. Read more: how to use split screen on iphone 6 plus The resulting table of contents is:Flat list This example filters all titles to display a flat list of ‘Unknowns’ enclosed in square brackets (default list style). Read more: how to use split screen on iphone 6 plus The resulting table of contents is:

Other ways to add this macro

Add this macro as you type Add this macro using wiki markup This is useful when you want to add the macro outside of the editor, for example, custom content in the sidebar, header or footer of spaces.Macro name: hairMacro content: None This example shows a list table of contents This example shows a flat table of contents.

Notes and known issues

When you use the Table of Contents macro in sample, you will see an error when previewing the template itself. But the Table of Contents macro works on pages that people create from templates – the table of contents shows up after they’ve saved the page. (This is probably because the template is not defined as a page, and the Table of Contents macro only works for pages.)
The Table of Contents macro shows only the page or blog post content. For example, you cannot use it to add a table of contents of headings in a comment.
Due to a persistent problem in the Table of Contents macro (CONF-10619), the macro browser of Refresh the function doesn’t show any parameter modifications. Currently, rendering parameter value modifications to the Table of Contents macro occurs only after the page is saved.

Use HTML heading markup with the Table of Contents macroThe Table of Contents macro cannot handle HTML header markup on its own. Therefore, if you use the HTML and HTML Include macros to display HTML header markup in the Confluence page, the Table of Contents macro will not generate a list of content from these headings. However, if you insert an HTML link into each HTML header on your page (based on the following syntax), the Table of Contents macro will incorporate these headings into your content list. separated by hyphens. Removes all whitespace and converts all text to lowercase. Converts all punctuation to their URL-encoded equivalents. Read more: how to remove reflective logos from clothes
There is a known issue where if you click a title in the Table of Contents macro, then click the back button in your browser, you will not be returned to the table of contents (or to your previous page). To work around this, use the Table of Contents Macro. See CONFSERVER-40462 – Get incident details… STATUS and CONFSERVER-52497 – Get incident details… STATUS for more information.