CM Table of Contents (CMTOC) - Free Version Guide
Free Version Guide
Table of Contents
- About This Plugin
- Differences Between Free and Pro
- How to Utilize The Plugin
- Quick Start
- Choosing Where The Table of Contents Appears
- Configuring the Table of Contents
- Styling the Table of Contents
- Changing the Header Label
- Performance & Debug
About This Plugin
Table of Contents link to the different sections in the content, making it easier for readers to skip right to what they need on your page.
The main function of the Table of Contents Plugin is to comb through pages and posts, particularly long ones, and to automatically generate Tables of contents based on their header contents.
The plugin gets its hierarchy from the type of header: h1 < h2 < h3 etc. If you are unsure about concepts such as header and tags, we suggest getting familiar with HTML.
Differences Between Free and Pro
How to Utilize This Plugin
- Start by going to the edit page or edit post view of where you would like the Table of Contents to go.
- Scroll down past the Text Editor to the CM Table of Contents (Free version) section, shown below. Check the box Search for Table Of Contents items on this post/page.
Add the shortcode
[cmtoc_table_of_contents]to the content. In the Front-End, it will be substituted by the Table of Contents.
Choosing Where The Table of Content Appears
You can restrict the Table of Contents to single posts/pages (not Homepage, authors, category etc.).
To do so, head to CM Table of Contents → Settings → General Settings → Display Settings. Then, check the box.
Configuring The Table of Contents
You can configure the Table of Contents behavior by choosing which content elements will go to which level. To do so, head to CM Table of Contents → Settings → Table of Contents → Table of Contents - Element Selector.
By default, the Table of Contents will consider the h1 tag to level 0, h2 tag to Level 1 and so forth. Here you can choose different tags, classes and Ids to construct Table of Contents more relevant to your content.
To learn more, check:
Changing The "Table of Contents" Label
As with all of our plugins, the Table of Contents allows you to customize the front-end labels to suit a site that is in a foreign language or that uses a more or less casual style of english for example. At the time of writing the only Front-End label generated by the Plugin is the Header label which displays above the table of contents.
To change this header label, on the WordPress dashboard navigate to CM Table of Contents → Table of Contents. Here scroll down to the section 'Table of Contents - Labels'.
Change the contents of the text field labeled Header to whatever you would like to display.
Perfomance & Debug
From the WordPress dashboard navigate to CM Table of Contents → Settings → General Settings → Performance & Debug.
Here you can choose to highlight only on "main" WordPress query. This is an advanced option. Unchecking this box may fix problems with highlighting table-of-contents on some themes which manipulate the WP_Query.