function video_help in Video 5

Same name and namespace in other branches

1. 6 video.module \video_help()
2. 6.2 video.module \video_help()

Help hook

Parameters

$section: string of the area of Drupal where help was requested

Return value

string of help information

File

./video.module, line 34

Display video in Quicktime MOV, Realmedia RM, Flash FLV & SWF, or Windows Media WMV formats.

Code

function video_help($section = 'admin/help#video') {
  switch ($section) {
    case 'admin/help#video':
      $output = '<p>' . t('The video module (4.7 or with backport patch to 4.6) allows users to post video content to their site. The emergence of portable phones with video capture capabilities has made video capture ubiquitous. Video logging, or <a href="%elink-en-wikipedia-org">vlogging</a> as a medium for personal video broadcasting has proven to be popular and is following the blogging, and podcasting phenomena\'s. Videos are useful for creative collaboration among community members. If community members can not meet in person videos of meetings are valuable for enhancing the interaction between community members.', array(
        '%elink-en-wikipedia-org' => 'http://en.wikipedia.org/wiki/Vlog',
      )) . '</p>';
      $output .= '<p>' . t('The video module can be administered to flash player settings. There are a number of page and menu links which can be added to play and download video content on the site. Other configurable options include play and download counters. Multi-file downloads can also be configured under settings.') . '</p>';
      $output .= t('<p>You can:</p>
<ul>
<li>Enable <em>most played videos</em>, <em>latest videos</em>, and <em>top videos</em> blocks at <a href="%admin-block">administer &gt;&gt; block</a>.</li>
<li>Create video posts at <a href="%node-add-video">create content &gt;&gt; video</a>.</li>
<li>Administer video module settings at <a href="%admin-settings-video">administer &gt;&gt; settings &gt;&gt; video</a>.</li>
</ul>
', array(
        '%admin-block' => url('admin/settings/block'),
        '%node-add-video' => url('node/add/video'),
        '%admin-settings-video' => url('admin/content/video'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%video">Video page</a>.', array(
        '%video' => 'http://www.drupal.org/handbook/modules/video/',
      )) . '</p>';
      return $output;
    case 'admin/settings/modules#description':
      return t('Allows video nodes.');
    case 'node/add#video':
      return t('Allows you to insert videos as nodes.');
    case 'video/help':

      // Get the video-type-specific help contents
      $help_items = array();
      return theme('item_list', module_invoke_all('v_help'));
  }
}