Skip to content
Florian95 edited this page Sep 13, 2010 · 2 revisions

Welcome to the generated_toc wiki!

Some further documentation:

To exclude a heading from the TOC

Add a "no-TOC" class to it. For example:
<h2 class="no-TOC">This will not show up in the TOC</h2>
A good place to use this is in specifying a title for your table of contents. For example, you might like the following:
<div id="generated-toc">
<h2 class="no-TOC">Table of Contents</h2>
</div>

To set the TOC list type

For ordered or unordered list, give the div a class of "list_type_ul" or "list_type_ol". For example:
<div id="generated-toc" class="list_type_ul"></div>
Default is ordered list (&#x27;ol&#x27;).

To enable or disable "back to top" links in the body

Give the div a class of "back_to_top_on" or "back_to_top_off". For example:
<div id="generated-toc" class="back_to_top_off"></div>
The default is "on" – back to top links will be generated after each heading included in the TOC.

To specify multiple classes for the div, separate them with spaces.

For example:
<div id="generated-toc" class="generate_from_h3 generate_for_page list_type_ul"></div>

For conflicting class specifications

The last specified class takes precedence. For example, for the following specification:
<div id="generated-toc" class="generate_from_h3 generate_from_h2 list_type_ul list_type_ol"></div>
The resulting TOC will be generated from h2, and use ordered list type (&#x27;ol&#x27;).