You are here

function audiofield_help in AudioField 8

Implements hook_help().

File

./audiofield.module, line 112
Drupal Module: Audiofield.

Code

function audiofield_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.audiofield':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('AudioField is a file formatter for the File and Link modules. It allows you to upload or link audio files and play them on your site using one of several audio players available. It supports most audio formats (depends on the selected audio player). Please see <a href=":url">the module documentation</a> for examples of the players in use.', [
        ':url' => 'https://www.drupal.org/docs/8/modules/audiofield',
      ]) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<p>' . t('Audiofield supports the following audio players, which must be downloaded and installed as libraries:') . '</p>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Default HTML5 audio player') . '</dt>';
      $output .= '<dd>' . t('Built into major browsers.') . '</dd>';
      $output .= '<dt>' . t('Audio.js') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'https://kolber.github.io/audiojs/',
      ]) . '</dd>';
      $output .= '<dt>' . t('jPlayer') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'http://jplayer.org/',
      ]) . '</dd>';
      $output .= '<dt>' . t('MediaElement') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'http://mediaelementjs.com/',
      ]) . '</dd>';
      $output .= '<dt>' . t('Projekktor') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'https://github.com/frankyghost/projekktor',
      ]) . '</dd>';
      $output .= '<dt>' . t('SoundManager') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'http://www.schillmania.com/projects/soundmanager2',
      ]) . '</dd>';
      $output .= '<dt>' . t('wavesurfer.js') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'https://wavesurfer-js.org',
      ]) . '</dd>';
      $output .= '<dt>' . t('WordPress Audio') . '</dt>';
      $output .= '<dd>' . t('<a href=":url">:url</a>', [
        ':url' => 'http://wpaudioplayer.com',
      ]) . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}