table of contents
Table of Contents tags and parameters
Syntax
Supported Tags
The module supports 3 tags that all generate a Table of Contents.
The most popular is now [toc] since it is easy to type and works in WYSIWYG editors.
Only add identifiers and optionally numbers to my headers
Proposition
The Table of Contents module uses the headers to get generated. Each header gets a unique identifier when none were assigned manually. The Table of Contents module uses the text between the start and end tags as the title to show in the table of contents.
Very good!
Now, you may not want the Table of Contents itself, but you like the idea to have identifiers in all your headers. This can be useful to create in-page links (a link with an anchor, i.e. #some-name at the end of your URL.) It is generally annoying to have to enter the identifiers by hand for each header and you may
Upgrade from Table of Contents 2.x to 3.x
Make a Backup
DO NOT FORGET TO MAKE A BACKUP OF YOUR DATABASE & CODE.
That way you can come back to your previous version if anything goes wrong. So far, no one told me that they had a problem upgrading. Although version 2.x did not have any schema, the new module may modify nodes and generate incompatible tags.
Show stopper
Version 3.x has a new theme() scheme. It is much more powerful has it allows you to create your own header numbering, etc. However, if you already had a theme() overload in your theme, it will stop working until fixed.
Please, in this case, make sure to upgrade on
Table of Contents Settings
Filter Configuration
At this point, most of the Table of Contents configuration is done in the Table of Contents filter.
This means multiple Input formats allow you to make use of several different configurations.
Table of Contents Known Issues
Various known issues with the Table of Contents module.
Teaser appear, FCKeditor accentuated letters, Back to top arrow, Filters interaction (JavaScript removal,) headers numbering, double numbering...
Table of Contents Overview
The Table of contents module is used to generate a table with a list of all the content of your pages.
The module searches for the header tags (H1 to H6) and transforms those into a list of items used in the table of contents. Note that this module does not have the capability to generate a table of contents for multiple pages. However, used with the Views module, it is possible to create pages referencing multiple sub-pages.
The features include a way to number the items either with the automatic HTML ordered list feature (OL) or with an internal system that counts the headers and generates numbers as expected for sub-lists (i.e. 1., 1.1, 1.1.1, 1.1.2, 1.2, 2., etc.)
The table of contents can also reference all the attachments present on your page.
This documentation proposes to teach you how to install and make the most out of the filter.
Adding a Table of Contents to a view with parameters
It is possible to add a Table of Contents to a view that has to accept parameters1.
In this case, you do not want to use the solution of including the view in a node (with the Insert view filter, see Can't find doc_table_of_contents_for_views to include!) because then you lose the capability of assigning different parameters to your view (although, if the number of parameters is ...
- 1. Note that you need to write some PHP code. If you do not know how to do that, I'm afraid that this won't work for you. You may want to check out the Table of Contents and Insert view solution instead.
Create a Table of Contents from a View
Setup
There are, I'm sure, many different ways to handle views with the Table of contents.
Here is what I think is the easiest at the moment:
1. Create a view and include a Title field (which generates a header for the title, most likely <H2>)
2. Create a node and include the view in the node using the Insert view filter1
3. Select a filter on this node that includes support for Insert views and Table of contents
4. If
- 1. Note that the Insert view filter was found to have some security issues. Use with care. The project home page has additional information about this module.
Table of Contents (The module —)
The Table of contents module is used to generate a table with a list of all the content of your pages.
The module searches for the header tags (H1 to H6) and transforms those into a list of items used in the table of contents. Note that this module does not have the capability to generate a table of contents for multiple pages. However, used with the Views module, it is possible to create pages referencing multiple sub-pages.
The features include a way to number the items either with the automatic HTML ordered list feature (OL) or with an internal system that counts the headers and generates
