Module Description
This is a small helper module that may be used by other modules to produce a string that may be inserted into a project's hook_help to hint about the documentation that exists. It has no adminitrative UI and will not do anything by itself.
If your project provides online help by means of Advanced Help you may want to use this project to hint about more online help being available if they enable the Advanced Help module.
In addition, the hint may link to to other online documentation (such as the project's documentation pages on Drupal.org). If Advanced Help is enabled, it inserts a link to its help topic index on standard help page (making it visible without going to the Advanced Help tab).
I created this module because I found that I've replicated the same pattern in hook_help in every Drupal module I maintain. Replicated patterns consumes memory, and are harder to maintain, so I prefer to rely on this project for this pattern.
The major features of Advanced Help Hint are:
* If Advanced Help is not enabled, and you've indicated that there are helps file in your repo, it will suggest that it is enabled.
* If Advanced Help is enabled, it will generate a link to whatever help it makes available. This may include the module's README.md or README.txt.
* If you tell it that online documentation for your module exists, it will generate a link to that as well.
Please note that the project's primary purpose is to provide a helper function that shall generate a short string to be embedded in hook_help that suggests that it may be a good idea to enable Advanced Help. This means that it does not make sense to merge this project with Advanced Help, or making Advanced Help a dependency.
Recommended modules
* Advanced Help: When this module is enabled, help files created with its framework will become available, or README.md or README.txt will be available in the sites's adminsitrative UI.
* Markdown (Drupal 7 only): When this module is enabled for Drupal 7, display of the project's README.md will be rendered with the markdown filter. (In Drupal 9/10 this happens by default.)
Roadmap The project is available for Drupal 7 and Drupal 9/10.
If your project provides online help by means of Advanced Help you may want to use this project to hint about more online help being available if they enable the Advanced Help module.
In addition, the hint may link to to other online documentation (such as the project's documentation pages on Drupal.org). If Advanced Help is enabled, it inserts a link to its help topic index on standard help page (making it visible without going to the Advanced Help tab).
I created this module because I found that I've replicated the same pattern in hook_help in every Drupal module I maintain. Replicated patterns consumes memory, and are harder to maintain, so I prefer to rely on this project for this pattern.
The major features of Advanced Help Hint are:
* If Advanced Help is not enabled, and you've indicated that there are helps file in your repo, it will suggest that it is enabled.
* If Advanced Help is enabled, it will generate a link to whatever help it makes available. This may include the module's README.md or README.txt.
* If you tell it that online documentation for your module exists, it will generate a link to that as well.
Please note that the project's primary purpose is to provide a helper function that shall generate a short string to be embedded in hook_help that suggests that it may be a good idea to enable Advanced Help. This means that it does not make sense to merge this project with Advanced Help, or making Advanced Help a dependency.
Recommended modules
* Advanced Help: When this module is enabled, help files created with its framework will become available, or README.md or README.txt will be available in the sites's adminsitrative UI.
* Markdown (Drupal 7 only): When this module is enabled for Drupal 7, display of the project's README.md will be rendered with the markdown filter. (In Drupal 9/10 this happens by default.)
Roadmap The project is available for Drupal 7 and Drupal 9/10.
Module Link
Project Usage
1755
Security Covered
Covered By Security Advisory
Version Available
Production
Module Summary
This module aims to provide a helper function that generates a short string to be embedded in hook_help, suggesting the enabling of Advanced Help and linking to available online documentation.
Data Name
advanced_help_hint
OPENAI CHATBOT
OPENAI CHATBOT
