Improving Documentation Part 1 – Inline Table of Contents

Telligent Evolution Platform

A description has not yet been added to this group.

Improving Documentation Part 1 – Inline Table of Contents

  • Comments 1

If you’ve been watching the documentation on http://telligent.com over the past 6 months or so, you’ll have noticed some big improvements to how easily you can read through our documentation.  There are lots of improvements we have made, but three of the big ones I’d like to highlight are

In this blog post, I’m going to concentrate solely on the Table of Contents, and in part 2, I’ll discuss the Custom Styles used, and how we’ve made it easier to use these styles in the text editor.

Inline Table of Contents

The Table of Contents addon is an extension we built for allowing easy navigation within a Wiki article (now available in the Telligent Marketplace). The Table of Contents is the Grey “In this Article” box on the pages.  For example, if you look at the Installation document for Telligent Evolution, you’ll see the table of contents looking like:

image

The Table of Contents serves two main purposes

  1. Provides an outline of the article
  2. Allows readers to easily navigate the article by clicking on the link to the section they want to read.

It incredibly simple to use.  Make sure you use H2,H3 and H4 tags when Simply add the text [toc] into the article where you want the Table of Contents to be, and then add the text [toc] into an article where you want the Table of Contents to be displayed to the reader.  The addon can be used in wiki pages, blog posts, media uploads and even forum posts.

 

What are you waiting for, go get the Table of Contents from the Telligent Marketplace.

Your comment has been posted.   Close
Thank you, your comment requires moderation so it may take a while to appear.   Close
Leave a Comment
  • Post
  • Just want to say it works great and it is a big improvement for the telligent wiki!

    --

    Aloha

    Uwe

Page 1 of 1 (1 items)