function footnotes_help in Footnotes 5

Same name and namespace in other branches

1. 8.2 footnotes.module \footnotes_help()
2. 5.2 footnotes.module \footnotes_help()
3. 6.2 footnotes.module \footnotes_help()
4. 6 footnotes.module \footnotes_help()
5. 7.3 footnotes.module \footnotes_help()
6. 7.2 footnotes.module \footnotes_help()

Implementation of hook_help().

Throughout Drupal, hook_help() is used to display help text at the top of pages. Some other parts of drupal pages get explanatory text from these hooks as well. We use it here to provide a description of the module on the module administration page.

File

./footnotes.module, line 22

The Footnotes module is a filter that can be used to insert automatically numbered footnotes into Drupal texts.

Code

function footnotes_help($section) {
  switch ($section) {
    case 'admin/modules#description':

      // This description is shown in the listing at admin/modules.
      return t('A filter to insert automatically numbered footnotes into Drupal texts.');
  }
}