Table of Contents Macro

The Table of Contents macro scans the headings on the current Confluence page to create a table of contents based on those headings. This helps readers find their way around lengthy pages, by summarising the content structure and providing links to headings.

Using the Table of Contents macro

Hint: For quick access from the editor toolbar, choose Insert > Table of Contents.

To add the Table of Contents macro to a page:

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

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Macro parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).




Output Type


  • list — produces a typical list-type table of contents.
  • flat — produces a horizontal menu-type series of links.

Display Section Numbering


Select the check box to apply outline numbering to your headings, for example: 1.1, 1.2, 1.3.

List Style


Select the style of bullet point for each list item.  You can use any valid CSS style.  For example:

  • none — no list style is displayed
  • circle —  the list style is a circle
  • disc — the list style is a filled circle. This is the typical bullet list, and is used for this example list.
  • square — the list style is a square
  • decimal — the list is numbered (1, 2, 3, 4, 5)
  • lower-alpha — the list is lower-case, alphabetised (a, b, c, d, e)
  • lower-roman — the list style is lower roman numerals (i, ii, iii, iv, v, vi)
  • upper-roman — the list style is upper roman numerals (I, II, III, IV, V, VI)

Heading Indent

Sets the indent for a list according to CSS quantities. Entering 10px will successively indent heading groups by 10px. For example, level 1 headings will be indented 10px and level 2 headings will be indented an additional 10px.



This parameter applies to flat lists only.  You can enter any of the following values:

  • brackets — Each item is enclosed by square brackets: [ ].
  • braces — Each item is enclosed by braces: { }.
  • parens — Each item is enclosed by parentheses: ( ).
  • pipe — Each item is separated by a pipe:
  • anything — Each item is separated by the value you enter. You can enter any text as a separator, for example "***". If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters.

Minimum Heading Level


Select the highest heading level to start your TOC  list.  For example, entering 2 will include levels 2, and lower, headings, but will not include level 1 headings.

Maximum Heading Level


Select the lowest heading level to include.  For example, entering 2 will include levels 1 and 2, but will not include level 3 headings and below.

Include Headings

Filter headings to include according to specific criteria. You can use wildcard characters. See Sun's Regex documentation for examples of constructing regular expression strings.

Exclude Headings

Filter headings to enclude according to specific criteria. You can use wildcard characters. See Sun's Regex documentation for examples of constructing regular expression strings.



By default, the TOC is set to print. If you clear the check box, the TOC will not be visible when you print the page.

CSS Class Name

If you have custom TOC styles in your CSS style sheet, use this parameter to output the TOC inside <div> tags with the specified class attribute.

Absolute URL
(absoluteURL )
  By default, the links in the TOC are relative URLs pointing to the current page. If checked, the links in the TOC will be full URLs. This setting is useful when you are including a page with a Table of Contents in another page, and want to control where the links should take the user.



The examples below are based on this table of contents:

Filtered Table of Contents

This example filters the headings to include those that contain 'Favourite', but excludes headings which end with 'Things'. The list is styled with Roman numerals.

Parameter Value
List Style upper-roman
Include Headings
Exclude Headings

The resulting table of contents is:

Flat List

This example filters all headings to render a flat list of 'Unknowns' enclosed in square brackets (the default list style).

Parameter Value
Output Type
Maximum Heading Level
Include Headings

The resulting table of contents is:


  • When you use a Table of Contents macro in a template, you will see an error when you preview the template itself. But the Table of Contents macro works on the pages that people create from the template – the table of contents shows up after they have saved the page. (This is probably because the template is not defined as a page, and the Table of Contents macro works for pages only.)
  • Due to an outstanding issue in the Table of Contents macro (CONF-10619), the macro browser's Refresh function does not render any parameter modifications. Currently, the rendering of parameter value modifications to the Table of Contents macro occurs only after the page is saved.
  • Using HTML heading markup with the Table of Contents macro
    The Table of Contents macro cannot handle HTML heading markup on its own. Hence, if you use the HTML and HTML Include macros to render HTML heading markup in a Confluence page, the Table of Contents macro will not create a contents list out of these headings. (For more information about this issue, please refer to TOC-93.)
    However, if you insert an HTML anchor into each HTML heading on your page (based on the following syntax), the Table of Contents macro will incorporate these headings into your contents list.

    The syntax for the anchor name is the page name and heading name separated by a hyphen. Remove all spaces and convert all text to lower case. Convert all punctuation marks to their URL-encoded equivalent.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. 

