Download & Extend

Advanced help dialog

This module requires the developer implement a hook to get any result (see below).

Advanced Help Dialog module provides a hook that lets you put links to advanced help topics in the "Help" region of specific paths. When users click these links, a ctools-style modal dialog box appears with the appropriate advanced help content. Here is an example of how to implement the hook:

<?php
/*
* Implements hook_advanced_help_dialog_help().
*/
function modulename_advanced_help_dialog_help() {
 
$help = array(
   
'admin/config/path' => array(
     
'topic' => array( // This is the name of a topic in module modulename
       
'title' => t('Topic title'),
       
'link_text' => t('Link title'),
       
'show_navigation' => FALSE // Or TRUE if you want navigation ..
     
)
    )
  );
 
  return
$help;
}
?>

The snippet above will place a link with the title "Link title" in the help region that opens a modal box displaying the advanced help content with name "topic" in module "modulename".

Also, this module exposes a new "modal_help_dialog" render element that you can use to do the same thing in any render array, like this:

<?php
$form
['help'] = array(
 
'#type' => 'modal_help_dialog',
 
'#module' => 'mymodule',
 
'#topic' => 'mytopic',
 
'#link_text' => t('Link text')
);
?>

Downloads

Recommended releases

Version Downloads Date Links
7.x-1.1 tar.gz (9.53 KB) | zip (12.88 KB) 2013-Feb-25 Notes

Development releases

Version Downloads Date Links
7.x-1.x-dev tar.gz (9.54 KB) | zip (12.89 KB) 2013-Feb-26 Notes

Project Information


Maintainers for Advanced help dialog

  • dpolant - 6 commits
    last: 11 weeks ago, first: 19 weeks ago

Issues for Advanced help dialog

To avoid duplicates, please search before submitting a new issue.
All issues
Bug reports
nobody click here