function tableofcontents_filter_tips in Table of Contents 5

Same name and namespace in other branches

1. 5.2 tableofcontents.module \tableofcontents_filter_tips()
2. 6.3 tableofcontents.module \tableofcontents_filter_tips()
3. 6.2 tableofcontents.module \tableofcontents_filter_tips()

Implementation of hook_filter_tips().

File

./tableofcontents.module, line 27

This is a module to generate a table of contents section based on <h[2-3]> tags. It currently depends on the headinganchors.module for hotlinking to work properly. I need to learn how to properly create a module dependancy or redesign to put…

Code

function tableofcontents_filter_tips($format, $long = FALSE) {
  if ($long) {
    return t('Every instance of "<!--tableofcontents-->" in the input text will be replaced with a table of contents.');
  }
  else {
    return t('Insert <!--tableofcontents--> to insert a dynamic TOC.');
  }
}