You are here

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

function block_class_styles_help in Block Class Styles 7.2

Same name and namespace in other branches
  1. 7 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 97
Base module file for block_class_styles

Code

function block_class_styles_help($path, $arg) {
  $output = '';
  if ($path === BLOCK_CLASS_STYLES_PATH_SETTINGS) {
    $output .= <<<EOD
<p>Use this page to edit the block styles.</p>
<p>When you edit the css for a style definition and save this form, all blocks with that style will receive the new css. <strong>When editing <em>Style definitions</em> you may change the style name <em>OR</em> the css for the style, per form submission.  To change both css and style name of a single Style definition, you need to do the css first, save the form, then do the style name and save the form.</strong></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 <em>Template suggestions list</em> for the template filenames that correspond to each style. This list will only appear after you have created one or more styles and saved this form.</p>
<p>Other things to note:</p>
<ul>
  <li>The list of style definitions is defined by all the block classes/styles that have been previously assigned to blocks as well as any definitions made here that have not yet been assigned.</li>
  <li>The only way to make all <em>Style definitions</em> disappear (from the box below) is to remove all classes/styles from each and every block.</li>
  <li>However, you may hide a style from appearing in the styles list on block edit forms by unchecking it from the select list options below.</li>
  <li><strong>Unchecking a style from the select list options does not affect a block with that style assigned to it.</strong>  To affect the block you need to edit the block itself and unassign the style.</li>
  <li>An unchecked style will still appear on a block's edit form if it has been selected for that block. The style name will be appended with "***" to designate it's been hidden.</li>
</ul>
EOD;
  }
  return $output;
}