You are here

Home » API reference » Advanced Help 8

README.txt in Advanced Help 8

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

* Introduction
* Requirements
* Recommended modules
* Installation
* Configuration
* Maintainers


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

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.

* For a full description of the module visit https://www.drupal.org/node/2461741

* To submit bug reports and feature suggestions, or to track changes visit
  https://www.drupal.org/project/issues/advanced_help


REQUIREMENTS
------------

This module has no required dependencies outside of Drupal core.


RECOMMENDED MODULES
-------------------

* Advanced Help Hint (https://www.drupal.org/project/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.


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

Install the Advanced Help module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/895232 for more information.


CONFIGURATION
--------------

By itself, this module doesn't do much. It 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.


MAINTAINERS
-----------

* David Valdez - https://www.drupal.org/u/gnuget

File

README.txt
View source 
  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

  16. the module system, in pure .html or .md (MarkDown) files.  It provides a

  17. framework that allows module and theme developers to integrate help texts in a

  18. Drupal site, as well as exposing help to site administrators through the

  19. administrative interface.

  20. 

  21. * For a full description of the module visit https://www.drupal.org/node/2461741

  22. 

  23. * To submit bug reports and feature suggestions, or to track changes visit

  24.   https://www.drupal.org/project/issues/advanced_help

  25. 

  26. 

  27. REQUIREMENTS

  28. ------------

  29. 

  30. This module has no required dependencies outside of Drupal core.

  31. 

  32. 

  33. RECOMMENDED MODULES

  34. -------------------

  35. 

  36. * Advanced Help Hint (https://www.drupal.org/project/advanced_help_hint):

  37.   If Advanced Help is not enabled, this module will generate a hint string that

  38.   can be used in the project's hook_help to hint that Advanced Help should be

  39.   enabled.

  40. 

  41. 

  42. INSTALLATION

  43. ------------

  44. 

  45. Install the Advanced Help module as you would normally install a contributed

  46. Drupal module. Visit https://www.drupal.org/node/895232 for more information.

  47. 

  48. 

  49. CONFIGURATION

  50. --------------

  51. 

  52. By itself, this module doesn't do much. It assists other modules and themes in

  53. showing help texts. Nothing will show up until you enable at least one other

  54. module that makes use of the Advanced Help framework or comes with a file named

  55. README.md or README.txt.

  56. 

  57. 

  58. MAINTAINERS

  59. -----------

  60. 

  61. * David Valdez - https://www.drupal.org/u/gnuget