www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/toc_formatter/README.txt

   1 ********************************************************************
   2                      D R U P A L    M O D U L E
   3 ********************************************************************
   4 Name: TOC Formatter Module
   5 Author: Robert Castelo <www.codepositive.com>
   6 Drupal: 6.x
   7 ********************************************************************
   8 DESCRIPTION:
   9
  10 Display formatter that adds a table of contents set of links to the
  11 top of a text area field, and back to top links at the end of each
  12 section of text.
  13
  14
  15
  16 REQUIREMENTS
  17 ********************************************************************
  18
  19 This module use PHP DOMDocument functions and requires the libxml
  20 PHP extension. More info here:
  21
  22 http://www.php.net/manual/en/dom.requirements.php
  23
  24
  25
  26 ********************************************************************
  27 INSTALLATION:
  28
  29 Note: It is assumed that you have Drupal up and running.  Be sure to
  30 check the Drupal web site if you need assistance.
  31
  32 1. Place the entire directory into your Drupal directory:
  33    sites/all/modules/
  34
  35
  36 2. Enable the module by navigating to:
  37
  38    administer > build > modules
  39
  40   Click the 'Save configuration' button at the bottom to commit your
  41   changes.
  42
  43
  44
  45 ********************************************************************
  46 USAGE
  47
  48 Can be used on any text area field.
  49
  50 On the 'Display fields' settings of a content type set the display
  51 formatter of the field to 'Table Of Contents'.
  52
  53 Can also be set on the field settings of a View.
  54
  55
  56 ********************************************************************
  57 AUTHOR CONTACT
  58
  59
  60 - Comission New Features:
  61    http://drupal.org/user/3555/contact
  62
  63 - Want To Say Thank You:
  64    http://www.amazon.com/gp/registry/O6JKRQEQ774F
  65
  66
  67 ********************************************************************
  68 ACKNOWLEDGEMENT
  69
  70