function viewport_help in Viewport 7

Same name and namespace in other branches

1. 8 viewport.module \viewport_help()

Implements hook_help().

File

./viewport.module, line 12

viewport module Allows to set a viewport metatag with custom settings for a selected set of pages.

Code

function viewport_help($path, $arg) {
  $help_text = '';
  switch ($path) {
    case 'admin/help#viewport':
      $help_text = t('<p>The Viewport module is a simple module that allows
        administrators, or users with the "Administer Viewport Settings" permission,
        to set a Viewport HTML metatag with the desired properties for one or several
        pages that can be configured from the Settings page of the module.</p>
        <p>
        The aim of the module is to provide an easy way to debug or test websites or
        apps, as well as responsive designs on smartphones and tablets. This is *NOT* a
        complete suite of tools to work with when delivering this kind of design / apps,
        but a small utility to help with one specific aspect of responsive design.</p>
        <p>
        Sometimes, one may need to set specific viewport values for a specific page on
        the site (e.g when embedding a game for smartphones / tablets). This tool
        helps to chase easily situations like that.</p>
        <p><strong>For more information on the viewport metatag and its
        properties, check the following resources: </strong></p>');
      $resource_links = array(
        'items' => array(
          l(t('Safari developer docs'), 'https://developer.apple.com/library/safari/#documentation/appleapplications/reference/SafariHTMLRef/Articles/MetaTags.html#//apple_ref/doc/uid/TP40008193-SW7', array(
            'attributes' => array(
              'target' => '_blank',
            ),
          )),
          l(t('Non-browser-specific information on viewport metatag'), 'http://www.html-5.com/metatags/index.html#viewport-meta-tag', array(
            'attributes' => array(
              'target' => '_blank',
            ),
          )),
          l(t('Detailed browser comparison of the viewport properties'), 'http://www.quirksmode.org/mobile/tableViewport.html', array(
            'attributes' => array(
              'target' => '_blank',
            ),
          )),
        ),
      );
      $help_text .= theme('item_list', $resource_links);
      break;
  }
  return $help_text;
}