You are here

Home » API reference » Block Class Styles 7 » block_class_styles.module

function block_class_styles_help in Block Class Styles 7

Same name and namespace in other branches
  1. 7.2 block_class_styles.module \block_class_styles_help()

Implements hook_help().

http://api.drupal.org/api/function/hook_help

Parameters

string $path: The router menu path, as defined in hook_menu(), for the help that is being requested; e.g., 'admin/node' or 'user/edit'. If the router path includes a % wildcard, then this will appear in $path; for example, node pages would have $path equal to 'node/%' or 'node/%/view'. Your hook implementation may also be called with special descriptors after a "#" sign.

array $arg: An array that corresponds to the return value of the arg() function, for modules that want to provide help that is specific to certain values of wildcards in $path. For example, you could provide help for the path 'user/1' by looking for the path 'user/%' and $arg[1] == '1'. This array should always be used rather than directly invoking arg(), because your hook implementation may be called for other purposes besides building the current page's help. Note that depending on which module is invoking hook_help, $arg may contain only empty strings. Regardless, $arg[0] to $arg[11] will always be set.

Related topics

Block Class Presets
@file Base module file for block_class_styles

File

./block_class_styles.module, line 89
Base module file for block_class_styles

Code

function block_class_styles_help($path, $arg) {
  switch ($path) {
    case BLOCK_CLASS_STYLES_PATH_SETTINGS:
      $output = '';
      $output .= <<<EOD
<p>When you edit the css for a style definition, all blocks with that style will receive the new css; they are automatically updated.</p>
<p>You may change the style name, as long as you don't edit the css.</p>
<p>To change both you need to do the css first, save the form, then do the stylename, and save the form.</p>
<p>Each style generates a <a href="http://drupal.org/node/1089656" onclick="window.open(this.href); return false;">theme hook suggestion</a>, so you can override <code>block.tpl.php</code> for each style with the appropriate tpl file.  See the Delete a Style list for the template filenames that correspond to each style. </p>
EOD;
      return $output;
  }
}