From c5513e5285bde513f7caeeca427c45c848e0e859 Mon Sep 17 00:00:00 2001 From: AmyJune Date: Tue, 1 Aug 2017 12:27:55 -0700 Subject: [PATCH] Made edits to existing README to align closer to d.o documentation standards --- README.txt | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.txt b/README.txt index b8b33a6..4bb0fc5 100644 --- a/README.txt +++ b/README.txt @@ -12,11 +12,16 @@ CONTENTS OF THIS FILE 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. +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 +* To submit bug reports and feature suggestions, or to track changes visit + https://www.drupal.org/project/issues/advanced_help REQUIREMENTS @@ -28,19 +33,27 @@ This module has no required dependencies outside of Drupal core. RECOMMENDED MODULES ------------------- -* 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) +* 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. See https://drupal.org/documentation/install/modules-themes/modules-7 for further information. +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. 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. +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. MAINTAINERS -- 2.10.0