You are here

Home » API reference » TOC filter 6

README.txt in TOC filter 6

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Similar Modules

INTRODUCTION
------------

Converts header tags into a linked table of contents.

This module is designed to be lightweight and accomplishes the very specific task
of converting <h3> tags into an SEO friendly table of contents (TOC).

If you need a more complete hierarchical table on contents check out the
'Table of Contents' module. (http://drupal.org/project/tableofcontents)


INSTALLATION
------------

1. Copy/upload the toc_filter.module to the sites/all/modules directory
   of your Drupal installation.

2. Enable the 'TOC filter' module in 'Administer > Site building > Module'.
   (admin/build/modules)

3. Visit the 'Administer > Site configuration > Input formats'
   (admin/settings/filters). Click "configure" next to the input format you want
   to enable the Table of contents filter on.

4. Enable (check) the 'Table of contents' under the list of filters and save
   the configuration. Make sure that the input filter support H2/H3 tags and
   the 'Table of Contents' is applied after the HTML filter.

5. (optional) Visit the 'Administer > Site configuration > TOC filter'
   (admin/settings/toc_filter). Select desired header tab for conversion to
   table of contents. The recommended default value is <h3>.


SIMILAR MODULES
---------------

- Table of Contents: Adds a filter that generates Tables of contents for pages
  with  '[toc ...]' tags or that have a predetermined number of headers.
  http://drupal.org/project/tableofcontents
  [A more powerful (and complex) solution to building hierarchical TOCs]

- Table of Contents: Automatically create table of contents (jumplinks) for
  long pages in Drupal
  http://www.drupalcoder.com/blog/automatically-create-table-of-contents-jumplinks-for-long-pages-in-drupal


AUTHOR/MAINTAINER
-----------------

- Jacob Rockowitz
  http://drupal.org/user/371407

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5.  * Introduction

  6.  * Installation

  7.  * Similar Modules

  8. 

  9. INTRODUCTION

  10. ------------

  11. 

  12. Converts header tags into a linked table of contents.

  13. 

  14. This module is designed to be lightweight and accomplishes the very specific task

  15. of converting 
     tags into an SEO friendly table of contents (TOC).

  16. 

  17. If you need a more complete hierarchical table on contents check out the

  18. 'Table of Contents' module. (http://drupal.org/project/tableofcontents)

  19. 

  20. 

  21. INSTALLATION

  22. ------------

  23. 

  24. 1. Copy/upload the toc_filter.module to the sites/all/modules directory

  25.    of your Drupal installation.

  26. 

  27. 2. Enable the 'TOC filter' module in 'Administer > Site building > Module'.

  28.    (admin/build/modules)

  29. 

  30. 3. Visit the 'Administer > Site configuration > Input formats'

  31.    (admin/settings/filters). Click "configure" next to the input format you want

  32.    to enable the Table of contents filter on.

  33. 

  34. 4. Enable (check) the 'Table of contents' under the list of filters and save

  35.    the configuration. Make sure that the input filter support H2/H3 tags and

  36.    the 'Table of Contents' is applied after the HTML filter.

  37. 

  38. 5. (optional) Visit the 'Administer > Site configuration > TOC filter'

  39.    (admin/settings/toc_filter). Select desired header tab for conversion to

  40.    table of contents. The recommended default value is 
    .

  41. 

  42. 

  43. SIMILAR MODULES

  44. ---------------

  45. 

  46. - Table of Contents: Adds a filter that generates Tables of contents for pages

  47.   with  '[toc ...]' tags or that have a predetermined number of headers.

  48.   http://drupal.org/project/tableofcontents

  49.   [A more powerful (and complex) solution to building hierarchical TOCs]

  50. 

  51. - Table of Contents: Automatically create table of contents (jumplinks) for

  52.   long pages in Drupal

  53.   http://www.drupalcoder.com/blog/automatically-create-table-of-contents-jumplinks-for-long-pages-in-drupal

  54. 

  55. 

  56. AUTHOR/MAINTAINER

  57. -----------------

  58. 

  59. - Jacob Rockowitz

  60.   http://drupal.org/user/371407