The Table of Contents provides an overview of long articles by listing all the headings in your document in the order they appear.  Readers can easily navigate your document by clicking a link in the Table of Contents and be taken directly to that section in your article.

 

You can see this addon in action in the Telligent online documentation.

 

Features

  • Provides a list of all headings in an article
  • Clicking on a heading in the Table of Contents takes the reader directly to that section in the main article
  • Shows the hierarchy of sections in your article
  • Automatically generated - as your article changes, so too will the Table of Contents
  • Fully themeable - The look of the Table of Contents can be customised through custom CSS. 

Using the Addon

When authoring a long article insert the text "[toc]" (without the quotes) towards the top of your article.  This will be replaced by an automatically generated table of contents when users view your content.  This makes it easier for users to get an outline of a long article, and navigate through it.

To tell the addon how to generate the table of contents, you should use the rich text editor to format the headings in your article to use the "Heading 2", "Heading 3" etc. formats.

This addon may be used in wiki pages, blog posts, forum posts and media gallery files.

Example

The following is what the Table of Contents would look like if generated for the below sample entry.

In this Article

Section 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi adipiscing massa in ipsum hendrerit id vestibulum leo posuere. Suspendisse tempus diam nec tortor molestie commodo. Proin eu imperdiet lorem. Morbi urna ante, mollis quis gravida id, ultricies non metus. Cras erat massa, dignissim in adipiscing sit amet, egestas sed nulla. Quisque consequat, est eu sagittis feugiat, velit leo feugiat tortor, ac sagittis massa ligula vel nisi. Fusce sit amet turpis quis velit rutrum egestas id ornare est. In hac habitasse platea dictumst. 

Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Vivamus ultricies, enim eget malesuada dignissim, metus ante blandit neque, non consectetur turpis elit id est. Proin a ultricies urna. Vestibulum non cursus ipsum. Maecenas non posuere nisi. Phasellus nisl odio, luctus nec semper consectetur, rutrum ut sapien. Cras laoreet, orci vel rhoncus euismod, dolor lorem aliquet neque, pharetra ullamcorper neque augue ut arcu.

Sub Section 1.A

Nulla lectus est, rhoncus eget porta nec, consectetur consequat ligula. Fusce fermentum nibh consectetur erat sollicitudin malesuada elementum neque condimentum. Aliquam tincidunt, massa eget consectetur elementum, velit dolor ullamcorper nulla, eu hendrerit nisi est a tortor. Nullam leo sem, placerat a tincidunt nec, adipiscing in neque. Donec augue metus, semper in feugiat quis, mattis nec diam.

Sub Sub Section 1.A.i

Vestibulum non nunc sed lacus vehicula congue. Nunc accumsan pretium scelerisque. Quisque elit felis, pretium et fringilla eu, sagittis in purus. Duis feugiat consequat porta. Nunc sodales cursus tincidunt. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Praesent porta enim eu turpis bibendum eget tincidunt ligula varius.

Sub Sub Section 1.A.ii

Nullam sit amet leo eu est venenatis adipiscing. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse congue porttitor enim sed consequat. In nec malesuada risus. Curabitur dictum hendrerit lacus, eget lobortis est cursus tristique. Cras urna lorem, dapibus eu porttitor quis, consequat sed odio. In ut urna id ante ultrices iaculis.

Sub Section 1.B

Nullam sit amet leo eu est venenatis adipiscing. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse congue porttitor enim sed consequat. In nec malesuada risus. Curabitur dictum hendrerit lacus, eget lobortis est cursus tristique. Cras urna lorem, dapibus eu porttitor quis, consequat sed odio. In ut urna id ante ultrices iaculis.

Section 2

Pellentesque ut nisi id est malesuada euismod. Mauris eu lorem in enim viverra fermentum. Praesent augue arcu, consequat vel consectetur in, cursus sit amet eros. Etiam in blandit sapien. Donec vitae tellus condimentum turpis elementum molestie id sed sem. Sed erat turpis, adipiscing sed ullamcorper in, mollis quis tellus. Sed cursus convallis augue quis cursus. Integer ut mi est. Donec bibendum interdum venenatis. Phasellus hendrerit gravida arcu sed dapibus. Integer condimentum dapibus lectus, ac consectetur urna sollicitudin sit amet. Suspendisse ultricies rutrum consectetur. Vestibulum sodales pharetra enim sed mollis. Phasellus ut laoreet urna.

Section 3

Praesent tortor orci, semper nec mollis sed, ullamcorper sit amet diam. Donec mattis lobortis placerat. Duis turpis tortor, rutrum auctor varius porta, faucibus ut ipsum. Nam quis augue in tortor porttitor malesuada nec et quam. In volutpat egestas varius. *** sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla consequat, orci vel tincidunt interdum, augue diam iaculis metus, vel consequat lorem purus at purus. Sed porttitor, lorem et aliquam posuere, arcu urna pulvinar quam, tempor tincidunt massa metus ut libero. Mauris venenatis nunc id dui sollicitudin vulputate. Quisque a laoreet felis. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam accumsan rutrum nunc ac tristique. Fusce nec ultricies arcu. Quisque volutpat diam ac lacus cursus non mollis quam rhoncus. Quisque in nunc neque, nec pharetra massa. Cras scelerisque mattis elit at commodo.