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

   1 CONTENTS OF THIS FILE
   2 --------------------
   3
   4 * Introduction
   5 * Requirements
   6 * Recommended modules
   7 * Installation
   8 * Configuration
   9 * Maintainers
  10
  11
  12 INTRODUCTION
  13 ------------
  14
  15 The Advanced help module allows module developers to store their help outside the module system, in pure .html or .md (MarkDown) files.  It provides a framework that allows module and theme developers to integrate help texts in a Drupal site, as well as exposing help to site administrators through the administrative interface.
  16
  17 * For a full description of the module visit https://www.drupal.org/node/2461741
  18
  19 * To submit bug reports and feature suggestions, or to track changes visit https://www.drupal.org/project/issues/advanced_help
  20
  21
  22 REQUIREMENTS
  23 ------------
  24
  25 This module has no required dependencies outside of Drupal core.
  26
  27
  28 RECOMMENDED MODULES
  29 -------------------
  30
  31 * Advanced help hint - If Advanced help is not enabled, this module will generate a hint string that can be used in the project's hook_help to hint that Advanced help should be enabled. (https://www.drupal.org/project/advanced_help_hint)
  32
  33
  34 INSTALLATION
  35 ------------
  36
  37 * Install the Advanced help module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.
  38
  39
  40 CONFIGURATION
  41 --------------
  42
  43 By itself, this module doesn't do much. The Advanced help assists other modules and themes in showing help texts. Nothing will show up until you enable at least one other module that makes use of the advanced help framework or comes with a file named README.md or README.txt.
  44
  45
  46 MAINTAINERS
  47 -----------
  48
  49 * David Valdez - https://www.drupal.org/u/gnuget