Macro name: toc

Macro body: None.

Storage format example

This example shows a list-type table of contents.

This example shows a flat table of contents.

Wiki markup example

This example shows a list-type table of contents.

This example shows a flat table of contents.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

100 Archived comments

  1. User avatar

    Lis Riba

    It appears that Confluence only allows one TOC or TOC-ZONE macro on a page.

    If you have more than one, then all will use the formatting attributes of the first one on the page.

    (I was trying to format a page with one TOC for display on the page, and a second one within tags for inclusion on other pages)

    02 Nov 2010
  2. User avatar


    Is it possible to put the table of contents in a box / frame (like wikipedia does)?

    Thank you in advance


    30 Nov 2010
    1. User avatar

      Sarah Kaye

      I put it in a panel - but my problem currently is that it takes up the whole width of the page.

      02 Feb 2011
      1. User avatar


        You can use the section and the column macro to setup a column with a defined width. When you put in this column the toc macro and the panel it won't use the whole screen width.

        03 Feb 2011
        1. User avatar


          Your suggestion doesn't work.

          03 Jun 2011
          1. User avatar

            Paul Watson [Atlassian]


            Does this example work for you (copy and paste near the top of your page):

            Include introductory blurb here...
            *On this page:*
            03 Jun 2011
            1. User avatar


              Thanks! It worked for me. - Sanjeev

              28 Nov 2011
  3. User avatar


    Hello. I'm looking for a way to render a table of contents so that the headings collapse. In other words, something like the {pagetree} macro, but rather than dealing with pages, it deals with headings in single document. Ideally I'd like to see some sort of expand collapse feature for {toc}.

    Is there a way to get this to work?

    01 Dec 2010
    1. User avatar

      Miroslav Benda

      Hello, as I am not sure what exactly you need to to with the expanding and collapsing table of contents I am using something like this:

      {toggle-cloak:id=contents}*To display the table of contents click here*


      ...some hints:

      1. toggle-cloak:id=contents -> the word "contents" needs to be the same also in cloak:id=contents
      2. "*To display the table of contents click here*" - this is custom - can be replaced by any text
      3. if this is placed within a page, {composition-setup} is required to be placed before the macros or at the top of the page

      Hope this helps, enjoy your day (smile)

      07 Oct 2011
      1. User avatar


        Hi MIroslav:

        I tried your macro above:

        {toggle-cloak:id=contents}*To display the table of contents click here*


        but it gave me the following error when I view the wiki:
        Unknown macro:{toggle-cloak}
        Unknown macro:{cloak}
        Am I missing something?  Also looks like they just update confluence to the latest ver and now I can't edit my document in the wiki Markup mode directly.  I need to do it in rich text editor mode and go to Insert -> Wiki Markup to insert...
        Any help will be appreciated!  Thx!
        03 Jul 2012
    1. User avatar


      I vote for this feature. I'd like to see an expandable/collapsible TOC that shows h1s by default, with the subheadings collapsed. I'm not having any luck making this happen with wiki markup.

      01 Oct 2013
      1. User avatar


        In v4.3.6, the wiki markup for TOC doesn't even work properly when in Documentation Theme, customizing the left-nav sidebar to use TOC instead of page tree. Does it work in other versions?


        01 Oct 2013
  4. User avatar

    Emily Heath


    While using the TOC macro on an imported word document, for some reason the final headings in the table of contents are appearing in the toc but are not linking to the heading anchors in the text.

    Can you offer any insight into this?



    16 Dec 2010
  5. User avatar

    Michael Schechter

    I use the {toc} macro to build a table of contents that includes headings for included pages. To do this, I use the includePages parameter. There does not seem to be any documentation on the Confluence site about this parameter; I found information at Adaptavist.

    Is this a deprecated feature? If not, would it be possible to update the documentation to include the definition and some examples?


    11 Jan 2011
    1. User avatar

      Michael Schechter

      Are there any updates related to my question planned for the the new documentation? If the functionality is being migrated to another macro, please let me know which macro I should now use.


      03 Oct 2011
  6. User avatar

    Miriam Liebl


    I have a page structure as the following:


    - page 1

     -- subpages

    - page2


    When exporting to PDF, I would like the headings of "page 1" and its children  to  be numbered as listet in the toc. Unfortunately I do not know how to do this.

    Second, it would be nice, if home was not numbered and the counting would start with page 1, since home seems to be the only parent page possible. This is quite unfortunate since my wiki must me exported to PDF as an support manual.

    Do you have any suggestions?

    Thx, Miriam

    26 Jan 2011
  7. User avatar

    Bill Street

    I am using the TOC macro to create an index to information imported to a page via the metadate-report macro. The metadate-report is in a column on the left and the toc is in a column to the right. All works fine except that the toc does not show any new headings that have shown up since the last time the page with the toc was edited and saved. The new items show up in the metadata but the list in the toc does seem to get updated. It seems that the content of the toc is generated when the page is saved and does not refresh each time the page is displayed.

    can anyone give me some insights?

    I would like to know if this is a bug or a new feature.

    I am using Confluence 3.2 and TOC 2.4.11

    17 Feb 2011
    1. User avatar


      the same problem for me

      11 Mar 2011
  8. User avatar

    Cody Cotulla

    I have an issue with the TOC macro and Firefox. If the heading contains a comma (,) or brackets (()) or any number of other "special" characters, the anchors the macro creates replaces those characters with entities.

    For example, 

    ITSM (IT Service Management)

    Creates the anchor


    The link works fine in IE and Chrome, but Firefox changes the %28 and %29 back to ( and ), which doesn't match the anchor and so the link fails.

    Firefox is the browser of choice for most of the people where I work, and it is frustrating for so many links to fail.

    It would be great if there was a parameter for the TOC macro that would cause "special characters" to be ignored when the anchor is created.

    23 Apr 2011
    1. User avatar

      Deividi Luvison [Atlassian]

      Hi Cody,

      Just to inform you that this bug was fixed in confluence 5.2.5 as you can see in here :

      CONF-26765 - Redirect to anchors in pages with titles that contain special characters is broken Resolved

      So upgrading your confluence to version 5.2.5 or latest will do the trick (smile).


      02 Oct 2013
  9. User avatar


    Hi All,

    I have quick question... I have a doc that looks like this:

    The TOC macro doesn't seem to properly handle the nesting of repetitive subsection names. Any of the "Success" entries will always point to the the first one in the doc? Anyone have a workaround/suggestion other than renaming the sub headers?



    26 Apr 2011
    1. User avatar

      Cody Cotulla

      If you don't mind having your markup a little ugly, you can do something like the following:

      h1. Some top level header
      h2. Succes{color}s{color}
      h2. Faile{color}d{color}
      h1. Another top level header
      h2. Succ{color}es{color}s
      h2. Fai{color}l{color}ed

      The toc macro will ignore the text in the {color} macro when it creates the anchor for the heading, which will make your anchors unique. Other macros besides {color} would probably work as well.

      27 Apr 2011
      1. User avatar


        Haha, that is one hell of an ugly hack. And your repetitions are limited to the number of permutations on the length of your section headers. :D
        But I guess it works, so thumbs up for that!^^

        30 Aug 2011
      1. User avatar

        David Lahr

        Using the wiki markup to modify / differentiate the headers doesn't appear to work anymore.  I'm guessing it is because the wiki markup is translated into whatever is really stored, and what is really stored is no longer different.  The workaround I'm using is to add spaces to the end of the header, but this does not look great in the TOC

        01 Mar 2012
  10. User avatar


    There seems to be a bug in the TOC macro when users change the color of a header. The TOC generates, but the TOC linking does not work properly. Has anyone had success creating a TOC out of colorized headers? If the headers use the default color, the TOC works fine. 

    29 Apr 2011
    1. User avatar

      Emily Johnson

      Yes, would love to see this fixed!!

      15 Nov 2011
    1. User avatar


      I seem to be having this issue as well – is there a fix?

      08 May 2012
    1. User avatar


      Same problem for us. Putting any text color in a heading breaks the toc links. So I ended up putting a star image in front of the text for each heading using one of their misc notations.

      06 Dec 2012
  11. User avatar

    ken ramey

    We have a couple users that have used the TOC macro on their pages and generated emails based on the page.  In those emails, the link to pages work, but the TOC links, being relative, do not seem to behave properly.  Users that click on the TOC links are taken to the Dashboard instead of the page.  It appears that the TOC links in the emails are being sent to instead of the actual page.  Anyone else seen similar behaviour or know how we might get around this?


    22 Jul 2011
  12. User avatar

    Susan Grodsky

    I had a toc-zone macro that worked beautifully before Confluence 4.0

    Now I am reorganizing the page and need to remove the toc-zone macro. When I remove the macro, all of the text that was included within the toc-zone macro disappears too.

    I tried copying the text and pasting it before the macro, but the that didn't work.

    It would be a snap to remove the macro in wiki markup. Now I am just frustrated. The car has stopped running, I'm a certified mechanic, but the hood latch is locked.

    26 Oct 2011
  13. User avatar

    Scott Saccone

    The TOC macro seems to conflict with the Tasklist Macro. I'm using Confluence 4.0.

    To reproduce:

    • Create a new page
    • Create a tasklist
    • Save
    • Add a task: "My Task"
    • Edit
    • Create a TOC at the top
    • Save
    • View the page: "My Task" is gone

    If you edit the page again you can still see the task data, it just doesn't show up when you view the page.

    13 Nov 2011
  14. User avatar

    Eduardo F. Sandino

    Please provide examples of How to exclude things from the TOC ? I am having issues with the PROFILE macro, the name of the user is included in the TOC.


    Thanks in Advance!

    18 Jan 2012
  15. User avatar


    It seems that the TOC linking is not working in Confluence 4.1.3. Only the first link works, the others are broken. I think this is due to wrong syntax of the <a> anchors in the TOC. This error is very serious because to us its very importent to have a TOC above of long pages.

    22 Jan 2012
    1. User avatar


      Same issue for me. Someone has a solution for this?

      Only solution what I know of: Delete textformat (copy to notepad and copy back to confluence) and apply (again) all textformat and add the TOC.

      This solution is not really workable when a lot of pages needs to be adjusted/converted. Please help.



      20 Mar 2012
    1. User avatar


      Same here.

      Some links in TOC work, others don't. The ones that don't work have rel="nofollow" attribute, which is probably what causing the problem.

      -- Maxim

      01 Jun 2012
      1. User avatar

        Qian Zhao

        You're right those links indeed have a 'nofollow' attribute. This macro becomes not usable on 4.x. Can anyone make an effort to improve?

        06 Jun 2012
  16. User avatar

    Matti Jurvanen

    Has anybody had problems with TOC macro when it is on a page that it included to another page? The links work fine on the original page but looks like they do not work on the page where it is included into.

    (version is 3.2.1_01)

    04 Apr 2012
    1. User avatar


      This is exactly why I'm here - was trying to see if there is something to do. Looks like nothing.

      16 Aug 2012
      1. User avatar


        Still the same in Confluence 4.3.2!

        Is there an open issue on that?


        Harald Mueller

        Software AG

        24 Jan 2013
  17. User avatar

    Michael Kornatzki

    this marco didn't work well in confluence 4.1.9.

    if i uncheck printable then i expect that the toc didn't gets printed but it also didn't gets shown.

    cheers, michael

    16 Apr 2012
    1. User avatar


      I have the same issue - really defeats the purpose of that parameter. I input a support ticket today because we need this to exclude from our pdfs that we generate as our user-guides. We'll see what they say...

      Seems like the TOC macro is quite buggy


      24 May 2012
      1. User avatar


        Having the same issue and wondering if there was a bug fix for this out there yet. We need the ToC to be available when reading online but to not appear when exporting to a PDF.

        23 Jul 2012
    1. User avatar

      Arthur Evans

      This is a known issue. See here:

      As far as I can tell, it was reported in February and there hasn't been any movement on it at all–not even a response from the developer to indicate whether they intend on fixing it.

      If this is affecting you, I recommend going to the bug and clicking on the "vote" and "watch" links so the developers know that people are interested.


      16 Nov 2012
  18. User avatar

    skip huffman

    Is there any way to automatically add an active table of contents?  The "Insert -> Table of Contents" feature seems to create just a list of headers on the page, but they aren't clickable.


    Also and related, is there a way to set a page so that it doesn't use the "blue and underlined" css for things that are NOT links.  It is confusing when it seems to be everywhere that confluence seems to think needs emphasis.

    21 May 2012
  19. User avatar


    Bump - I have the same concerns as Skip

    06 Jun 2012
  20. User avatar

    Chitra Patil

    I am using Stepstone's Zen editor–the TOC is messed up there. It doesn't update with the latest additions. I know you guys don't support Stepstone plugin, but the TOC macro is Atlassian's. They don't seem to work well inside Zen's editor.

    18 Jun 2012
  21. User avatar


    I'm trying to add a TOC to my wiki article, however my article has other articles embedded in it(cloaked). I only want the TOC to display headings from my article. Is there a proper solution to this? Thanks in advance.

    22 Aug 2012
  22. User avatar


    the toc macro if we have headings spread across various tabs in the card-deck arrangement. Is this a bug?we are using version 3.5.13

    19 Oct 2012
  23. User avatar


    The toc macro fails to navigate if we have headings spread within various tabs in a card-deck arrangement. Is this a bug? we are using version 3.5.13. Thanks

    19 Oct 2012
  24. User avatar


    we are getting an: 

    Error formatting macro: toc: java.util.EmptyStackException

    error. Any ideas what the cause of this could be? It used to work in earlier versions. We are currently using confluence 4.2.4 and plugin version 2.6.0.  

    07 Nov 2012
  25. User avatar


    I too am getting this error.  It appears to be related to the inplace editor

    11 Dec 2012
  26. User avatar

    Alexey Seredin

    When I'm using ToC macro, it inserts the Anchor macro in the ToC as well. So the link then leads to ToC page, not to the original Anchor location. Is there a way to get rid of this bug? 

    10 Jan 2013
  27. User avatar


    Hi i need your help please. Im working on Confluence 3.2 and I want to add a table of contenst but the only thing that happens is that it appears "

    Unknown macro: {toc }


    i havent found the way to make it. It just writes that and nothing is happening. Does anyone knows that happens or what im i doing wrong?


    17 Jan 2013
  28. User avatar


    the "unknown macro" doesnt appear, just the "toc"

    17 Jan 2013
  29. User avatar


    The background. I wanted to have titles of "h2." or "h3." with content hiden under them. Orginally I used,

     Example of Body Text Title

    though it made the heading appear as body text (sad) but I discovered

    which presents the title in an improved heading like format.

    This is great HOWEVER when I use

    none of the headings that are expandable appear in the table of contents (sad)

    Any tips on how to get expandable headings into "toc"???

    14 Mar 2013
  30. User avatar


    I have three issues with my article. Please help me with solutions. Thanks!

    • My TOC shows partially in blue and black. How can I fix to show only in Blue as visited links? 
    • My TOC shows a dangling bullet at the end of the list. How can I eliminate this bullet?
    • I also seem to have a large space between the last sentence in the article and the comments section. How can I eliminate the space?
    17 Apr 2013
    1. User avatar

      Alex Vlasov

      yes, in version 5.2.9 TOC shows blue and black link. It's very bad for documentations.

      18 Apr 2013
  31. User avatar

    Nathan Normandin

    Guys, This product is amazing, but I am having issues with exporting to PDF, I have been working for a few days at the export to pdf functionality. I have successfully configured the multi-page export to PDF to work properly. All pages are exported to a single document with a page-by-page index as the title page, unfortunately all of the TOC that I have on multiple pages do the same thing and force a page-break before and after the TOC, this makes the PDF export longer than necessary and inconsistent. I guarantee there is a way to fix this in the Space or Global PDF Style-sheet control but can't figure out what the content I need to add to make this work. Can anyone help with this?

    14 Jun 2013
    1. User avatar

      Nathan Normandin

      I attempted to fix this issue by the following adjustment in the PDF Stylesheet


      div.toc {  

        page-break-before: none;  

        page-break-after: none;  


      14 Jun 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Hi Nathan, 

      I'm not aware of any workaround for this issue, however it has been fixed in Confluence 5.1.3 if you are able to upgrade. If you are an OnDemand customer you should have the fix already.  You can see details on the issue here  CONF-28252 - Page break before and after Table of Contents macro are forced in PDF export Resolved .  


      16 Jun 2013
  32. User avatar


    With the latest version of Confluence On Demand, I am finding that TOC heading links to not work when the heading has a question mark in it. There is an old JIRA about this issue, but it was supposedly fixed many versions ago. Has the problem resurfaced? Is there a work around – other than not including the question mark? (It is a FAQ page, so question marks in headings are difficult to avoid!)

    Thank you.

    19 Aug 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Hi Anonymous, I have have not been able to replicate your issue in OnDemand (for me headings with ? characters appear and work fine in the table of contents macro). You might want to raise a support issue or a bug about this. 

      19 Aug 2013
  33. User avatar


    Thank you for your response, Rachel. I did a bit more investigating. It appears to only be an issue on FireFox – but is definitely an issue there (including with pages in the Confluence documentation that have question marks in the headings). The links work fine on Chrome and Safari. I will log a bug.


    20 Aug 2013
  34. User avatar


    Logged this bug: CONF-30485 - (In Firefox browser) Links in Table of Contents Macro not working when heading includes a question mark Resolved

    20 Aug 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Thanks Nicole!

      20 Aug 2013
  35. User avatar

    Kjell Lauren


    Version 2.6.7 of the TOC plugin produces only a numbered TOC list without the heading text. Is there a bug in the plugin? or should something more be configured to also get the heading text in the TOC list?

    Confluence 5.1.4 is used as WAR installation.

    Regards, Kjell

    03 Sep 2013
    1. User avatar


      I am having the same issue with my wiki's since updating to Atlassian Confluence 5.2. Pages that worked previously now display as just the numbered heading. I haven't been able to identify a bug for this yet but I suspect that we will need to search their open issues or report it in the correct forum. 

      11 Sep 2013
      1. User avatar

        Rachel Robins [Atlassian Tech Writer]

        I would suggest logging a bug for this.  You can do this at

        11 Sep 2013
  36. User avatar


    My TOC module breaks if the page I am using had the HTML or CODE block modules anywhere.  If I remove them, no problems.  Is there a fix planned or what is the solution

    12 Sep 2013
  37. User avatar

    Ulrich Weiß


    TOC links are not working, if:

    • ":" is in title, or
    • any special character (eg. ü ä) are in the heading.
    23 Oct 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Hi Ulrich, this should have been fixed - see CONF-26765 - Redirect to anchors in pages with titles that contain special characters is broken Resolved .  If you are using 5.2.5 or later and still experiencing this issue could you please raise a bug or contact Support? 

      23 Oct 2013
      1. User avatar

        Ulrich Weiß

        Thanks for reply. Yes, I can confirm, this bug is fixed in 5.3...

        24 Oct 2013
  38. User avatar

    Sherry Xie


    We just upgrade confluence from 4.3.2 to 5.2.5, and Table of Content plugin has been upgraded from 2.6.1 to 2.6.10.

    I found the page with TOC macro displayed differently, the table of contents in old version has Strikethrough if the contents headings contain Strikethrough, but the new version do not include Strikethrough anymore.

    Is this a bug or the functionality has been changed?



    31 Oct 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Hi Sherry, I've just tried this with v 2.6.10 of the Table of Contents plugin on Confluence 5.3 and it works as expected.  If you continue to have problems with 5.2.5 you might want to contact Support or raise a bug

      31 Oct 2013
  39. User avatar


    I added a table of contents to my page, but now the save button is disabled. The only way I have found out of it is to close the window, and then choose to restore the previously saved version, removing the table of contents. What am I doing wrong here?

    22 Nov 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Sounds like something fishy is going on, I'm not able to replicate the behaviour you describe.  You might want to contact Support or raise a bug about this one.

      25 Nov 2013
  40. User avatar


    Is there any way to globally change the css in order to ensure that there are no bullet points for the TOC? 

    24 Dec 2013
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      In the macro parameters you can specify none in the list style field to show the list with no bullet points. I'm not aware of a way to do this in the space CSS however.  You might want to ask your question at Answers as someone in the community may have a solution for you. 

      29 Dec 2013
  41. User avatar

    Kevin Landers

    Is there anyway to have the Table of Contents include page numbers when printed or exported to Word/PDF?

    We're attempting to use Confluence to track all of our documentation. Some of this documentation, such as a handbook, has to be printed for signing, etc from time-to-time.

    20 Feb 2014
    1. User avatar

      Adrian Reid [Atlassian]

      Hi Kevin, you can use the following css to include page numbers in the ToC.

      The code is taken from the example stylesheet available from confluencedefaultpdf.css.

      21 Feb 2014
      1. User avatar

        Erik Söderström

        Hello Adrian,

        Since the code you're referring to is in the default css already, shouldn't the Table of Contents include page numbers when printed or exported to Word/PDF as default (ie. no need to change anything to have this functionality)? We have the same problem here as Kevin, our table of contents just show the section numbers and titles, nothing else. We'd like to have dots (.) and page numbers displayed as well. Like so:

        1.1 One Title ....................................................... 32

        It doesn't seem possible, since the default css already has:

             span.toclead:before { content: leader(dotted); }

             span.tocnum:before { content: target-counter(attr(href), page, decimal ); }

        and all we get is:

        1.1 One Title


        14 Apr 2014
        1. User avatar

          Erik Söderström

          Managed to solve it myself by stumbling onto Steffen Heller's post in an Atlassian Answers thread about the TOC not being generated at all:

          "The appearance of that list can be adapted and refined with CSS that you enter at Browse > Space Admin > Look and Feel > PDF Stylesheet > PDF Export Stylesheet

          If you want page numbers and a dotted line you can use

          a:after {   
          content: leader(dotted) target-counter(attr(href), page);  

          To avoid that all other hyperlinks on your page also get page numbers you better put your toc into another css class. For this you enter some_class_name (choose whatever you like) at "CSS Class Name" from the Edit menu of the {toc} macro and put exactly that some_class_name before the "a:after" so that you get ".some_class_name a:after" (don't forget the dot at the beginning)."

          15 Apr 2014
          1. User avatar

            Erik Söderström

            This solution created more problems that I solved while typing this, so I just thought I'd share in case anyone else gets stuck there too:

            Just adding the CSS Class Name to the Table of Contents Macro Edit menu (as mentioned above), makes the TOC show disc bullets before each section number as bullet points, both in the PDF Export and on the actual page. The indentation of each section of the TOC changes, and nothing happens whatever you try to change in the Table of Contents Macro Edit menu. For example, if you leave the "List Style" input field empty, press Save, and open the Edit menu again, it will now says "disc". If you put "none" or "circle" or "square", nothing happens to the TOC. If you leave the "Heading Indent" empty, or put 15px, or 200px or anything, nothing changes. If you remove the CSS Class Name, all the Table of Contents Macro Edit menu input fields work like they should again.

            So, I figured out that by entering a CSS Class Name in the Table of Contents Macro Edit menu, all TOC styling must now be done in the Global PDF Stylesheet (for the PDF Export) + the Global Stylesheet (for the actual page). So as Confluence Admin, you have to go to Global PDF Stylesheet and add your TOC styling there for your PDF export and then go to the Global Stylesheet and add your TOC styling there for your page.

            For example, to have your TOC align to the left side of the page, remove any bullets (list-style-type), have an indentation of 15px for each section, a dotted line and page numbers, you'll add the following:

            .some_class_name {
              margin-left: -15px;
              padding-left: 0px;

            .some_class_name ul {
              margin-left: 0px;
              padding-left: 15px;

            .some_class_name a:after {
              content: leader(dotted) target-counter(attr(href), page);

            16 Apr 2014
  42. User avatar

    Chong Yie Chang


    I could not create the table of contents successfully.

    The purpose is using Heading1 style, but the table of contents macro cannot extract the "Purpose" successfully.

    Could any body help me understand?



    24 Feb 2014
    1. User avatar

      Chong Yie Chang


      I know the reason now. I have to save all once before I really activate the macro.

      24 Feb 2014
      1. User avatar

        Rachel Robins [Atlassian Tech Writer]

        I'm glad you were able to get the macro working.  In the macro browser, you can also click the Refresh icon  to update the preview - this helps you see what your table of contents will look like without saving the page. 

        24 Feb 2014
        1. User avatar

          Chong Yie Chang

          Thanks Rachel, but I still have to remind you that the first save is necessary or the refresh button will not work.


          Best regards,


          Chong Yie

          25 Feb 2014
  43. User avatar

    Ashutosh Saxena

    Is there a way you could include a page anchor (Anchors) in your table of contents without adding heading styles to it? I have a long table in a page, and I use anchors in the first column of the table, and use it to link to certain parts of the table. I can manually do it, but can I use the Table of Contents Macro to do the same?

    13 Mar 2014
  44. User avatar


    I am exporting a pdf, out from multiple confluence wiki pages. My requirement is to have a minitioc(for h1, h2, h3 etc.) at the top for each page in the exported pdf. Is this possible to generate, and how?

    I don't want to update my wiki pages.


    25 May 2014
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      You can customise the layout of the PDF, and it may be possible to make a table of contents appear on each page (I'm not sure how to do it myself, but it should be possible).  There's some info on this page Customise Exports to PDF and this page Advanced PDF Export Customisations.  I think there is also a lot of information on Answers too. 

      25 May 2014
  45. User avatar

    Jonathan Hult

    I am using Panel macro. I would like to have the Table of Contents macro be able to use the titles from the Panel macro. Does anybody have ideas about how this could be accomplished?

    02 Jun 2014
  46. User avatar

    Bruno Miretti

    Hi, using Confluence OnDemand, I was wondering why we have the option "Display Section Numbering" in the table of contents macro whereas we cannot have numbered headings except if we pay for the add-on, add-on that does not manage 'include' pages as numbering is reset. In such a case the "Display Section Numbering" is not necessary.

    Could you explain its purpose ? Thanks

    14 Aug 2014
    1. User avatar

      Rachel Robins [Atlassian Tech Writer]

      Hi Bruno, the Display Section Numbering checkbox will add a number to each item in the table of contents. It is not related to any third party add-ons that might allow actual heading numbering.  For example

      This is my first heading
      This is my second heading

      This is the table of contents with Display Section Numbering selected:

      18 Aug 2014
      1. User avatar

        Bruno Miretti

        Hi Rachel,

        I know it is not related to the add-on but I (in fact 'we') really do not understand why we can have numbered headings in the table of contents whereas we can't have numbered headings in the document. It's like reading a book where you have a table of contents with page numbers whereas the book itself does not contain any page number. Thanks for clarification.

        18 Aug 2014
      1. User avatar

        Antonio Luna

        Yet another user here wondering why it's not possible to show numbered headings within the document. It's hard to navigate through a big page when there's duplicated heading values and not numbering available. For instance:

        • Feature A
          • Proposal
          • Return of Investment
          • ...
        • Feature B
          • Proposal
          • Return of Investment
          • ...
        • Feature C
          • Proposal
          • ...

        Looking at a "Proposal" heading doesn't tell me anything unless I scroll up to find what feature I'm in.

        03 Mar 2015
  47. User avatar

    Hanna Magiera

    Hi, I am using the latest TOC version and I am wondering if there is an option to display heading with status macro or emoticons? 

    02 Mar 2015
    1. User avatar

      Giles Brunning [Atlassian Technical Writer]

      Hi Hanna,

      There's no way to do it currently, but we do have an open feature request for it. You can comment on the issue and watch it to get updates, if you like.

      CONF-36404 - Display Emoticons in TOC New

      02 Mar 2015
  48. User avatar

    Francis Jones

    There seems to be a bug where TOC Headings won't work as outside hyperlink (eg inserted in an email) if the Heading includes a question mark.

    Quite annoying if you want to refer a user directly to a FAQ inside a lengthy page.


    07 Apr 2015
Powered by Confluence and Scroll Viewport