Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,293,564
Community Members
 
Community Events
165
Community Groups

Generating Table of Contents on a parent page (for contents captured on child pages)

Hello:

Currently have one very long page on Confluence and it is now become difficult to maintain, find info, etc. for readers and the editor. This page has a Table of Contents (TOC) at the top of the page now.

We are thinking of taking good part of the contents from this page and move them into multiple child pages created under the main page. So it would be something like the following afterwards:

Product XYZ  (aka main page; parent page)
   --  Supported functionality  (aka subpage; child page)
   --  Pricing
   --  Service agreement
   --  Compliance
   --  etc.

Now we still want the TOC at the top of the main page (i.e., parent page) for contents included in the subpages. Assuming once the TOC is generated, if a user is to click on a link (say for Pricing), the user would be redirected directly to the "Pricing" subpage.

Does anyone know how one go about creating the TOC on the main page which would support the contents on the child pages?

Thanks.

2 answers

0 votes
Bill Bailey Community Leader Aug 02, 2021

The lefthand page navigation is not an option? 

If you just need links to pages, you can use the children-display-macro 

Or are you wanting to display links to headings on the child pages in the ToC?

Hello Bill,
I am not sure what you mean "lefthand page navigation."

I want links to various sections / sub-section headings from the child pages to be included as part of the Table of Contents on the main page.
Thanks.

Bill Bailey Community Leader Aug 02, 2021

I am referring to the navigation pane on the left, AKA Space navigation sidebar.

I would think you can make what @Svenja has suggested work. If you were NOT on Cloud, I would propose writing a user macro, but that's out.

My suggestion is to just think outside the box a bit and just have a ToC on each page, and use the childred display macro on the top-level page (look at how Atlassian structures their documentation). Save yourself a lot of effort implementing somthing that few users will really use.

All to often, we try to replicate a printed doc structure in Confluence, but that does not make best use of a Wiki. 

Hi @B Patel,

you could put a "Table of Content (TOC)"-macro on every page and include all TOCs via Excerpt Include.

Try the following

  1. On your new page - for example Pricing - place the "Excerpt"-macro.
  2. Place the TOC-macro inside the "Excerpt"-macro.
  3. On your main page - Product XYZ - place the "Excerpt Include"-macro.
  4. Enter the page name - in this example you want to display the excerpt from the page "Pricing"

Repeat this with the other pages and you should have a fully linked TOC of all pages with all headings.

Kinds regards,

Svenja

Hello Svenja:
Thanks for your help and reply.
I tried to follow the instructions and it seems that it creates multiple separate TOCs as shown below. Is there no way to create one single TOC -- comprised of all parent and child pages? Thanks.

SNIP capture.JPG

Hi, how did you manage to put a TOC macro inside an excerpt? When I try on my side, it doesn't work, the TOC is empty.

Same - my TOC is empty inside the excerpt macro. Please advise @Svenja 

this worked perfectly for me.  Created a excerpt on the child pages, dropped in the TOC macro.  Went to the parent page and created 3 excerpt include macros (I've got 3 child pages) and removed the surrounding panel.  It pretty much looks like a single TOC at the top of the parent page now with TOC within each child page for that specific page

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Confluence

Confluence: Where work and wellness meet

Feeling overwhelmed by the demands of work and life? With a 25% increase in the prevalence of anxiety and depression worldwide during the pandemic, for most of us, it’s a resounding yes . 🙋‍♀️ ...

751 views 5 21
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you